OpenSim::MarkerPlacer Class Reference

A class implementing a set of parameters describing how to place markers on a model (presumably after it has been scaled to fit a subject). More...

#include <MarkerPlacer.h>

Inheritance diagram for OpenSim::MarkerPlacer:
OpenSim::Object

List of all members.

Public Member Functions

 MarkerPlacer ()
 Default constructor.
 MarkerPlacer (const MarkerPlacer &aMarkerPlacementParams)
 Copy constructor.
virtual ~MarkerPlacer ()
 Destructor.
virtual Objectcopy () const
 Copy this marker placement params and return a pointer to the copy.
void copyData (const MarkerPlacer &aMarkerPlacementParams)
 Copy data members from one MarkerPlacer to another.
MarkerPlaceroperator= (const MarkerPlacer &aMarkerPlacementParams)
 Assignment operator.
bool processModel (SimTK::State &s, Model *aModel, const std::string &aPathToSubject="")
bool getApply () const
void setApply (bool aApply)
const std::string & getStaticPoseFileName () const
void setStaticPoseFileName (const std::string &aFileName)
const Array< double > & getTimeRange () const
void setTimeRange (const Array< double > &timeRange)
IKTaskSetgetIKTaskSet ()
const std::string & getCoordinateFileName () const
void setCoordinateFileName (const std::string &aCoordinateFileName)
double getMaxMarkerMovement () const
void setMaxMarkerMovement (double aMaxMarkerMovement)
const std::string & getOutputModelFileName () const
void setOutputModelFileName (const std::string &aOutputModelFileName)
const std::string & getOutputMarkerFileName () const
void setOutputMarkerFileName (const std::string &outputMarkerFileName)
const std::string & getOutputMotionFileName () const
void setOutputMotionFileName (const std::string &outputMotionFileName)
void setPrintResultFiles (bool aToWrite)
bool getMoveModelMarkers ()
void setMoveModelMarkers (bool aMove)
StoragegetOutputStorage ()

Protected Attributes

PropertyBool _applyProp
bool & _apply
PropertyStr _markerFileNameProp
std::string & _markerFileName
PropertyDblArray _timeRangeProp
Array< double > & _timeRange
PropertyObj _ikTaskSetProp
IKTaskSet_ikTaskSet
PropertyStr _coordinateFileNameProp
std::string & _coordinateFileName
PropertyStr _outputModelFileNameProp
std::string & _outputModelFileName
PropertyStr _outputMarkerFileNameProp
std::string & _outputMarkerFileName
PropertyStr _outputMotionFileNameProp
std::string & _outputMotionFileName
PropertyDbl _maxMarkerMovementProp
double & _maxMarkerMovement
bool _printResultFiles
bool _moveModelMarkers
Storage_outputStorage

Detailed Description

A class implementing a set of parameters describing how to place markers on a model (presumably after it has been scaled to fit a subject).

Author:
Peter Loan
Version:
1.0

Constructor & Destructor Documentation

MarkerPlacer::MarkerPlacer (  ) 

Default constructor.

MarkerPlacer::MarkerPlacer ( const MarkerPlacer aMarkerPlacer  ) 

Copy constructor.

Parameters:
aMarkerPlacer MarkerPlacer to be copied.
MarkerPlacer::~MarkerPlacer (  )  [virtual]

Destructor.


Member Function Documentation

Object * MarkerPlacer::copy (  )  const [virtual]

Copy this marker placement params and return a pointer to the copy.

The copy constructor for this class is used.

Returns:
Pointer to a copy of this MarkerPlacer.

Reimplemented from OpenSim::Object.

void MarkerPlacer::copyData ( const MarkerPlacer aMarkerPlacer  ) 

Copy data members from one MarkerPlacer to another.

Parameters:
aMarkerPlacer MarkerPlacer to be copied.
bool OpenSim::MarkerPlacer::getApply (  )  const [inline]
const std::string& OpenSim::MarkerPlacer::getCoordinateFileName (  )  const [inline]
IKTaskSet& OpenSim::MarkerPlacer::getIKTaskSet (  )  [inline]
double OpenSim::MarkerPlacer::getMaxMarkerMovement (  )  const [inline]
bool OpenSim::MarkerPlacer::getMoveModelMarkers (  )  [inline]
const std::string& OpenSim::MarkerPlacer::getOutputMarkerFileName (  )  const [inline]
const std::string& OpenSim::MarkerPlacer::getOutputModelFileName (  )  const [inline]
const std::string& OpenSim::MarkerPlacer::getOutputMotionFileName (  )  const [inline]
Storage * MarkerPlacer::getOutputStorage (  ) 
const std::string& OpenSim::MarkerPlacer::getStaticPoseFileName (  )  const [inline]
const Array<double>& OpenSim::MarkerPlacer::getTimeRange (  )  const [inline]
MarkerPlacer & MarkerPlacer::operator= ( const MarkerPlacer aMarkerPlacer  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Object.

bool OpenSim::MarkerPlacer::processModel ( SimTK::State &  s,
Model aModel,
const std::string &  aPathToSubject = "" 
)
void OpenSim::MarkerPlacer::setApply ( bool  aApply  )  [inline]
void OpenSim::MarkerPlacer::setCoordinateFileName ( const std::string &  aCoordinateFileName  )  [inline]
void OpenSim::MarkerPlacer::setMaxMarkerMovement ( double  aMaxMarkerMovement  )  [inline]
void OpenSim::MarkerPlacer::setMoveModelMarkers ( bool  aMove  )  [inline]
void OpenSim::MarkerPlacer::setOutputMarkerFileName ( const std::string &  outputMarkerFileName  )  [inline]
void OpenSim::MarkerPlacer::setOutputModelFileName ( const std::string &  aOutputModelFileName  )  [inline]
void OpenSim::MarkerPlacer::setOutputMotionFileName ( const std::string &  outputMotionFileName  )  [inline]
void OpenSim::MarkerPlacer::setPrintResultFiles ( bool  aToWrite  )  [inline]
void OpenSim::MarkerPlacer::setStaticPoseFileName ( const std::string &  aFileName  )  [inline]
void OpenSim::MarkerPlacer::setTimeRange ( const Array< double > &  timeRange  )  [inline]

Member Data Documentation

bool& OpenSim::MarkerPlacer::_apply [protected]
std::string& OpenSim::MarkerPlacer::_markerFileName [protected]

The documentation for this class was generated from the following files:

Generated on Sun Sep 25 00:20:07 2011 for OpenSim by  doxygen 1.6.1