API  4.1
For C++ developers
OpenSim::Storage Class Reference

A class for storing an array of statevectors. More...

+ Inheritance diagram for OpenSim::Storage:

Public Member Functions

 Storage (int aCapacity=Storage_DEFAULT_CAPACITY, const std::string &aName="UNKNOWN")
 
 Storage (const std::string &aFileName, bool readHeadersOnly=false)
 Load a data file into a Storage. More...
 
 Storage (const Storage &aStorage, bool aCopyData=true)
 
 Storage (const Storage &aStorage, int aStateIndex, int aN, const char *aDelimiter="\)
 
virtual ~Storage ()
 
Storageoperator= (const Storage &aStorage)
 Assignment operator to copy contents of an existing storage. More...
 
const std::string & getName () const
 
const std::string & getDescription () const
 
void setName (const std::string &aName)
 
void setDescription (const std::string &aDescription)
 
const int & getFileVersion () const
 
int getSize () const override
 
int getSmallestNumberOfStates () const
 
StateVectorgetStateVector (int aTimeIndex) const override
 
StateVectorgetLastStateVector () const override
 
double getFirstTime () const override
 
double getLastTime () const override
 
double getMinTimeStep () const
 
bool getTime (int aTimeIndex, double &rTime, int aStateIndex=-1) const
 
virtual int getTimeColumn (double *&rTimes, int aStateIndex=-1) const
 
int getTimeColumn (Array< double > &rTimes, int aStateIndex=-1) const override
 
void getTimeColumnWithStartTime (Array< double > &rTimes, double startTime=0.0) const override
 
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 getData (int aTimeIndex, int aN, Array< double > &rData) const
 
int getData (int aTimeIndex, int aN, SimTK::Vector &v) 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 override
 
int getDataAtTime (double aTime, int aN, SimTK::Vector &v) 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) override
 
TimeSeriesTable exportToTable () const
 Convert to a TimeSeriesTable. More...
 
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... More...
 
OpenSim::Array< int > getColumnIndicesForIdentifier (const std::string &identifier) const
 Get indices of columns whose labels begin with the specified "identifier" (prefix). More...
 
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
 Get the column index corresponding to specified column name. More...
 
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)
 
int append (const StateVector &aVec, bool aCheckForDuplicateTime=true) override
 
int append (const Array< StateVector > &aArray) override
 
int append (double aT, int aN, const double *aY, bool aCheckForDuplicateTime=true) override
 
int append (double aT, const SimTK::Vector &aY, bool aCheckForDuplicateTime=true) override
 
virtual int append (double aT, const Array< double > &aY, bool aCheckForDuplicateTime=true)
 
int append (double aT, const SimTK::Vec3 &aY, bool aCheckForDuplicateTime=true) override
 
int store (int aStep, double aT, int aN, const double *aY) override
 
void shiftTime (double aValue)
 
void scaleTime (double aValue)
 
void add (double aValue)
 
void add (const SimTK::Vector_< double > &values)
 
void add (int aN, double aValue)
 
void add (StateVector *aStateVector)
 
void add (Storage *aStorage)
 
void subtract (double aValue)
 
void subtract (const SimTK::Vector_< double > &values)
 
void subtract (StateVector *aStateVector)
 
void subtract (Storage *aStorage)
 
void multiply (double aValue)
 
void multiplyColumn (int aIndex, double aValue)
 
void multiply (const SimTK::Vector_< double > &values)
 
void multiply (StateVector *aStateVector)
 
void multiply (Storage *aStorage)
 
void divide (double aValue)
 
void divide (const SimTK::Vector_< double > &values)
 
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 order, double cutoffFrequency)
 Smooth spline each of the columns in the storage. More...
 
void lowpassIIR (double cutoffFrequency)
 Low-pass filter each of the columns in the storage using a 3rd order lowpass IIR Butterworth digital filter. More...
 
void lowpassFIR (int order, double cutoffFrequency)
 Lowpass filter each of the columns in the storage using an FIR non- recursive digital filter. More...
 
void addToRdStorage (Storage &rStorage, double aStartTime, double aEndTime)
 
int findIndex (double aT) const override
 
int findIndex (int aI, double aT) const override
 
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 (const Storage &aOtherStorage, const std::string &aColumnName, double startTime=SimTK::NaN, double endTime=SimTK::NaN) const
 
void compareWithStandard (const Storage &standard, std::vector< std::string > &columnsUsed, std::vector< double > &comparisons) const
 
bool makeStorageLabelsUnique ()
 Force column labels for a Storage object to become unique. More...
 
bool storageLabelsAreUnique () 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) override
 
void interpolateAt (const Array< double > &targetTimes)
 
- Public Member Functions inherited from OpenSim::StorageInterface
 StorageInterface (const std::string &aFileName)
 
 StorageInterface (const StorageInterface &aStorageInterface)
 
virtual ~StorageInterface ()
 
StorageInterfaceoperator= (const StorageInterface &aStorageInterface)
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
- Public Member Functions inherited from OpenSim::Object
virtual ~Object ()
 Virtual destructor for cleanup. More...
 
bool isEqualTo (const Object &aObject) const
 Equality operator wrapper for use from languages not supporting operator overloading. More...
 
Objectoperator= (const Object &aObject)
 Copy assignment copies he base class fields, including the properties. More...
 
virtual bool operator== (const Object &aObject) const
 Determine if two objects are equal. More...
 
virtual bool operator< (const Object &aObject) const
 Provide an ordering for objects so they can be put in sorted containers. More...
 
void setName (const std::string &name)
 Set the name of the Object. More...
 
const std::string & getName () const
 Get the name of this Object. More...
 
void setDescription (const std::string &description)
 Set description, a one-liner summary. More...
 
const std::string & getDescription () const
 Get description, a one-liner summary. More...
 
const std::string & getAuthors () const
 Get Authors of this Object. More...
 
void setAuthors (const std::string &authors)
 Set Authors of this object. More...
 
const std::string & getReferences () const
 Get references or publications to cite if using this object. More...
 
void setReferences (const std::string &references)
 Set references or publications to cite if using this object. More...
 
int getNumProperties () const
 Determine how many properties are stored with this Object. More...
 
const AbstractPropertygetPropertyByIndex (int propertyIndex) const
 Get a const reference to a property by its index number, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByIndex (int propertyIndex)
 Get a writable reference to a property by its index number, returned as an AbstractProperty. More...
 
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. More...
 
const AbstractPropertygetPropertyByName (const std::string &name) const
 Get a const reference to a property by its name, returned as an AbstractProperty. More...
 
AbstractPropertyupdPropertyByName (const std::string &name)
 Get a writable reference to a property by its name, returned as an AbstractProperty. More...
 
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. More...
 
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. More...
 
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. More...
 
bool isObjectUpToDateWithProperties () const
 Returns true if no property's value has changed since the last time setObjectIsUpToDateWithProperties() was called. More...
 
void readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
 We're given an XML element from which we are to populate this Object. More...
 
virtual void updateFromXMLNode (SimTK::Xml::Element &objectElement, int versionNumber)
 Use this method to deserialize an object from a SimTK::Xml::Element. More...
 
void updateXMLNode (SimTK::Xml::Element &parent, const AbstractProperty *prop=nullptr) const
 Serialize this object into the XML node that represents it. More...
 
bool getInlined () const
 Inlined means an in-memory Object that is not associated with an XMLDocument. More...
 
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. More...
 
std::string getDocumentFileName () const
 If there is a document associated with this object then return the file name maintained by the document. More...
 
int getDocumentFileVersion () const
 If there is a document associated with this object then return its version number. More...
 
void setAllPropertiesUseDefault (bool aUseDefault)
 
bool print (const std::string &fileName) const
 Write this Object into an XML file of the given name; conventionally the suffix to use is ".osim". More...
 
std::string dump () const
 dump the XML representation of this Object into an std::string and return it. More...
 
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. More...
 
const std::string & toString () const
 Wrapper to be used on Java side to display objects in tree; this returns just the object's name. More...
 
PropertySetgetPropertySet ()
 OBSOLETE: Get a reference to the PropertySet maintained by the Object. More...
 
const PropertySetgetPropertySet () const
 

Public Types

typedef Storage Self
 This typedef might be useful within the member functions of this class. More...
 
typedef StorageInterface Super
 Use this typedef to refer to the superclass of this class. More...
 
- Public Types inherited from OpenSim::StorageInterface
typedef StorageInterface Self
 This typedef might be useful within the member functions of this class. More...
 
typedef Object Super
 Use this typedef to refer to the superclass of this class. More...
 

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 Member Functions inherited from OpenSim::StorageInterface
static StorageInterfacesafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "StorageInterface". More...
 
- Static Public Member Functions inherited from OpenSim::Object
static void registerType (const Object &defaultObject)
 Register an instance of a class; if the class is already registered it will be replaced. More...
 
static void renameType (const std::string &oldTypeName, const std::string &newTypeName)
 Support versioning by associating the current Object type with an old name. More...
 
static const ObjectgetDefaultInstanceOfType (const std::string &concreteClassName)
 Return a pointer to the default instance of the registered (concrete) Object whose class name is given, or NULL if the type is not registered. More...
 
template<class T >
static bool isObjectTypeDerivedFrom (const std::string &concreteClassName)
 Return true if the given concrete object type represents a subclass of the template object type T, and thus could be referenced with a T*. More...
 
static ObjectnewInstanceOfType (const std::string &concreteClassName)
 Create a new instance of the concrete Object type whose class name is given as concreteClassName. More...
 
static void getRegisteredTypenames (Array< std::string > &typeNames)
 Retrieve all the typenames registered so far. More...
 
template<class T >
static void getRegisteredObjectsOfGivenType (ArrayPtrs< T > &rArray)
 Return an array of pointers to the default instances of all registered (concrete) Object types that derive from a given Object-derived type that does not have to be concrete. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &classNameDotPropertyName, bool printFlagInfo=true)
 Dump formatted property information to a given output stream, useful for creating a "help" facility for registered objects. More...
 
static bool PrintPropertyInfo (std::ostream &os, const std::string &className, const std::string &propertyName, bool printFlagInfo=true)
 Same as the other signature but the class name and property name are provided as two separate strings. More...
 
static ObjectmakeObjectFromFile (const std::string &fileName)
 Create an OpenSim object whose type is based on the tag at the root node of the XML file passed in. More...
 
static const std::string & getClassName ()
 Return the name of this class as a string; i.e., "Object". More...
 
static void setSerializeAllDefaults (bool shouldSerializeDefaults)
 Static function to control whether all registered objects and their properties are written to the defaults section of output files rather than only those values for which the default was explicitly overwritten when read in from an input file or set programmatically. More...
 
static bool getSerializeAllDefaults ()
 Report the value of the "serialize all defaults" flag. More...
 
static bool isKindOf (const char *type)
 Returns true if the passed-in string is "Object"; each Object-derived class defines a method of this name for its own class name. More...
 
static void setDebugLevel (int newLevel)
 Set the debug level to get verbose output. More...
 
static int getDebugLevel ()
 Get current setting of debug level. More...
 
static ObjectSafeCopy (const Object *aObject)
 Use the clone() method to duplicate the given object unless the pointer is null in which case null is returned. More...
 
static void RegisterType (const Object &defaultObject)
 OBSOLETE alternate name for registerType(). More...
 
static void RenameType (const std::string &oldName, const std::string &newName)
 OBSOLETE alternate name for renameType(). More...
 

Static Public Attributes

static const char * DEFAULT_HEADER_TOKEN
 Default token used to mark the end of the storage description in a file. More...
 
static const char * DEFAULT_HEADER_SEPARATOR
 
static const int MAX_RESAMPLE_SIZE
 
- Static Public Attributes inherited from OpenSim::Object
static const std::string DEFAULT_NAME
 Name used for default objects when they are serialized. More...
 

Protected Attributes

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

Static Protected Attributes

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

Auto-generated functions

static StoragesafeDownCast (OpenSim::Object *obj)
 For use in MATLAB and Python to access the concrete class. More...
 
static const std::string & getClassName ()
 This returns "Storage". More...
 
void assign (Object &aObject) override
 This allows copy assignment in the Java GUI. More...
 
Storageclone () const override
 Create a new heap-allocated copy of the concrete object to which this Object refers. More...
 
const std::string & getConcreteClassName () const override
 Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string. More...
 

Additional Inherited Members

- Protected Member Functions inherited from OpenSim::Object
 Object ()
 The default constructor is only for use by constructors of derived types. More...
 
 Object (const std::string &fileName, bool aUpdateFromXMLNode=true)
 Constructor from a file, to be called from other constructors that take a file as input. More...
 
 Object (const Object &source)
 Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly. More...
 
 Object (SimTK::Xml::Element &aElement)
 Construct the base class portion of an Object from a given Xml element that describes this Object. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
PropertyIndex getPropertyIndex (const std::string &name) const
 Look up a property by name and return its PropertyIndex if it is found. More...
 
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. More...
 
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. More...
 
void clearObjectIsUpToDateWithProperties ()
 For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag. More...
 
void makeObjectNamesConsistentWithProperties ()
 Make sure the name of an object is consistent with its property type. More...
 
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. More...
 
void setDocument (XMLDocument *doc)
 Unconditionally set the XMLDocument associated with this object. More...
 
const XMLDocumentgetDocument () const
 Get a const pointer to the document (if any) associated with this object. More...
 
XMLDocumentupdDocument ()
 Get a writable pointer to the document (if any) associated with this object. More...
 

Detailed Description

A class for storing an array of statevectors.

A statevector is an array of data that has an associated time stamp (see StateVector). Generally, it is used to store the time histories of the states during an integration, but may be used for a variety of applications. Note that it is assumed by several methods in this class that the time stamps of stored statevectors are monotonically increasing.

When stored as a file, the statevectors are stored in rows. This first value in a row is the time stamp at which the states occurred. The rest of the elements in a row are the states. Therefore, each column of data in a file corresponds to a particular state.

In an Storage object, statevectors (or rows) are indexed by the TimeIndex, and a particular state (or column) is indexed by the StateIndex.

Version
1.0
Author
Frank C. Anderson

Member Typedef Documentation

◆ Self

This typedef might be useful within the member functions of this class.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ Super

Use this typedef to refer to the superclass of this class.

Avoid using the explicit type name of the superclass; this would introduce bugs if the superclass is changed.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

Constructor & Destructor Documentation

◆ Storage() [1/4]

OpenSim::Storage::Storage ( int  aCapacity = Storage_DEFAULT_CAPACITY,
const std::string &  aName = "UNKNOWN" 
)
explicit

◆ Storage() [2/4]

OpenSim::Storage::Storage ( const std::string &  aFileName,
bool  readHeadersOnly = false 
)

Load a data file into a Storage.

Version 2 STO files: This constructor can read MOT, unversioned, version 1 and 2 STO files, and any data file format supported by FileAdapter, which includes C3D and TRC files. Several of these formats support tables of different element types (e.g. Vec3, Quaternion, SpatialVec), in which case these elements are flattened to scalar values with more columns.

See also
DataTable_::faltten() Note, this capability was introduced to support plotting OutputReporter results in the GUI and is not recommended for API users. In addition to only supporting scalar elements, Storage does not preserve the metadata that can be contained by version 2 STO files and read in from C3D and TRC files via their respective FileAdapters. In the case of data files with multiple tables (like C3D files) only the first table read is converted into a Storage. Please use FileAdapter (STOFileAdpater, C3DFileAdapter, ...) and TimeSeriesTable instead, whenever possible.

◆ Storage() [3/4]

OpenSim::Storage::Storage ( const Storage aStorage,
bool  aCopyData = true 
)

◆ Storage() [4/4]

OpenSim::Storage::Storage ( const Storage aStorage,
int  aStateIndex,
int  aN 
)

◆ ~Storage()

virtual OpenSim::Storage::~Storage ( )
virtual

Member Function Documentation

◆ add() [1/5]

void OpenSim::Storage::add ( double  aValue)

◆ add() [2/5]

void OpenSim::Storage::add ( const SimTK::Vector_< double > &  values)

◆ add() [3/5]

void OpenSim::Storage::add ( int  aN,
double  aValue 
)

◆ add() [4/5]

void OpenSim::Storage::add ( StateVector aStateVector)

◆ add() [5/5]

void OpenSim::Storage::add ( Storage aStorage)

◆ addKeyValuePair()

void OpenSim::Storage::addKeyValuePair ( const std::string &  aKey,
const std::string &  aValue 
)

◆ addToRdStorage()

void OpenSim::Storage::addToRdStorage ( Storage rStorage,
double  aStartTime,
double  aEndTime 
)

◆ append() [1/6]

int OpenSim::Storage::append ( const StateVector aVec,
bool  aCheckForDuplicateTime = true 
)
overridevirtual

◆ append() [2/6]

int OpenSim::Storage::append ( const Array< StateVector > &  aArray)
overridevirtual

◆ append() [3/6]

int OpenSim::Storage::append ( double  aT,
int  aN,
const double *  aY,
bool  aCheckForDuplicateTime = true 
)
overridevirtual

◆ append() [4/6]

int OpenSim::Storage::append ( double  aT,
const SimTK::Vector &  aY,
bool  aCheckForDuplicateTime = true 
)
overridevirtual

◆ append() [5/6]

virtual int OpenSim::Storage::append ( double  aT,
const Array< double > &  aY,
bool  aCheckForDuplicateTime = true 
)
virtual

◆ append() [6/6]

int OpenSim::Storage::append ( double  aT,
const SimTK::Vec3 &  aY,
bool  aCheckForDuplicateTime = true 
)
inlineoverridevirtual

Reimplemented from OpenSim::StorageInterface.

◆ assign()

void OpenSim::Storage::assign ( Object aObject)
inlineoverride

This allows copy assignment in the Java GUI.

Exceptions
Exceptionif the argument is not of type Storage.

◆ clone()

Storage* OpenSim::Storage::clone ( ) const
inlineoverridevirtual

Create a new heap-allocated copy of the concrete object to which this Object refers.

It is up to the caller to delete the returned object when no longer needed. Every concrete object deriving from Object implements this pure virtual method automatically, via the declaration macro it invokes (e.g., OpenSim_DECLARE_CONCRETE_OBJECT()). Note that the concrete class overrides modify the return type to be a pointer to the concrete object; that still overrides the base class method because the return type is covariant with (that is, derives from) Object.

Implements OpenSim::StorageInterface.

◆ compareColumn()

double OpenSim::Storage::compareColumn ( Storage aOtherStorage,
const std::string &  aColumnName,
double  startTime,
double  endTime = -1.0 
)

◆ compareColumnRMS()

double OpenSim::Storage::compareColumnRMS ( const Storage aOtherStorage,
const std::string &  aColumnName,
double  startTime = SimTK::NaN,
double  endTime = SimTK::NaN 
) const

◆ compareWithStandard()

void OpenSim::Storage::compareWithStandard ( const Storage standard,
std::vector< std::string > &  columnsUsed,
std::vector< double > &  comparisons 
) const

◆ computeArea() [1/2]

int OpenSim::Storage::computeArea ( int  aN,
double *  aArea 
) const

◆ computeArea() [2/2]

int OpenSim::Storage::computeArea ( double  aTI,
double  aTF,
int  aN,
double *  aArea 
) const

◆ computeAverage() [1/2]

int OpenSim::Storage::computeAverage ( int  aN,
double *  aAve 
) const

◆ computeAverage() [2/2]

int OpenSim::Storage::computeAverage ( double  aTI,
double  aTF,
int  aN,
double *  aAve 
) const

◆ crop()

void OpenSim::Storage::crop ( const double  newStartTime,
const double  newFinalTime 
)

◆ divide() [1/4]

void OpenSim::Storage::divide ( double  aValue)

◆ divide() [2/4]

void OpenSim::Storage::divide ( const SimTK::Vector_< double > &  values)

◆ divide() [3/4]

void OpenSim::Storage::divide ( StateVector aStateVector)

◆ divide() [4/4]

void OpenSim::Storage::divide ( Storage aStorage)

◆ exportToTable()

TimeSeriesTable OpenSim::Storage::exportToTable ( ) const

Convert to a TimeSeriesTable.

This may be useful if you need to use parts of the API that require a TimeSeriesTable instead of a Storage.

Referenced by OpenSim::ForceReporter::getForcesTable().

◆ findFrameRange()

void OpenSim::Storage::findFrameRange ( double  aStartTime,
double  aEndTime,
int &  oStartFrame,
int &  oEndFrame 
) const

◆ findIndex() [1/2]

int OpenSim::Storage::findIndex ( double  aT) const
overridevirtual

◆ findIndex() [2/2]

int OpenSim::Storage::findIndex ( int  aI,
double  aT 
) const
overridevirtual

◆ getCapacityIncrement()

int OpenSim::Storage::getCapacityIncrement ( ) const

◆ getClassName()

static const std::string& OpenSim::Storage::getClassName ( )
inlinestatic

This returns "Storage".

See getConcreteClassName() if you want the class name of the underlying concrete object instead.

This is generated by the OpenSim_DECLARE_*_OBJECT macros.

◆ getColumnIndicesForIdentifier()

OpenSim::Array<int> OpenSim::Storage::getColumnIndicesForIdentifier ( const std::string &  identifier) const

Get indices of columns whose labels begin with the specified "identifier" (prefix).

Returns an empty Array if none of the column labels begin with the identifier.

◆ getColumnLabels()

const Array<std::string>& OpenSim::Storage::getColumnLabels ( ) const

◆ getConcreteClassName()

const std::string& OpenSim::Storage::getConcreteClassName ( ) const
inlineoverridevirtual

Returns the class name of the concrete Object-derived class of the actual object referenced by this Object, as a string.

This is the string that is used as the tag for this concrete object in an XML file. Every concrete class derived from Object automatically overrides this method via the declaration macro it uses. See getClassName() to get the class name of the referencing (possibly abstract) class rather than the concrete object.

See also
getClassName()

Implements OpenSim::StorageInterface.

◆ getData() [1/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aStateIndex,
double &  rValue 
) const

◆ getData() [2/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aStateIndex,
int  aN,
double **  rData 
) const

◆ getData() [3/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aStateIndex,
int  aN,
double *  rData 
) const

◆ getData() [4/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aN,
double **  rData 
) const

◆ getData() [5/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aN,
double *  rData 
) const

◆ getData() [6/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aN,
Array< double > &  rData 
) const

◆ getData() [7/7]

int OpenSim::Storage::getData ( int  aTimeIndex,
int  aN,
SimTK::Vector &  v 
) const

◆ getDataAtTime() [1/4]

int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
double **  rData 
) const

◆ getDataAtTime() [2/4]

int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
double *  rData 
) const

◆ getDataAtTime() [3/4]

int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
Array< double > &  rData 
) const
overridevirtual

◆ getDataAtTime() [4/4]

int OpenSim::Storage::getDataAtTime ( double  aTime,
int  aN,
SimTK::Vector &  v 
) const

◆ getDataColumn() [1/4]

int OpenSim::Storage::getDataColumn ( int  aStateIndex,
double *&  rData 
) const

◆ getDataColumn() [2/4]

int OpenSim::Storage::getDataColumn ( int  aStateIndex,
Array< double > &  rData 
) const

◆ getDataColumn() [3/4]

int OpenSim::Storage::getDataColumn ( const std::string &  columnName,
double *&  rData 
) const

◆ getDataColumn() [4/4]

void OpenSim::Storage::getDataColumn ( const std::string &  columnName,
Array< double > &  data,
double  startTime = 0.0 
)
overridevirtual

◆ getDataForIdentifier()

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
startTimeat what time to begin (if not 0)

◆ getDescription()

const std::string& OpenSim::Storage::getDescription ( ) const
inline

◆ getFileVersion()

const int& OpenSim::Storage::getFileVersion ( ) const
inline

◆ getFirstTime()

double OpenSim::Storage::getFirstTime ( ) const
overridevirtual

◆ getHeaderToken()

const std::string& OpenSim::Storage::getHeaderToken ( ) const

◆ getLastStateVector()

StateVector* OpenSim::Storage::getLastStateVector ( ) const
overridevirtual

◆ getLastTime()

double OpenSim::Storage::getLastTime ( ) const
overridevirtual

◆ getLatestVersion()

static const int& OpenSim::Storage::getLatestVersion ( )
inlinestatic

◆ getMinTimeStep()

double OpenSim::Storage::getMinTimeStep ( ) const

◆ getName()

const std::string& OpenSim::Storage::getName ( ) const
inline

◆ getSize()

int OpenSim::Storage::getSize ( ) const
inlineoverridevirtual

◆ getSmallestNumberOfStates()

int OpenSim::Storage::getSmallestNumberOfStates ( ) const

◆ getStateIndex()

const int OpenSim::Storage::getStateIndex ( const std::string &  aColumnName,
int  startIndex = 0 
) const

Get the column index corresponding to specified column name.

This function attempts to handle the change in state variable names that occurred in OpenSim version 4.0; for example, if you search for <coord-name>/speed and it is not found, then this function looks for <coord-name>_u.

Returns
State index of column or -1. Note that the returned index is equivalent to the state index. For example, for the first column in a storage (usually time) -1 would be returned. For the second column in a storage (the first state) 0 would be returned.

◆ getStateVector()

StateVector* OpenSim::Storage::getStateVector ( int  aTimeIndex) const
overridevirtual

◆ getStepInterval()

int OpenSim::Storage::getStepInterval ( ) const

◆ getTime()

bool OpenSim::Storage::getTime ( int  aTimeIndex,
double &  rTime,
int  aStateIndex = -1 
) const

◆ getTimeColumn() [1/2]

virtual int OpenSim::Storage::getTimeColumn ( double *&  rTimes,
int  aStateIndex = -1 
) const
virtual

◆ getTimeColumn() [2/2]

int OpenSim::Storage::getTimeColumn ( Array< double > &  rTimes,
int  aStateIndex = -1 
) const
overridevirtual

◆ getTimeColumnWithStartTime()

void OpenSim::Storage::getTimeColumnWithStartTime ( Array< double > &  rTimes,
double  startTime = 0.0 
) const
overridevirtual

◆ getValueForKey()

void OpenSim::Storage::getValueForKey ( const std::string &  aKey,
std::string &  rValue 
) const

◆ getWriteSIMMHeader()

bool OpenSim::Storage::getWriteSIMMHeader ( ) const

◆ hasKey()

bool OpenSim::Storage::hasKey ( const std::string &  aKey) const

◆ integrate() [1/2]

Storage* OpenSim::Storage::integrate ( int  aI1 = -2,
int  aI2 = -1 
) const

◆ integrate() [2/2]

Storage* OpenSim::Storage::integrate ( double  aT1,
double  aT2 
) const

◆ interpolateAt()

void OpenSim::Storage::interpolateAt ( const Array< double > &  targetTimes)

◆ isInDegrees()

const bool OpenSim::Storage::isInDegrees ( ) const
inline

◆ lowpassFIR()

void OpenSim::Storage::lowpassFIR ( int  order,
double  cutoffFrequency 
)

Lowpass filter each of the columns in the storage using an FIR non- recursive digital filter.

Note that as a part of this operation, the storage is re-sampled to obtain uniform samples unless its time steps are already uniform.

Parameters
orderOrder of the FIR filter.
cutoffFrequencyCutoff frequency.

◆ lowpassIIR()

void OpenSim::Storage::lowpassIIR ( double  cutoffFrequency)

Low-pass filter each of the columns in the storage using a 3rd order lowpass IIR Butterworth digital filter.

Note that as a part of this operation, the storage is re-sampled to obtain uniform samples unless its time steps are already uniform.

Parameters
cutoffFrequencyCutoff frequency of the lowpass filter.

◆ makeStorageLabelsUnique()

bool OpenSim::Storage::makeStorageLabelsUnique ( )

Force column labels for a Storage object to become unique.

This is done by prepending the string (n_) as needed where n=1, 2, ...

Returns
true if labels were already unique.

◆ multiply() [1/4]

void OpenSim::Storage::multiply ( double  aValue)

◆ multiply() [2/4]

void OpenSim::Storage::multiply ( const SimTK::Vector_< double > &  values)

◆ multiply() [3/4]

void OpenSim::Storage::multiply ( StateVector aStateVector)

◆ multiply() [4/4]

void OpenSim::Storage::multiply ( Storage aStorage)

◆ multiplyColumn()

void OpenSim::Storage::multiplyColumn ( int  aIndex,
double  aValue 
)

◆ operator=()

Storage& OpenSim::Storage::operator= ( const Storage aStorage)

Assignment operator to copy contents of an existing storage.

◆ pad()

void OpenSim::Storage::pad ( int  aPadSize)

◆ print() [1/2]

bool OpenSim::Storage::print ( const std::string &  aFileName,
const std::string &  aMode = "w",
const std::string &  aComment = "" 
) const

◆ print() [2/2]

int OpenSim::Storage::print ( const std::string &  aFileName,
double  aDT,
const std::string &  aMode = "w" 
) const

◆ printResult()

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

◆ purge()

void OpenSim::Storage::purge ( )
inline

◆ resample()

double OpenSim::Storage::resample ( double  aDT,
int  aDegree 
)

◆ resampleLinear()

double OpenSim::Storage::resampleLinear ( double  aDT)

◆ reset() [1/2]

int OpenSim::Storage::reset ( int  aIndex = 0)

◆ reset() [2/2]

int OpenSim::Storage::reset ( double  aTime)

◆ safeDownCast()

static Storage* OpenSim::Storage::safeDownCast ( OpenSim::Object obj)
inlinestatic

For use in MATLAB and Python to access the concrete class.

Example: cObj = Storage.safeDownCast(obj). This is equivalent to dynamic_cast<Storage*>(obj) in C++.

◆ scaleTime()

void OpenSim::Storage::scaleTime ( double  aValue)

◆ setCapacityIncrement()

void OpenSim::Storage::setCapacityIncrement ( int  aIncrement)

◆ setColumnLabels()

void OpenSim::Storage::setColumnLabels ( const Array< std::string > &  aColumnLabels)

◆ setDataColumn()

void OpenSim::Storage::setDataColumn ( int  aStateIndex,
const Array< double > &  aData 
)

◆ setDataColumnToFixedValue()

void OpenSim::Storage::setDataColumnToFixedValue ( const std::string &  columnName,
double  newValue 
)

◆ setDescription()

void OpenSim::Storage::setDescription ( const std::string &  aDescription)
inline

◆ setHeaderToken()

void OpenSim::Storage::setHeaderToken ( const std::string &  aToken)

◆ setInDegrees()

void OpenSim::Storage::setInDegrees ( const bool  isInDegrees)
inline

◆ setName()

void OpenSim::Storage::setName ( const std::string &  aName)
inline

◆ setOutputFileName()

void OpenSim::Storage::setOutputFileName ( const std::string &  aFileName)
overridevirtual

◆ setStepInterval()

void OpenSim::Storage::setStepInterval ( int  aStepInterval)

◆ setWriteSIMMHeader()

void OpenSim::Storage::setWriteSIMMHeader ( bool  aTrueFalse)

◆ shiftTime()

void OpenSim::Storage::shiftTime ( double  aValue)

◆ smoothSpline()

void OpenSim::Storage::smoothSpline ( int  order,
double  cutoffFrequency 
)

Smooth spline each of the columns in the storage.

Note that as a part of this operation, the storage is re-sampled to obtain uniform samples unless its time steps are already uniform.

Parameters
orderOrder of the spline.
cutoffFrequencyCutoff frequency of the smoothing filter.

◆ storageLabelsAreUnique()

bool OpenSim::Storage::storageLabelsAreUnique ( ) const

◆ store()

int OpenSim::Storage::store ( int  aStep,
double  aT,
int  aN,
const double *  aY 
)
overridevirtual

◆ subtract() [1/4]

void OpenSim::Storage::subtract ( double  aValue)

◆ subtract() [2/4]

void OpenSim::Storage::subtract ( const SimTK::Vector_< double > &  values)

◆ subtract() [3/4]

void OpenSim::Storage::subtract ( StateVector aStateVector)

◆ subtract() [4/4]

void OpenSim::Storage::subtract ( Storage aStorage)

Member Data Documentation

◆ _columnLabels

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

Column labels.

◆ _description

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

◆ _fileName

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.

◆ _fileVersion

int OpenSim::Storage::_fileVersion = -1
protected

Storage file version as written to the file.

◆ _fp

FILE* OpenSim::Storage::_fp
protected

◆ _headerToken

std::string OpenSim::Storage::_headerToken
protected

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

◆ _inDegrees

bool OpenSim::Storage::_inDegrees
protected

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

◆ _keyValueMap

MapKeysToValues OpenSim::Storage::_keyValueMap
protected

Map between keys in file header and values.

◆ _lastI

int OpenSim::Storage::_lastI
mutableprotected

Last index at which a search was started.

◆ _name

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

Name and Description.

◆ _stepInterval

int OpenSim::Storage::_stepInterval
protected

Step interval at which states in a simulation are stored.

See store().

◆ _storage

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

Array of StateVectors.

◆ _units

Units OpenSim::Storage::_units
protected

Units in which the data is represented.

◆ _writeSIMMHeader

bool OpenSim::Storage::_writeSIMMHeader
protected

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

◆ DEFAULT_HEADER_SEPARATOR

const char* OpenSim::Storage::DEFAULT_HEADER_SEPARATOR
static

◆ DEFAULT_HEADER_TOKEN

const char* OpenSim::Storage::DEFAULT_HEADER_TOKEN
static

Default token used to mark the end of the storage description in a file.

◆ LatestVersion

const int OpenSim::Storage::LatestVersion
staticprotected

◆ MAX_RESAMPLE_SIZE

const int OpenSim::Storage::MAX_RESAMPLE_SIZE
static

◆ simmReservedKeys

std::string OpenSim::Storage::simmReservedKeys[]
staticprotected

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