OpenSim  OpenSim 3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
OpenSim::Storage Class Reference

#include <Storage.h>

Inheritance diagram for OpenSim::Storage:
OpenSim::StorageInterface OpenSim::Object

Public Member Functions

 Storage (int aCapacity=Storage_DEFAULT_CAPACITY, const std::string &aName="UNKNOWN")
 Storage (const std::string &aFileName, bool readHeadersOnly=false) SWIG_DECLARE_EXCEPTION
 Storage (const Storage &aStorage, bool aCopyData=true)
 Storage (const Storage &aStorage, int aStateIndex, int aN, const char *aDelimiter="\t")
virtual ~Storage ()
Storageoperator= (const Storage &aStorage)
 Assignment operator to copy contents of an existing storage.
const std::string & getName () const
 Get the name of this Object.
const std::string & getDescription () const
 Get description, a one-liner summary.
void setName (const std::string &aName)
 Set the name of the Object.
void setDescription (const std::string &aDescription)
 Set description, a one-liner summary.
const int & getFileVersion () const
virtual int getSize () const
int getSmallestNumberOfStates () const
virtual StateVectorgetStateVector (int aTimeIndex) const
virtual StateVectorgetLastStateVector () const
virtual double getFirstTime () const
virtual double getLastTime () const
double getMinTimeStep () const
bool getTime (int aTimeIndex, double &rTime, int aStateIndex=-1) const
virtual int getTimeColumn (double *&rTimes, int aStateIndex=-1) const
virtual int getTimeColumn (Array< double > &rTimes, int aStateIndex=-1) const
virtual void getTimeColumnWithStartTime (Array< double > &rTimes, double startTime=0.0) const
void addKeyValuePair (const std::string &aKey, const std::string &aValue)
void getValueForKey (const std::string &aKey, std::string &rValue) const
bool hasKey (const std::string &aKey) const
const bool isInDegrees () const
void setInDegrees (const bool isInDegrees)
int getData (int aTimeIndex, int aStateIndex, double &rValue) const
int getData (int aTimeIndex, int aStateIndex, int aN, double **rData) const
int getData (int aTimeIndex, int aStateIndex, int aN, double *rData) const
int getData (int aTimeIndex, int aN, double **rData) const
int getData (int aTimeIndex, int aN, double *rData) const
int getDataAtTime (double aTime, int aN, double **rData) const
int getDataAtTime (double aTime, int aN, double *rData) const
int getDataAtTime (double aTime, int aN, Array< double > &rData) const
int getDataColumn (int aStateIndex, double *&rData) const
int getDataColumn (int aStateIndex, Array< double > &rData) const
void setDataColumnToFixedValue (const std::string &columnName, double newValue)
void setDataColumn (int aStateIndex, const Array< double > &aData)
int getDataColumn (const std::string &columnName, double *&rData) const
void getDataColumn (const std::string &columnName, Array< double > &data, double startTime=0.0)
void getDataForIdentifier (const std::string &identifier, Array< Array< double > > &rData, double startTime=0.0) const
 A data block, like a vector for a force, point, etc...
OpenSim::Array< int > getColumnIndicesForIdentifier (const std::string &identifier) const
 Get indices of columns corresponding to identifier, empty array if identifier is not found in labels.
void setStepInterval (int aStepInterval)
int getStepInterval () const
void setCapacityIncrement (int aIncrement)
int getCapacityIncrement () const
void setWriteSIMMHeader (bool aTrueFalse)
bool getWriteSIMMHeader () const
void setHeaderToken (const std::string &aToken)
const std::string & getHeaderToken () const
const int getStateIndex (const std::string &aColumnName, int startIndex=0) const
void setColumnLabels (const Array< std::string > &aColumnLabels)
const Array< std::string > & getColumnLabels () const
int reset (int aIndex=0)
int reset (double aTime)
void purge ()
void crop (const double newStartTime, const double newFinalTime)
virtual int append (const StateVector &aVec, bool aCheckForDuplicateTime=true)
virtual int append (const Array< StateVector > &aArray)
virtual int append (double aT, int aN, const double *aY, bool aCheckForDuplicateTime=true)
virtual int append (double aT, const SimTK::Vector &aY, bool aCheckForDuplicateTime=true)
virtual int append (double aT, const SimTK::Vec3 &aY, bool aCheckForDuplicateTime=true)
virtual int store (int aStep, double aT, int aN, const double *aY)
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 add (Storage *aStorage)
void subtract (double aValue)
void subtract (int aN, double aY[])
void subtract (StateVector *aStateVector)
void subtract (Storage *aStorage)
void multiply (double aValue)
void multiplyColumn (int aIndex, double aValue)
void multiply (int aN, double aY[])
void multiply (StateVector *aStateVector)
void multiply (Storage *aStorage)
void divide (double aValue)
void divide (int aN, double aY[])
void divide (StateVector *aStateVector)
void divide (Storage *aStorage)
Storageintegrate (int aI1=-2, int aI2=-1) const
Storageintegrate (double aT1, double aT2) const
int computeArea (int aN, double *aArea) const
int computeArea (double aTI, double aTF, int aN, double *aArea) const
int computeAverage (int aN, double *aAve) const
int computeAverage (double aTI, double aTF, int aN, double *aAve) const
void pad (int aPadSize)
void smoothSpline (int aOrder, double aCutoffFrequency)
void lowpassIIR (double aCutoffFequency)
void lowpassFIR (int aOrder, double aCutoffFequency)
void addToRdStorage (Storage &rStorage, double aStartTime, double aEndTime)
virtual int findIndex (double aT) const
virtual int findIndex (int aI, double aT) const
void findFrameRange (double aStartTime, double aEndTime, int &oStartFrame, int &oEndFrame) const
double resample (double aDT, int aDegree)
double resampleLinear (double aDT)
double compareColumn (Storage &aOtherStorage, const std::string &aColumnName, double startTime, double endTime=-1.0)
double compareColumnRMS (Storage &aOtherStorage, const std::string &aColumnName, double startTime=SimTK::NaN, double endTime=SimTK::NaN)
void compareWithStandard (Storage &standard, Array< std::string > &columnsUsed, Array< double > &comparisons)
bool makeStorageLabelsUnique ()
void print () const
bool print (const std::string &aFileName, const std::string &aMode="w", const std::string &aComment="") const
int print (const std::string &aFileName, double aDT, const std::string &aMode="w") const
void setOutputFileName (const std::string &aFileName)
void interpolateAt (const Array< double > &targetTimes)
- Public Member Functions inherited from OpenSim::StorageInterface
 StorageInterface (const std::string &aFileName) SWIG_DECLARE_EXCEPTION
 StorageInterface (const StorageInterface &aStorageInterface)
virtual ~StorageInterface ()
StorageInterfaceoperator= (const StorageInterface &aStorageInterface)
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup.
virtual Objectclone () const =0
 
Create a new heap-allocated copy of the concrete object to which this 

Object refers.

virtual const std::string & getConcreteClassName () const =0
 
Returns the class name of the concrete %Object-derived class of the

actual object referenced by this Object, as a string.

virtual const VisibleObjectgetDisplayer () const
 Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObjectupdDisplayer ()
 get Non const pointer to VisibleObject
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading.
Objectoperator= (const Object &aObject)
 
Copy assignment copies he base class fields, including the 

properties.

virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal.
virtual bool operator< (const Object &aObject) const
 
Provide an ordering for objects so they can be put in sorted

containers.

const std::string & getAuthors () const
 Get Authors of this Object.
void setAuthors (const std::string &authors)
 Set Authors of this object, call this method in your constructor if needed.
const std::string & getReferences () const
 Get references or publications to cite if using this object.
void setReferences (const std::string &references)
 Set references or publications to cite if using this object.
int getNumProperties () const
 Determine how many properties are stored with this Object.
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 
Get a const reference to a property by its index number, returned as

an AbstractProperty.

AbstractPropertyupdPropertyByIndex (int propertyIndex)
 
Get a writable reference to a property by its index number, returned as

an AbstractProperty.

bool hasProperty (const std::string &name) const
 
Return true if this %Object has a property of any type with the 

given name, which must not be empty.

const AbstractPropertygetPropertyByName (const std::string &name) const
 
Get a const reference to a property by its name, returned as

an AbstractProperty.

AbstractPropertyupdPropertyByName (const std::string &name)
 
Get a writable reference to a property by its name, returned as

an AbstractProperty.

template<class T >
bool hasProperty () const
 
Return true if this %Object contains an unnamed, one-object property

that contains objects of the given template type T.

template<class T >
const Property< T > & getProperty (const PropertyIndex &index) const
 
Get property of known type Property\<T> as a const reference; 

the property must be present and have the right type.

template<class T >
Property< T > & updProperty (const PropertyIndex &index)
 
Get property of known type Property\<T> as a writable reference;

the property must be present and have the right type.

void setObjectIsUpToDateWithProperties ()
 
When an object is initialized using the current values of its 

properties, it can set a flag indicating that it is up to date.

bool isObjectUpToDateWithProperties () const
 
Returns \c true if any property's value has changed since the last time

setObjectIsUpToDateWithProperties() was called.

void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object.
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element.
virtual void updateXMLNode (SimTK::Xml::Element &parent)
 Serialize this object into the XML node that represents it.
bool getInlined () const
 
Inlined means an in-memory Object that is not associated with

an XMLDocument.

void setInlined (bool aInlined, const std::string &aFileName="")
 
Mark this as inlined or not and optionally provide a file name

to associate with the new XMLDocument for the non-inline case.

std::string getDocumentFileName () const
 
If there is a document associated with this object then return the

file name maintained by the document.

void setAllPropertiesUseDefault (bool aUseDefault)
bool print (const std::string &fileName)
 
Write this %Object into an XML file of the given name; conventionally

the suffix to use is ".osim".

std::string dump (bool dumpName=false)
 dump the XML representation of this Object into an std::string and return it.
void clearObjectIsUpToDateWithProperties ()
 
For testing or debugging purposes, manually clear the "object is up to 

date with respect to properties" flag.

virtual bool isA (const char *type) const
 
The default implementation returns true only if the supplied string

is "Object"; each Object-derived class overrides this to match its own class name.

const std::string & toString () const
 
Wrapper to be used on Java side to display objects in tree; this returns

just the object's name.

PropertySetgetPropertySet ()
 
OBSOLETE: Get a reference to the PropertySet maintained by the 

Object.

const PropertySetgetPropertySet () const

Static Public Member Functions

static const int & getLatestVersion ()
static void printResult (const Storage *aStorage, const std::string &aName, const std::string &aDir, double aDT, const std::string &aExtension)

Static Public Attributes

static const char * DEFAULT_HEADER_TOKEN
 
Default token used to mark the end of the storage description in

a file.

static const char * DEFAULT_HEADER_SEPARATOR
static const int MAX_RESAMPLE_SIZE

Protected Attributes

Array< StateVector_storage
 Array of StateVectors.
std::string _headerToken
 Token used to mark the end of the description in a file.
Array< std::string > _columnLabels
 Column labels.
int _stepInterval
 Step interval at which states in a simulation are stored.
int _lastI
 Last index at which a search was started.
bool _writeSIMMHeader
 Flag for whether or not to insert a SIMM style header.
Units _units
 Units in which the data is represented.
bool _inDegrees
 Are angles, if any, specified in radians or degrees?
MapKeysToValues _keyValueMap
 Map between keys in file header and values.
std::string _fileName
 Cache for fileName and file pointer when the file is opened so we can flush and write intermediate files if needed.
FILE * _fp
std::string _name
 Name and Description.
std::string _description
int _fileVersion
 Storage file version as written to the file.

Static Protected Attributes

static std::string simmReservedKeys []
static const int LatestVersion

Additional Inherited Members

- Protected Member Functions inherited from OpenSim::Object
 Object ()
 
 The default constructor is only for use by constructors of 

derived types.

 Object (const std::string &fileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
 
Constructor from a file, to be called from other constructors that 

take a file as input.

 Object (const Object &source)
 
Copy constructor is invoked automatically by derived classes with

default copy constructors; otherwise it must be invoked explicitly.

 Object (SimTK::Xml::Element &aElement)
 
Construct the base class portion of an %Object from a given Xml 

element that describes this Object.

template<class T >
PropertyIndex addProperty (const std::string &name, const std::string &comment, const T &value)
 
Define a new single-value property of known type T, with the given 

name, associated comment, and initial value.

template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment)
 
Add an optional property, meaning it can contain either no value or

a single value.

template<class T >
PropertyIndex addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
 
Add an optional property, meaning it can contain either no value or

a single value.

template<class T >
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
 
Define a new list-valued property of known type T, with the given 

name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value.

template<class T , template< class > class Container>
PropertyIndex addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
 
Define a new list-valued property as above, but assigning an initial

value via some templatized container class that supports size() and indexing.

PropertyIndex getPropertyIndex (const std::string &name) const
 
Look up a property by name and return its PropertyIndex if it is

found.

template<class T >
PropertyIndex getPropertyIndex () const
 
Look up an unnamed property by the type of object it contains,

and return its PropertyIndex if it is found.

void updateFromXMLDocument ()
 
Use this method only if you're deserializing from a file and the object

is at the top level; that is, primarily in constructors that take a file name as input.

void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object.
const XMLDocumentgetDocument () const
 
Get a const pointer to the document (if any) associated with this

object.

XMLDocumentupdDocument ()
 
Get a writable pointer to the document (if any) associated with this

object.

Constructor & Destructor Documentation

OpenSim::Storage::Storage ( int  aCapacity = Storage_DEFAULT_CAPACITY,
const std::string &  aName = "UNKNOWN" 
)
explicit
OpenSim::Storage::Storage ( const std::string &  aFileName,
bool  readHeadersOnly = false 
)
OpenSim::Storage::Storage ( const Storage aStorage,
bool  aCopyData = true 
)
OpenSim::Storage::Storage ( const Storage aStorage,
int  aStateIndex,
int  aN,
const char *  aDelimiter = "\t" 
)
virtual OpenSim::Storage::~Storage ( )
virtual

Member Function Documentation

void OpenSim::Storage::add ( double  aValue)
void OpenSim::Storage::add ( int  aN,
double  aY[] 
)
void OpenSim::Storage::add ( int  aN,
double  aValue 
)
void OpenSim::Storage::add ( StateVector aStateVector)
void OpenSim::Storage::add ( Storage aStorage)
void OpenSim::Storage::addKeyValuePair ( const std::string &  aKey,
const std::string &  aValue 
)
void OpenSim::Storage::addToRdStorage ( Storage rStorage,
double  aStartTime,
double  aEndTime 
)
virtual int OpenSim::Storage::append ( const StateVector aVec,
bool  aCheckForDuplicateTime = true 
)
virtual
virtual int OpenSim::Storage::append ( const Array< StateVector > &  aArray)
virtual
virtual int OpenSim::Storage::append ( double  aT,
int  aN,
const double *  aY,
bool  aCheckForDuplicateTime = true 
)
virtual
virtual int OpenSim::Storage::append ( double  aT,
const SimTK::Vector &  aY,
bool  aCheckForDuplicateTime = true 
)
virtual
virtual int OpenSim::Storage::append ( double  aT,
const SimTK::Vec3 &  aY,
bool  aCheckForDuplicateTime = true 
)
inlinevirtual

Reimplemented from OpenSim::StorageInterface.

double OpenSim::Storage::compareColumn ( Storage aOtherStorage,
const std::string &  aColumnName,
double  startTime,
double  endTime = -1.0 
)
double OpenSim::Storage::compareColumnRMS ( Storage aOtherStorage,
const std::string &  aColumnName,
double  startTime = SimTK::NaN,
double  endTime = SimTK::NaN 
)
void OpenSim::Storage::compareWithStandard ( Storage standard,
Array< std::string > &  columnsUsed,
Array< double > &  comparisons 
)
int OpenSim::Storage::computeArea ( int  aN,
double *  aArea 
) const
int OpenSim::Storage::computeArea ( double  aTI,
double  aTF,
int  aN,
double *  aArea 
) const
int OpenSim::Storage::computeAverage ( int  aN,
double *  aAve 
) const
int OpenSim::Storage::computeAverage ( double  aTI,
double  aTF,
int  aN,
double *  aAve 
) const
void OpenSim::Storage::crop ( const double  newStartTime,
const double  newFinalTime 
)
void OpenSim::Storage::divide ( double  aValue)
void OpenSim::Storage::divide ( int  aN,
double  aY[] 
)
void OpenSim::Storage::divide ( StateVector aStateVector)
void OpenSim::Storage::divide ( Storage aStorage)
void OpenSim::Storage::findFrameRange ( double  aStartTime,
double  aEndTime,
int &  oStartFrame,
int &  oEndFrame 
) const
virtual int OpenSim::Storage::findIndex ( double  aT) const
virtual
virtual int OpenSim::Storage::findIndex ( int  aI,
double  aT 
) const
virtual
int OpenSim::Storage::getCapacityIncrement ( ) const
OpenSim::Array<int> OpenSim::Storage::getColumnIndicesForIdentifier ( const std::string &  identifier) const

Get indices of columns corresponding to identifier, empty array if identifier is not found in labels.

const Array<std::string>& OpenSim::Storage::getColumnLabels ( ) const
int OpenSim::Storage::getData ( int  aTimeIndex,
int  aStateIndex,
double &  rValue 
) const
int OpenSim::Storage::getData ( int  aTimeIndex,
int  aStateIndex,
int  aN,
double **  rData 
) const
int OpenSim::Storage::getData ( int  aTimeIndex,
int  aStateIndex,
int  aN,
double *  rData 
) const
int OpenSim::Storage::getData ( int  aTimeIndex,
int  aN,
double **  rData 
) const
int OpenSim::Storage::getData ( int  aTimeIndex,
int  aN,
double *  rData 
) const
int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
double **  rData 
) const
int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
double *  rData 
) const
int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
Array< double > &  rData 
) const
virtual
int OpenSim::Storage::getDataColumn ( int  aStateIndex,
double *&  rData 
) const
int OpenSim::Storage::getDataColumn ( int  aStateIndex,
Array< double > &  rData 
) const
int OpenSim::Storage::getDataColumn ( const std::string &  columnName,
double *&  rData 
) const
void OpenSim::Storage::getDataColumn ( const std::string &  columnName,
Array< double > &  data,
double  startTime = 0.0 
)
virtual
void OpenSim::Storage::getDataForIdentifier ( const std::string &  identifier,
Array< Array< double > > &  rData,
double  startTime = 0.0 
) const

A data block, like a vector for a force, point, etc...

will span multiple "columns" It is desirable to access the block as a single entity provided an identifier that is common to all components (such as prefix in the column label).

Parameters
identifierstring identifying a single block of data
rDataArray<Array<double>> of data belonging to the identifier
const std::string& OpenSim::Storage::getDescription ( ) const
inline

Get description, a one-liner summary.

Reimplemented from OpenSim::Object.

const int& OpenSim::Storage::getFileVersion ( ) const
inline
virtual double OpenSim::Storage::getFirstTime ( ) const
virtual
const std::string& OpenSim::Storage::getHeaderToken ( ) const
virtual StateVector* OpenSim::Storage::getLastStateVector ( ) const
virtual
virtual double OpenSim::Storage::getLastTime ( ) const
virtual
static const int& OpenSim::Storage::getLatestVersion ( )
inlinestatic
double OpenSim::Storage::getMinTimeStep ( ) const
const std::string& OpenSim::Storage::getName ( ) const
inline

Get the name of this Object.

Reimplemented from OpenSim::Object.

virtual int OpenSim::Storage::getSize ( ) const
inlinevirtual
int OpenSim::Storage::getSmallestNumberOfStates ( ) const
const int OpenSim::Storage::getStateIndex ( const std::string &  aColumnName,
int  startIndex = 0 
) const
virtual StateVector* OpenSim::Storage::getStateVector ( int  aTimeIndex) const
virtual
int OpenSim::Storage::getStepInterval ( ) const
bool OpenSim::Storage::getTime ( int  aTimeIndex,
double &  rTime,
int  aStateIndex = -1 
) const
virtual int OpenSim::Storage::getTimeColumn ( double *&  rTimes,
int  aStateIndex = -1 
) const
virtual
virtual int OpenSim::Storage::getTimeColumn ( Array< double > &  rTimes,
int  aStateIndex = -1 
) const
virtual
virtual void OpenSim::Storage::getTimeColumnWithStartTime ( Array< double > &  rTimes,
double  startTime = 0.0 
) const
virtual
void OpenSim::Storage::getValueForKey ( const std::string &  aKey,
std::string &  rValue 
) const
bool OpenSim::Storage::getWriteSIMMHeader ( ) const
bool OpenSim::Storage::hasKey ( const std::string &  aKey) const
Storage* OpenSim::Storage::integrate ( int  aI1 = -2,
int  aI2 = -1 
) const
Storage* OpenSim::Storage::integrate ( double  aT1,
double  aT2 
) const
void OpenSim::Storage::interpolateAt ( const Array< double > &  targetTimes)
const bool OpenSim::Storage::isInDegrees ( ) const
inline
void OpenSim::Storage::lowpassFIR ( int  aOrder,
double  aCutoffFequency 
)
void OpenSim::Storage::lowpassIIR ( double  aCutoffFequency)
bool OpenSim::Storage::makeStorageLabelsUnique ( )
void OpenSim::Storage::multiply ( double  aValue)
void OpenSim::Storage::multiply ( int  aN,
double  aY[] 
)
void OpenSim::Storage::multiply ( StateVector aStateVector)
void OpenSim::Storage::multiply ( Storage aStorage)
void OpenSim::Storage::multiplyColumn ( int  aIndex,
double  aValue 
)
Storage& OpenSim::Storage::operator= ( const Storage aStorage)

Assignment operator to copy contents of an existing storage.

void OpenSim::Storage::pad ( int  aPadSize)
void OpenSim::Storage::print ( ) const
bool OpenSim::Storage::print ( const std::string &  aFileName,
const std::string &  aMode = "w",
const std::string &  aComment = "" 
) const
int OpenSim::Storage::print ( const std::string &  aFileName,
double  aDT,
const std::string &  aMode = "w" 
) const
static void OpenSim::Storage::printResult ( const Storage aStorage,
const std::string &  aName,
const std::string &  aDir,
double  aDT,
const std::string &  aExtension 
)
static
void OpenSim::Storage::purge ( )
inline
double OpenSim::Storage::resample ( double  aDT,
int  aDegree 
)
double OpenSim::Storage::resampleLinear ( double  aDT)
int OpenSim::Storage::reset ( int  aIndex = 0)
int OpenSim::Storage::reset ( double  aTime)
void OpenSim::Storage::scaleTime ( double  aValue)
void OpenSim::Storage::setCapacityIncrement ( int  aIncrement)
void OpenSim::Storage::setColumnLabels ( const Array< std::string > &  aColumnLabels)
void OpenSim::Storage::setDataColumn ( int  aStateIndex,
const Array< double > &  aData 
)
void OpenSim::Storage::setDataColumnToFixedValue ( const std::string &  columnName,
double  newValue 
)
void OpenSim::Storage::setDescription ( const std::string &  description)
inline

Set description, a one-liner summary.

Reimplemented from OpenSim::Object.

void OpenSim::Storage::setHeaderToken ( const std::string &  aToken)
void OpenSim::Storage::setInDegrees ( const bool  isInDegrees)
inline
void OpenSim::Storage::setName ( const std::string &  name)
inline

Set the name of the Object.

Reimplemented from OpenSim::Object.

void OpenSim::Storage::setOutputFileName ( const std::string &  aFileName)
virtual
void OpenSim::Storage::setStepInterval ( int  aStepInterval)
void OpenSim::Storage::setWriteSIMMHeader ( bool  aTrueFalse)
void OpenSim::Storage::shiftTime ( double  aValue)
void OpenSim::Storage::smoothSpline ( int  aOrder,
double  aCutoffFrequency 
)
virtual int OpenSim::Storage::store ( int  aStep,
double  aT,
int  aN,
const double *  aY 
)
virtual
void OpenSim::Storage::subtract ( double  aValue)
void OpenSim::Storage::subtract ( int  aN,
double  aY[] 
)
void OpenSim::Storage::subtract ( StateVector aStateVector)
void OpenSim::Storage::subtract ( Storage aStorage)

Member Data Documentation

Array<std::string> OpenSim::Storage::_columnLabels
protected

Column labels.

std::string OpenSim::Storage::_description
protected
std::string OpenSim::Storage::_fileName
protected

Cache for fileName and file pointer when the file is opened so we can flush and write intermediate files if needed.

int OpenSim::Storage::_fileVersion
protected

Storage file version as written to the file.

FILE* OpenSim::Storage::_fp
protected
std::string OpenSim::Storage::_headerToken
protected

Token used to mark the end of the description in a file.

bool OpenSim::Storage::_inDegrees
protected

Are angles, if any, specified in radians or degrees?

MapKeysToValues OpenSim::Storage::_keyValueMap
protected

Map between keys in file header and values.

int OpenSim::Storage::_lastI
mutableprotected

Last index at which a search was started.

std::string OpenSim::Storage::_name
protected

Name and Description.

int OpenSim::Storage::_stepInterval
protected

Step interval at which states in a simulation are stored.

See store().

Array<StateVector> OpenSim::Storage::_storage
protected

Array of StateVectors.

Units OpenSim::Storage::_units
protected

Units in which the data is represented.

bool OpenSim::Storage::_writeSIMMHeader
protected

Flag for whether or not to insert a SIMM style header.

const char* OpenSim::Storage::DEFAULT_HEADER_SEPARATOR
static
const char* OpenSim::Storage::DEFAULT_HEADER_TOKEN
static

Default token used to mark the end of the storage description in

a file.

const int OpenSim::Storage::LatestVersion
staticprotected
const int OpenSim::Storage::MAX_RESAMPLE_SIZE
static
std::string OpenSim::Storage::simmReservedKeys[]
staticprotected

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