OpenSim  OpenSim 3.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::StateVector Class Reference

A class which stores a vector of states or data at a specified time. More...

#include <StateVector.h>

Public Member Functions

 StateVector (double aT=0.0, int aN=0, const double *aData=NULL)
 
 StateVector (const StateVector &aVector)
 
virtual ~StateVector ()
 
StateVectoroperator= (const StateVector &aStateVector)
 
bool operator== (const StateVector &aStateVector) const
 
bool operator< (const StateVector &aStateVector) const
 
void setStates (double aT, int aN, const double aY[])
 
int getSize () const
 
void setTime (double aT)
 
double getTime () const
 
int getDataValue (int aIndex, double &rValue)
 
void setDataValue (int aIndex, double &aValue)
 
Array< double > & getData ()
 
const Array< double > & getData () const
 
void shiftTime (double aValue)
 
void scaleTime (double aValue)
 
void add (double aValue)
 
void add (int aN, double aY[])
 
void add (int aN, double aValue)
 
void add (StateVector *aStateVector)
 
void subtract (double aValue)
 
void subtract (int aN, double aY[])
 
void subtract (StateVector *aStateVector)
 
void multiply (double aValue)
 
void multiply (int aN, double aY[])
 
void multiply (StateVector *aStateVector)
 
void divide (double aValue)
 
void divide (int aN, double aY[])
 
void divide (StateVector *aStateVector)
 
int print (FILE *fp) const
 

Friends

std::ostream & operator<< (std::ostream &aOut, const StateVector &aStateVector)
 

Detailed Description

A class which stores a vector of states or data at a specified time.

Generally, it is used to store the time histories of the states during an integration.

The format of the numerical output for this class is specified by the settings in IO.

Author
Frank C. Anderson
Version
1.0
See Also
IO

Constructor & Destructor Documentation

OpenSim::StateVector::StateVector ( double  aT = 0.0,
int  aN = 0,
const double *  aData = NULL 
)
OpenSim::StateVector::StateVector ( const StateVector aVector)
virtual OpenSim::StateVector::~StateVector ( )
virtual

Member Function Documentation

void OpenSim::StateVector::add ( double  aValue)
void OpenSim::StateVector::add ( int  aN,
double  aY[] 
)
void OpenSim::StateVector::add ( int  aN,
double  aValue 
)
void OpenSim::StateVector::add ( StateVector aStateVector)
void OpenSim::StateVector::divide ( double  aValue)
void OpenSim::StateVector::divide ( int  aN,
double  aY[] 
)
void OpenSim::StateVector::divide ( StateVector aStateVector)
Array<double>& OpenSim::StateVector::getData ( )
const Array<double>& OpenSim::StateVector::getData ( ) const
int OpenSim::StateVector::getDataValue ( int  aIndex,
double &  rValue 
)
int OpenSim::StateVector::getSize ( ) const
double OpenSim::StateVector::getTime ( ) const
void OpenSim::StateVector::multiply ( double  aValue)
void OpenSim::StateVector::multiply ( int  aN,
double  aY[] 
)
void OpenSim::StateVector::multiply ( StateVector aStateVector)
bool OpenSim::StateVector::operator< ( const StateVector aStateVector) const
StateVector& OpenSim::StateVector::operator= ( const StateVector aStateVector)
bool OpenSim::StateVector::operator== ( const StateVector aStateVector) const
int OpenSim::StateVector::print ( FILE *  fp) const
void OpenSim::StateVector::scaleTime ( double  aValue)
void OpenSim::StateVector::setDataValue ( int  aIndex,
double &  aValue 
)
void OpenSim::StateVector::setStates ( double  aT,
int  aN,
const double  aY[] 
)
void OpenSim::StateVector::setTime ( double  aT)
void OpenSim::StateVector::shiftTime ( double  aValue)
void OpenSim::StateVector::subtract ( double  aValue)
void OpenSim::StateVector::subtract ( int  aN,
double  aY[] 
)
void OpenSim::StateVector::subtract ( StateVector aStateVector)

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  aOut,
const StateVector aStateVector 
)
friend

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