API  4.3
For C++ developers
List of all members | Public Member Functions | Friends
OpenSim::Component::StateVariable Class Referenceabstract

Public Member Functions

 StateVariable ()
 
 StateVariable (const std::string &name, const Component &owner, SimTK::SubsystemIndex sbsix, int varIndex, bool hide=false)
 
virtual ~StateVariable ()
 
const std::string & getName () const
 
const Component & getOwner () const
 
const int & getVarIndex () const
 
const SimTK::SubsystemIndex & getSubsysIndex () const
 
const SimTK::SystemYIndex & getSystemYIndex () const
 
bool isHidden () const
 
void hide ()
 
void show ()
 
void setVarIndex (int index)
 
void setSubsystemIndex (const SimTK::SubsystemIndex &sbsysix)
 
virtual double getValue (const SimTK::State &state) const =0
 
virtual void setValue (SimTK::State &state, double value) const =0
 
virtual double getDerivative (const SimTK::State &state) const =0
 
virtual void setDerivative (const SimTK::State &state, double deriv) const =0
 

Friends

void Component::addStateVariable (StateVariable *sv) const
 

Constructor & Destructor Documentation

◆ StateVariable() [1/2]

OpenSim::Component::StateVariable::StateVariable ( )
inline

◆ StateVariable() [2/2]

OpenSim::Component::StateVariable::StateVariable ( const std::string &  name,
const Component &  owner,
SimTK::SubsystemIndex  sbsix,
int  varIndex,
bool  hide = false 
)
inlineexplicit

◆ ~StateVariable()

virtual OpenSim::Component::StateVariable::~StateVariable ( )
inlinevirtual

Member Function Documentation

◆ getDerivative()

virtual double OpenSim::Component::StateVariable::getDerivative ( const SimTK::State &  state) const
pure virtual

◆ getName()

const std::string& OpenSim::Component::StateVariable::getName ( ) const
inline

◆ getOwner()

const Component& OpenSim::Component::StateVariable::getOwner ( ) const
inline

◆ getSubsysIndex()

const SimTK::SubsystemIndex& OpenSim::Component::StateVariable::getSubsysIndex ( ) const
inline

◆ getSystemYIndex()

const SimTK::SystemYIndex& OpenSim::Component::StateVariable::getSystemYIndex ( ) const
inline

◆ getValue()

virtual double OpenSim::Component::StateVariable::getValue ( const SimTK::State &  state) const
pure virtual

◆ getVarIndex()

const int& OpenSim::Component::StateVariable::getVarIndex ( ) const
inline

◆ hide()

void OpenSim::Component::StateVariable::hide ( )
inline

◆ isHidden()

bool OpenSim::Component::StateVariable::isHidden ( ) const
inline

◆ setDerivative()

virtual void OpenSim::Component::StateVariable::setDerivative ( const SimTK::State &  state,
double  deriv 
) const
pure virtual

◆ setSubsystemIndex()

void OpenSim::Component::StateVariable::setSubsystemIndex ( const SimTK::SubsystemIndex &  sbsysix)
inline

◆ setValue()

virtual void OpenSim::Component::StateVariable::setValue ( SimTK::State &  state,
double  value 
) const
pure virtual

◆ setVarIndex()

void OpenSim::Component::StateVariable::setVarIndex ( int  index)
inline

◆ show()

void OpenSim::Component::StateVariable::show ( )
inline

Friends And Related Function Documentation

◆ Component::addStateVariable

void Component::addStateVariable ( StateVariable *  sv) const
friend
The documentation for this class was generated from the following file: