OpenSim::StorageInterface Class Reference

#include <StorageInterface.h>

Inheritance diagram for OpenSim::StorageInterface:

List of all members.

Public Member Functions
	StorageInterface (const std::string &aFileName) SWIG_DECLARE_EXCEPTION
	StorageInterface (const StorageInterface &aStorageInterface)
virtual Object *	copy () const =0
	Construct and return a copy of this object.
virtual	~StorageInterface ()
StorageInterface &	operator= (const StorageInterface &aStorageInterface)
	Assign this object to the values of another.
virtual int	getSize () const =0
virtual StateVector *	getStateVector (int aTimeIndex) const =0
virtual StateVector *	getLastStateVector () const =0
virtual double	getFirstTime () const =0
virtual double	getLastTime () const =0
virtual int	getTimeColumn (Array< double > &rTimes, int aStateIndex=-1) const =0
virtual void	getTimeColumnWithStartTime (Array< double > &rTimes, double startTime=0.0) const =0
virtual int	getDataAtTime (double aTime, int aN, Array< double > &rData) const =0
virtual void	getDataColumn (const std::string &columnName, Array< double > &data, double startTime=0.0)=0
virtual int	append (const StateVector &aVec, bool aCheckForDuplicateTime=true)=0
virtual int	append (const Array< StateVector > &aArray)=0
virtual int	append (double aT, int aN, const double *aY, bool aCheckForDuplicateTime=true)=0
virtual int	append (double aT, const SimTK::Vector &aY, bool aCheckForDuplicateTime=true)=0
virtual int	append (double aT, const SimTK::Vec3 &aY, bool aCheckForDuplicateTime=true)
virtual int	store (int aStep, double aT, int aN, const double *aY)=0
virtual int	findIndex (double aT) const =0
virtual int	findIndex (int aI, double aT) const =0
virtual void	setOutputFileName (const std::string &aFileName)=0

---

Constructor & Destructor Documentation

OpenSim::StorageInterface::StorageInterface

(

const std::string &

aFileName

)

[inline]

OpenSim::StorageInterface::StorageInterface

(

const StorageInterface &

aStorageInterface

)

[inline]

virtual OpenSim::StorageInterface::~StorageInterface

(

)

[inline, virtual]

---

Member Function Documentation

virtual int OpenSim::StorageInterface::append	(	double	aT,
		const SimTK::Vec3 &	aY,
		bool	aCheckForDuplicateTime = true
	)			[inline, virtual]

Reimplemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::append	(	double	aT,
		const SimTK::Vector &	aY,
		bool	aCheckForDuplicateTime = true
	)			[pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::append	(	double	aT,
		int	aN,
		const double *	aY,
		bool	aCheckForDuplicateTime = true
	)			[pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::append

(

const Array< StateVector > &

aArray

)

[pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::append	(	const StateVector &	aVec,
		bool	aCheckForDuplicateTime = true
	)			[pure virtual]

Implemented in OpenSim::Storage.

virtual Object* OpenSim::StorageInterface::copy

(

)

const [pure virtual]

Construct and return a copy of this object.

The object is allocated using the new operator, so the caller is responsible for deleting the returned object.

Returns:

Copy of this object.

Reimplemented from OpenSim::Object.

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::findIndex	(	int	aI,
		double	aT
	)			const [pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::findIndex

(

double

aT

)

const [pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::getDataAtTime	(	double	aTime,
		int	aN,
		Array< double > &	rData
	)			const [pure virtual]

Implemented in OpenSim::Storage.

virtual void OpenSim::StorageInterface::getDataColumn	(	const std::string &	columnName,
		Array< double > &	data,
		double	startTime = 0.0
	)			[pure virtual]

Implemented in OpenSim::Storage.

virtual double OpenSim::StorageInterface::getFirstTime

(

)

const [pure virtual]

Implemented in OpenSim::Storage.

virtual StateVector* OpenSim::StorageInterface::getLastStateVector

(

)

const [pure virtual]

Implemented in OpenSim::Storage.

virtual double OpenSim::StorageInterface::getLastTime

(

)

const [pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::getSize

(

)

const [pure virtual]

Implemented in OpenSim::Storage.

virtual StateVector* OpenSim::StorageInterface::getStateVector

(

int

aTimeIndex

)

const [pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::getTimeColumn	(	Array< double > &	rTimes,
		int	aStateIndex = -1
	)			const [pure virtual]

Implemented in OpenSim::Storage.

virtual void OpenSim::StorageInterface::getTimeColumnWithStartTime	(	Array< double > &	rTimes,
		double	startTime = 0.0
	)			const [pure virtual]

Implemented in OpenSim::Storage.

StorageInterface& OpenSim::StorageInterface::operator=

(

const StorageInterface &

aObject

)

[inline]

Assign this object to the values of another.

The XML-associated variable members are not copied-- the XML nodes and/or document must be generated anew for a copied object.

Returns:

Reference to this object.

See also:

updateXMLNode()

generateXMLNode()

Reimplemented from OpenSim::Object.

Reimplemented in OpenSim::Storage.

virtual void OpenSim::StorageInterface::setOutputFileName

(

const std::string &

aFileName

)

[pure virtual]

Implemented in OpenSim::Storage.

virtual int OpenSim::StorageInterface::store	(	int	aStep,
		double	aT,
		int	aN,
		const double *	aY
	)			[pure virtual]

Implemented in OpenSim::Storage.

---

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

• OpenSim/Common/StorageInterface.h