Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

robot::sim::IKORTest::Test Class Reference

Inheritance diagram for robot::sim::IKORTest::Test:

Inheritance graph
[legend]
Collaboration diagram for robot::sim::IKORTest::Test:

Collaboration graph
[legend]
List of all members.

Public Types

enum  SolutionMethod { PseudoInverse, FullSpace }
enum  ExternalizationType { Input = 1, Output = 2, IO = 3 }

Public Member Functions

 Test (const String &name="")
virtual String className () const
void saveResult (ref< base::VFileSystem > filesystem, base::PathName alternateOutputFileName=base::PathName())
virtual bool formatSupported (const String format, Real version=1.0, ExternalizationType type=IO) const
 query if specific format is supported (for input, output or both)

virtual void externalize (base::Externalizer &e, String format="", Real version=1.0)
 read or write object state to Externalizer

virtual const String & getName () const
virtual void externalize (Externalizer &e, String format="", Real version=1.0) const
 write object state to Externalizer (throws if e is in Input)

void load (ref< VFile > archive, const String &format="", Real version=1.0)
void save (ref< VFile > archive, const String &format="", Real version=1.0)
virtual bool isSameKindAs (const Object &) const

Public Attributes

bool initialConfigSpecified
 if true, use q as the initial joint configuration, otherwise use the currrent configuration

base::Vector initq
 initial joint configuration

base::Trajectory traj
 trajectory/path for manipulator to follow

bool toolAttached
String toolName
Robot::CoordFrame frame
 reference frame of specified the trajectory

bool timeIntervalSpecified
 true if an overriding time interval was specified for the trajectory

Vector timeInterval
bool maxdxSpecified
 true if a maximum dx length was specified

Real maxdx
 maximum value of dx length for any trajectory step

bool orientationControl
bool jointWeightsSpecified
base::Vector jointWeights
 joint params weights

SolutionMethod solutionMethod
robot::control::kinematics::InverseKinematicsSolver::OptimizationMethod optMethod
robot::control::kinematics::InverseKinematicsSolver::OptimizationCriterion optCriteria
robot::control::kinematics::InverseKinematicsSolver::OptimizationConstraints optConstraints
bool resultsPresent
 are there test results recorded? (either via externalization input or generated by execution)

array< base::Vectorqs
 test output; sequence of 'joint' parameter vectors

array< base::Vectorxs
 test output; sequence of end-effector positions/orientations

array< base::Vectordxs
 test output; sequence of end-effector displacements

array< base::Vectordqs
 test output; sequence of 'joint' parameter displacements

array< base::Timetimes
 test output; sequence of times

array< base::MatrixJs
 test output; sequence of J(q) jacobian matrices

ManipulatorJointTrajectory jtraj
 test output trajectory in 'joint' space (dim is chain.dof() - so also includes any platform dofs)

bool testCompleted
 true if the test completed, fasle if an error occured and only partial results are available

String failureString
 if !testCompleted, provides the failure error message

base::PathName outputFileName
 output file specified in testspec file

base::PathName inputFilePath
 path from which testspec was loaded

bool displayRangeSpecified
 true if a subrange of the result joint trajectory has been specified for display purposes

Int displayStartIndex
Int displayEndIndex

Protected Member Functions

virtual void setName (const String &name)

Detailed Description

an individual test IKORTest comprises a sequence of these Tests. The environment is persistent accross the tests

Definition at line 70 of file IKORTest.


Member Enumeration Documentation

enum base::Externalizable::ExternalizationType [inherited]
 

Enumeration values:
Input 
Output 
IO 

Definition at line 40 of file Externalizable.

enum robot::sim::IKORTest::Test::SolutionMethod
 

Enumeration values:
PseudoInverse 
FullSpace 

Definition at line 98 of file IKORTest.


Constructor & Destructor Documentation

robot::sim::IKORTest::Test::Test const String &  name = ""  ) 
 


Member Function Documentation

virtual String robot::sim::IKORTest::Test::className  )  const [inline, virtual]
 

return the name of the object's class type. Must be defined by derived classes.

Implements base::Object.

Definition at line 75 of file IKORTest.

virtual void base::Externalizable::externalize Externalizer e,
String  format = "",
Real  version = 1.0
const [virtual, inherited]
 

write object state to Externalizer (throws if e is in Input)

Reimplemented in physics::Box, physics::Capsule, physics::Cone, physics::Cylinder, physics::LODTerrain, physics::Polyhedron, physics::Sphere, robot::KinematicChain::Link, robot::KinematicChain, robot::ManipulatorDescription, robot::PlatformDescription, robot::RobotDescription, robot::sim::SimulatedManipulatorDescription, robot::sim::SimulatedRobotDescription, robot::sim::SimulatedSerialManipulator, robot::sim::SimulatedTool, and robot::ToolDescription.

virtual void robot::sim::IKORTest::Test::externalize base::Externalizer e,
String  format = "",
Real  version = 1.0
[virtual]
 

read or write object state to Externalizer

Implements base::Externalizable.

virtual bool robot::sim::IKORTest::Test::formatSupported const String  format,
Real  version = 1.0,
ExternalizationType  type = IO
const [inline, virtual]
 

query if specific format is supported (for input, output or both)

Implements base::Externalizable.

Definition at line 135 of file IKORTest.

virtual const String& base::Named::getName  )  const [inline, virtual, inherited]
 

Definition at line 44 of file Named.

References base::String.

Referenced by physics::Collidable::findNamed(), physics::operator<<(), robot::ToolDescription::operator=(), robot::RobotDescription::operator=(), robot::PlatformDescription::operator=(), robot::ManipulatorDescription::operator=(), base::Named::operator=(), and robot::ManipulatorDescription::operator==().

virtual bool base::Object::isSameKindAs const Object  )  const [inline, virtual, inherited]
 

Definition at line 47 of file Object.

void base::Externalizable::load ref< VFile archive,
const String format = "",
Real  version = 1.0
[inherited]
 

void base::Externalizable::save ref< VFile archive,
const String format = "",
Real  version = 1.0
[inherited]
 

void robot::sim::IKORTest::Test::saveResult ref< base::VFileSystem filesystem,
base::PathName  alternateOutputFileName = base::PathName()
 

virtual void base::Named::setName const String name  )  [inline, protected, virtual, inherited]
 

Reimplemented in physics::Collidable, physics::Solid, and robot::sim::BasicEnvironment::Obstacle.

Definition at line 47 of file Named.

References base::String.

Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::AdaptorControlInterface(), robot::control::kinematics::BetaFormConstraints::BetaFormConstraint::BetaFormConstraint(), robot::control::kinematics::IKORController::EEPositionControlInterface::EEPositionControlInterface(), robot::control::kinematics::IKOR::JointLimitBetaConstraint::JointLimitBetaConstraint(), robot::control::kinematics::IKORController::LinkPositionsControlInterface::LinkPositionsControlInterface(), robot::ToolDescription::operator=(), robot::RobotDescription::operator=(), robot::PlatformDescription::operator=(), robot::ManipulatorDescription::operator=(), base::Named::operator=(), robot::control::ManipulatorPIDPositionController::PositionInterface::PositionInterface(), robot::RobotDescription::set(), robot::PlatformDescription::set(), robot::ManipulatorDescription::set(), and physics::Solid::setName().


Member Data Documentation

Int robot::sim::IKORTest::Test::displayEndIndex
 

Definition at line 127 of file IKORTest.

bool robot::sim::IKORTest::Test::displayRangeSpecified
 

true if a subrange of the result joint trajectory has been specified for display purposes

Definition at line 126 of file IKORTest.

Int robot::sim::IKORTest::Test::displayStartIndex
 

Definition at line 127 of file IKORTest.

array<base::Vector> robot::sim::IKORTest::Test::dqs
 

test output; sequence of 'joint' parameter displacements

Definition at line 111 of file IKORTest.

array<base::Vector> robot::sim::IKORTest::Test::dxs
 

test output; sequence of end-effector displacements

Definition at line 110 of file IKORTest.

String robot::sim::IKORTest::Test::failureString
 

if !testCompleted, provides the failure error message

Definition at line 118 of file IKORTest.

Robot::CoordFrame robot::sim::IKORTest::Test::frame
 

reference frame of specified the trajectory

Definition at line 85 of file IKORTest.

bool robot::sim::IKORTest::Test::initialConfigSpecified
 

if true, use q as the initial joint configuration, otherwise use the currrent configuration

Definition at line 78 of file IKORTest.

base::Vector robot::sim::IKORTest::Test::initq
 

initial joint configuration

Definition at line 79 of file IKORTest.

base::PathName robot::sim::IKORTest::Test::inputFilePath
 

path from which testspec was loaded

Definition at line 121 of file IKORTest.

base::Vector robot::sim::IKORTest::Test::jointWeights
 

joint params weights

Definition at line 95 of file IKORTest.

bool robot::sim::IKORTest::Test::jointWeightsSpecified
 

Definition at line 94 of file IKORTest.

array<base::Matrix> robot::sim::IKORTest::Test::Js
 

test output; sequence of J(q) jacobian matrices

Definition at line 113 of file IKORTest.

ManipulatorJointTrajectory robot::sim::IKORTest::Test::jtraj
 

test output trajectory in 'joint' space (dim is chain.dof() - so also includes any platform dofs)

Definition at line 115 of file IKORTest.

Real robot::sim::IKORTest::Test::maxdx
 

maximum value of dx length for any trajectory step

Definition at line 90 of file IKORTest.

bool robot::sim::IKORTest::Test::maxdxSpecified
 

true if a maximum dx length was specified

Definition at line 89 of file IKORTest.

robot::control::kinematics::InverseKinematicsSolver::OptimizationConstraints robot::sim::IKORTest::Test::optConstraints
 

Definition at line 103 of file IKORTest.

robot::control::kinematics::InverseKinematicsSolver::OptimizationCriterion robot::sim::IKORTest::Test::optCriteria
 

Definition at line 102 of file IKORTest.

robot::control::kinematics::InverseKinematicsSolver::OptimizationMethod robot::sim::IKORTest::Test::optMethod
 

Definition at line 101 of file IKORTest.

bool robot::sim::IKORTest::Test::orientationControl
 

Definition at line 92 of file IKORTest.

base::PathName robot::sim::IKORTest::Test::outputFileName
 

output file specified in testspec file

Definition at line 120 of file IKORTest.

array<base::Vector> robot::sim::IKORTest::Test::qs
 

test output; sequence of 'joint' parameter vectors

Definition at line 108 of file IKORTest.

bool robot::sim::IKORTest::Test::resultsPresent
 

are there test results recorded? (either via externalization input or generated by execution)

Definition at line 105 of file IKORTest.

SolutionMethod robot::sim::IKORTest::Test::solutionMethod
 

Definition at line 100 of file IKORTest.

bool robot::sim::IKORTest::Test::testCompleted
 

true if the test completed, fasle if an error occured and only partial results are available

Definition at line 117 of file IKORTest.

Vector robot::sim::IKORTest::Test::timeInterval
 

Definition at line 87 of file IKORTest.

bool robot::sim::IKORTest::Test::timeIntervalSpecified
 

true if an overriding time interval was specified for the trajectory

Definition at line 86 of file IKORTest.

array<base::Time> robot::sim::IKORTest::Test::times
 

test output; sequence of times

Definition at line 112 of file IKORTest.

bool robot::sim::IKORTest::Test::toolAttached
 

Definition at line 82 of file IKORTest.

String robot::sim::IKORTest::Test::toolName
 

Definition at line 83 of file IKORTest.

base::Trajectory robot::sim::IKORTest::Test::traj
 

trajectory/path for manipulator to follow

Definition at line 80 of file IKORTest.

array<base::Vector> robot::sim::IKORTest::Test::xs
 

test output; sequence of end-effector positions/orientations

Definition at line 109 of file IKORTest.


The documentation for this class was generated from the following file:
Generated on Thu Jul 29 16:42:58 2004 for OpenSim by doxygen 1.3.6