OpenSim::PathWrap Class Reference

A class implementing an instance of muscle wrapping. More...

#include <PathWrap.h>

Inheritance diagram for OpenSim::PathWrap:
OpenSim::Object

List of all members.

Public Types

enum  WrapMethod { hybrid, midpoint, axial }

Public Member Functions

 PathWrap ()
 Default constructor.
 PathWrap (const PathWrap &aPathWrap)
 Copy constructor.
virtual ~PathWrap ()
 Destructor.
virtual Objectcopy () const
 Copy this PathWrap and return a pointer to the copy.
PathWrapoperator= (const PathWrap &aPathWrap)
 Assignment operator.
virtual void setup (const Model &aModel, GeometryPath &aPath)
 Perform some set up functions that happen after the object has been deserialized or copied.
void setStartPoint (const SimTK::State &s, int aIndex)
void setEndPoint (const SimTK::State &s, int aIndex)
void copyData (const PathWrap &aPathWrap)
 Copy data members from one PathWrap to another.
int getStartPoint () const
int getEndPoint () const
const std::string & getWrapObjectName () const
WrapObjectgetWrapObject () const
void setWrapObject (WrapObject &aWrapObject)
PathWrapPointgetWrapPoint (int aIndex)
WrapMethod getMethod () const
void setMethod (WrapMethod aMethod)
const std::string & getMethodName () const
GeometryPathgetPath () const
const WrapResultgetPreviousWrap () const
void setPreviousWrap (const WrapResult &aWrapResult)
void resetPreviousWrap ()

Protected Member Functions

void setupProperties ()
 Connect properties to local pointers.

Protected Attributes

PropertyStr _wrapObjectNameProp
std::string & _wrapObjectName
PropertyStr _methodNameProp
std::string & _methodName
WrapMethod _method
PropertyIntArray _rangeProp
Array< int > & _range
WrapObject_wrapObject
GeometryPath_path
WrapResult _previousWrap
PathWrapPoint _wrapPoints [2]

Detailed Description

A class implementing an instance of muscle wrapping.

That is, it is owned by a particular muscle, and contains parameters for wrapping that muscle over a particular wrap object.

Author:
Peter Loan
Version:
1.0

Member Enumeration Documentation

Enumerator:
hybrid 
midpoint 
axial 

Constructor & Destructor Documentation

PathWrap::PathWrap (  ) 

Default constructor.

PathWrap::PathWrap ( const PathWrap aPathWrap  ) 

Copy constructor.

Parameters:
aPathWrap PathWrap to be copied.
PathWrap::~PathWrap (  )  [virtual]

Destructor.


Member Function Documentation

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

Copy this PathWrap and return a pointer to the copy.

The copy constructor for this class is used.

Returns:
Pointer to a copy of this PathWrap.

Reimplemented from OpenSim::Object.

void PathWrap::copyData ( const PathWrap aPathWrap  ) 

Copy data members from one PathWrap to another.

Parameters:
aPathWrap PathWrap to be copied.
int OpenSim::PathWrap::getEndPoint (  )  const [inline]
WrapMethod OpenSim::PathWrap::getMethod (  )  const [inline]
const std::string& OpenSim::PathWrap::getMethodName (  )  const [inline]
GeometryPath* OpenSim::PathWrap::getPath (  )  const [inline]
const WrapResult& OpenSim::PathWrap::getPreviousWrap (  )  const [inline]
int OpenSim::PathWrap::getStartPoint (  )  const [inline]
WrapObject* OpenSim::PathWrap::getWrapObject (  )  const [inline]
const std::string& OpenSim::PathWrap::getWrapObjectName (  )  const [inline]
PathWrapPoint & PathWrap::getWrapPoint ( int  aIndex  ) 
PathWrap & PathWrap::operator= ( const PathWrap aPathWrap  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Object.

void PathWrap::resetPreviousWrap (  ) 
void PathWrap::setEndPoint ( const SimTK::State &  s,
int  aIndex 
)
void PathWrap::setMethod ( WrapMethod  aMethod  ) 
void PathWrap::setPreviousWrap ( const WrapResult aWrapResult  ) 
void PathWrap::setStartPoint ( const SimTK::State &  s,
int  aIndex 
)
void PathWrap::setup ( const Model aModel,
GeometryPath aPath 
) [virtual]

Perform some set up functions that happen after the object has been deserialized or copied.

Parameters:
s current state of system
aModel pointer to the OpenSim model.
void PathWrap::setupProperties ( void   )  [protected]

Connect properties to local pointers.

Reimplemented from OpenSim::Object.

void PathWrap::setWrapObject ( WrapObject aWrapObject  ) 

Member Data Documentation

std::string& OpenSim::PathWrap::_methodName [protected]
Array<int>& OpenSim::PathWrap::_range [protected]
std::string& OpenSim::PathWrap::_wrapObjectName [protected]

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

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