OpenSim::Condition Class Reference

A parent class for implementing an OpenSim Condition. More...

#include <Condition.h>

Inheritance diagram for OpenSim::Condition:

List of all members.

Public Member Functions
	Condition ()
	Default constructor.
	Condition (const Condition &aCondition)
	Copy constructor.
virtual	~Condition ()
	Destructor.
virtual Object *	copy () const
	Copy this Condition and return a pointer to the copy.
Condition &	operator= (const Condition &aCondition)
	Assignment operator.
void	copyData (const Condition &aCondition)
	Copy data members from one Condition to another.
virtual void	setup (Model &aModel)
	Perform some set up functions that happen after the object has been deserialized or copied.
virtual bool	isDisabled () const
virtual void	setDisabled (bool isDisabled)
virtual bool	calcCondition (const SimTK::State &s) const
	The defining condition method that subclasses must override.
Protected Attributes
PropertyBool	_isDisabledProp
	Flag indicating whether the Condition is disabled or not.
bool &	_isDisabled
Model *	_model

---

Detailed Description

A parent class for implementing an OpenSim Condition.

Condition objects are useful for encapulating logic that is commonly used to make decisions. A Condition returns whether or not a particular condition is true or not, based on the current state.

Specific Conditions should be derived from this class.

Author:

Ajay Seth

Version:

1.0

---

Constructor & Destructor Documentation

Condition::Condition

(

)

Default constructor.

Condition::Condition

(

const Condition &

aCondition

)

Copy constructor.

Parameters:

aCondition

Condition to be copied.

Condition::~Condition

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual bool OpenSim::Condition::calcCondition

(

const SimTK::State &

s

)

const [inline, virtual]

The defining condition method that subclasses must override.

Reimplemented in OpenSim::FunctionThresholdCondition.

Object * Condition::copy

(

)

const [virtual]

Copy this Condition and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this OpenSim::Condition.

Reimplemented from OpenSim::Object.

Reimplemented in OpenSim::FunctionThresholdCondition.

void Condition::copyData

(

const Condition &

aCondition

)

Copy data members from one Condition to another.

Parameters:

aCondition

Condition to be copied.

Reimplemented in OpenSim::FunctionThresholdCondition.

virtual bool OpenSim::Condition::isDisabled

(

)

const [inline, virtual]

Condition & Condition::operator=

(

const Condition &

aCondition

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Object.

Reimplemented in OpenSim::FunctionThresholdCondition.

virtual void OpenSim::Condition::setDisabled

(

bool

isDisabled

)

[inline, virtual]

void Condition::setup

(

Model &

aModel

)

[virtual]

Perform some set up functions that happen after the object has been deserialized or copied.

Parameters:

aModel

OpenSim model containing this Condition.

Reimplemented in OpenSim::FunctionThresholdCondition.

---

Member Data Documentation

bool& OpenSim::Condition::_isDisabled [protected]

PropertyBool OpenSim::Condition::_isDisabledProp [protected]

Flag indicating whether the Condition is disabled or not.

Disabled means that the Condition is not active when

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

---

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

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