OpenSim::AnalysisSet Class Reference

#include <AnalysisSet.h>

Inheritance diagram for OpenSim::AnalysisSet:

List of all members.

Public Member Functions
AnalysisSet &	operator= (const AnalysisSet &aAnalysisSet)
	Assign this object to the values of another.
	AnalysisSet ()
	AnalysisSet (Model *aModel)
	Construct an empty analysis set.
	AnalysisSet (const std::string &aFileName)
	AnalysisSet (const AnalysisSet &aSet)
	Copy constructor.
virtual	~AnalysisSet ()
	Destructor.
virtual Object *	copy () const
	Copy this analysis set.
void	setModel (Model &aModel)
	Set the model for all analyses in the set.
Model &	getModel ()
	Get a pointer to the model which is actuated.
void	setOn (bool aTrueFalse)
	Set all the callbacks either on or off.
void	setOn (const Array< bool > &aOn)
Array< bool >	getOn () const
virtual void	begin (const SimTK::State &s)
	Call the begin method for all integration callbacks.
virtual void	step (const SimTK::State &s)
	Call the step method for all integration callbacks.
virtual void	end (const SimTK::State &s)
	Call the end method for all integration callbacks.
virtual void	printResults (const std::string &aBaseName, const std::string &aPath="", double aDT=-1.0, const std::string &aExtension=".sto")
Static Public Member Functions
static void	getAvailableAnalyses (AnalysisSet &as)
	Fills the passed in analysis set with all available (i.e.
Protected Attributes
Model *	_model
	Model on which the callbacks have been set.
OpenSim::PropertyBool	_enableProp
bool &	_enable

---

Constructor & Destructor Documentation

AnalysisSet::AnalysisSet

(

)

AnalysisSet::AnalysisSet

(

Model *

aModel

)

Construct an empty analysis set.

Parameters:

aModel

Model for the analysis set.

OpenSim::AnalysisSet::AnalysisSet

(

const std::string &

aFileName

)

AnalysisSet::AnalysisSet

(

const AnalysisSet &

aSet

)

Copy constructor.

Parameters:

aSet

Analysis set to be copied.

AnalysisSet::~AnalysisSet

(

)

[virtual]

Destructor.

Note that the individual analyses are not deleted by this destructor. To delete the analyses, the caller must do so individually.

---

Member Function Documentation

void AnalysisSet::begin

(

const SimTK::State &

s

)

[virtual]

Call the begin method for all integration callbacks.

This method is called at the beginning of an integration and is intended to be used for any initializations that are necessary.

Parameters:

s

Current state

Object * AnalysisSet::copy

(

)

const [virtual]

Copy this analysis set.

Returns:

Copy of this analysis set.

Reimplemented from OpenSim::Set< Analysis >.

void AnalysisSet::end

(

const SimTK::State &

s

)

[virtual]

Call the end method for all integration callbacks.

This method is called after an integration has been completed and is intended to be used for performing any finalizations necessary.

Parameters:

s

Current state

void AnalysisSet::getAvailableAnalyses

(

AnalysisSet &

as

)

[static]

Fills the passed in analysis set with all available (i.e.

registered) analyses.

Model & AnalysisSet::getModel

(

)

Get a pointer to the model which is actuated.

Returns:

Pointer to the model.

OpenSim::Array< bool > AnalysisSet::getOn

(

)

const

AnalysisSet & AnalysisSet::operator=

(

const AnalysisSet &

aObject

)

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.

virtual void OpenSim::AnalysisSet::printResults	(	const std::string &	aBaseName,
		const std::string &	aPath = "",
		double	aDT = -1.0,
		const std::string &	aExtension = ".sto"
	)			[virtual]

void AnalysisSet::setModel

(

Model &

aModel

)

Set the model for all analyses in the set.

Parameters:

aModel

Pointer to the model.

void AnalysisSet::setOn

(

const Array< bool > &

aOn

)

void AnalysisSet::setOn

(

bool

aTrueFalse

)

Set all the callbacks either on or off.

Parameters:

aTrueFalse

Arguement that, if true, results in all callbacks being turned on; if false, all callbacks are turned off.

void AnalysisSet::step

(

const SimTK::State &

s

)

[virtual]

Call the step method for all integration callbacks.

This method is called after each successful integration time step and is intended to be used for conducting analyses, driving animations, etc.

Parameters:

s

Current state

---

Member Data Documentation

bool& OpenSim::AnalysisSet::_enable [protected]

OpenSim::PropertyBool OpenSim::AnalysisSet::_enableProp [protected]

Model* OpenSim::AnalysisSet::_model [protected]

Model on which the callbacks have been set.

---

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

• OpenSim/Simulation/Model/AnalysisSet.h
• OpenSim/Simulation/Model/AnalysisSet.cpp