OpenSim::ScaleTool Class Reference

A class implementing a set of parameters describing how to scale a model to fit a subject, place markers on it, and do IK on one or more motion trials. More...

#include <ScaleTool.h>

Inheritance diagram for OpenSim::ScaleTool:
OpenSim::Object

List of all members.

Public Member Functions

 ScaleTool ()
 Default constructor.
 ScaleTool (const std::string &aFileName) SWIG_DECLARE_EXCEPTION
 ScaleTool (const ScaleTool &aSubject)
 Copy constructor.
virtual ~ScaleTool ()
 Destructor.
virtual Objectcopy () const
 Copy this subject and return a pointer to the copy.
ScaleTooloperator= (const ScaleTool &aSubject)
 Assignment operator.
void copyData (const ScaleTool &aSubject)
 Copy data members from one ScaleTool to another.
ModelcreateModel ()
 Create a generic model, using GenericModelMaker::processModel().
GenericModelMakergetGenericModelMaker ()
ModelScalergetModelScaler ()
MarkerPlacergetMarkerPlacer ()
bool isDefaultGenericModelMaker ()
bool isDefaultModelScaler ()
bool isDefaultMarkerPlacer ()
double getSubjectMass ()
 Accessor methods to obtain model attributes.
double getSubjectAge ()
double getSubjectHeight ()
void setSubjectMass (double mass)
void setSubjectAge (double age)
void setSubjectHeight (double height)
const std::string & getPathToSubject ()
 Accessor methods to set and get path to Subject.
void setPathToSubject (const std::string &aPath)
void setPrintResultFiles (bool aToWrite)

Static Public Member Functions

static void registerTypes ()
 Register the types used by this class.

Protected Attributes

PropertyDbl _massProp
double & _mass
PropertyDbl _heightProp
double & _height
PropertyDbl _ageProp
double & _age
PropertyStr _notesProp
std::string & _notes
PropertyObj _genericModelMakerProp
GenericModelMaker_genericModelMaker
PropertyObj _modelScalerProp
ModelScaler_modelScaler
PropertyObj _markerPlacerProp
MarkerPlacer_markerPlacer
std::string _pathToSubject
 All files in workflow are specified relative to where the subject file is.

Detailed Description

A class implementing a set of parameters describing how to scale a model to fit a subject, place markers on it, and do IK on one or more motion trials.

Author:
Peter Loan
Version:
1.0

Constructor & Destructor Documentation

ScaleTool::ScaleTool (  ) 

Default constructor.

OpenSim::ScaleTool::ScaleTool ( const std::string &  aFileName  ) 
ScaleTool::ScaleTool ( const ScaleTool aSubject  ) 

Copy constructor.

Parameters:
aSubject ScaleTool to be copied.
ScaleTool::~ScaleTool (  )  [virtual]

Destructor.


Member Function Documentation

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

Copy this subject and return a pointer to the copy.

The copy constructor for this class is used.

Returns:
Pointer to a copy of this ScaleTool.

Reimplemented from OpenSim::Object.

void ScaleTool::copyData ( const ScaleTool aSubject  ) 

Copy data members from one ScaleTool to another.

Parameters:
aSubject ScaleTool to be copied.
Model * ScaleTool::createModel (  ) 

Create a generic model, using GenericModelMaker::processModel().

Returns:
Pointer to the Model that is created.
GenericModelMaker& OpenSim::ScaleTool::getGenericModelMaker (  )  [inline]
MarkerPlacer& OpenSim::ScaleTool::getMarkerPlacer (  )  [inline]
ModelScaler& OpenSim::ScaleTool::getModelScaler (  )  [inline]
const std::string& OpenSim::ScaleTool::getPathToSubject (  )  [inline]

Accessor methods to set and get path to Subject.

This is needed since all file names referred to in the subject file are relative to subject file

double OpenSim::ScaleTool::getSubjectAge (  )  [inline]
double OpenSim::ScaleTool::getSubjectHeight (  )  [inline]
double OpenSim::ScaleTool::getSubjectMass (  )  [inline]

Accessor methods to obtain model attributes.

bool OpenSim::ScaleTool::isDefaultGenericModelMaker (  )  [inline]
bool OpenSim::ScaleTool::isDefaultMarkerPlacer (  )  [inline]
bool OpenSim::ScaleTool::isDefaultModelScaler (  )  [inline]
ScaleTool & ScaleTool::operator= ( const ScaleTool aSubject  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Object.

void ScaleTool::registerTypes (  )  [static]

Register the types used by this class.

void OpenSim::ScaleTool::setPathToSubject ( const std::string &  aPath  )  [inline]
void OpenSim::ScaleTool::setPrintResultFiles ( bool  aToWrite  )  [inline]
void OpenSim::ScaleTool::setSubjectAge ( double  age  )  [inline]
void OpenSim::ScaleTool::setSubjectHeight ( double  height  )  [inline]
void OpenSim::ScaleTool::setSubjectMass ( double  mass  )  [inline]

Member Data Documentation

double& OpenSim::ScaleTool::_age [protected]
double& OpenSim::ScaleTool::_height [protected]
double& OpenSim::ScaleTool::_mass [protected]
std::string& OpenSim::ScaleTool::_notes [protected]
std::string OpenSim::ScaleTool::_pathToSubject [protected]

All files in workflow are specified relative to where the subject file is.

Need to keep track of that in case absolute path is needed later


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

Generated on Wed Dec 16 15:03:51 2009 for OpenSim by  doxygen 1.6.1