OpenSim::FunctionThresholdCondition Class Reference

FunctionThresholdCondition is a concrete implementation of a Condition. More...

#include <FunctionThresholdCondition.h>

Inheritance diagram for OpenSim::FunctionThresholdCondition:
OpenSim::Condition OpenSim::Object

List of all members.

Public Member Functions

 FunctionThresholdCondition ()
 Default constructor.
 FunctionThresholdCondition (const FunctionThresholdCondition &aFunctionThresholdCondition)
 Copy constructor.
virtual ~FunctionThresholdCondition ()
 Destructor.
virtual Objectcopy () const
 Copy this Condition and return a pointer to the copy.
FunctionThresholdConditionoperator= (const FunctionThresholdCondition &aFunctionThresholdCondition)
 Assignment operator.
void copyData (const FunctionThresholdCondition &aFunctionThresholdCondition)
 Copy data members from one FunctionThresholdCondition to another.
virtual void setup (Model &aModel)
 Perform some set up functions that happen after the object has been deserialized or copied.
virtual bool calcCondition (const SimTK::State &s) const
 The defining FunctionThresholdCondition method.

Protected Attributes

PropertyObjPtr< Function_functionProp
 Function that Condition evaluates.
Function *& _function
PropertyDbl _thresholdProp
 Function that Condition evaluates.
double & _threshold

Detailed Description

FunctionThresholdCondition is a concrete implementation of a Condition.

A FunctionThresholdCondition returns true if its associate function is above a certain threshold and false otherwise.

Specific FunctionThresholdConditions should be derived from this class.

Author:
Ajay Seth
Version:
1.0

Constructor & Destructor Documentation

FunctionThresholdCondition::FunctionThresholdCondition (  ) 

Default constructor.

FunctionThresholdCondition::FunctionThresholdCondition ( const FunctionThresholdCondition aCondition  ) 

Copy constructor.

Parameters:
aCondition FunctionThresholdCondition to be copied.
FunctionThresholdCondition::~FunctionThresholdCondition (  )  [virtual]

Destructor.


Member Function Documentation

bool FunctionThresholdCondition::calcCondition ( const SimTK::State &  s  )  const [virtual]

The defining FunctionThresholdCondition method.

Reimplemented from OpenSim::Condition.

Object * FunctionThresholdCondition::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::Condition.

void FunctionThresholdCondition::copyData ( const FunctionThresholdCondition aCondition  ) 

Copy data members from one FunctionThresholdCondition to another.

Parameters:
aCondition FunctionThresholdCondition to be copied.

Reimplemented from OpenSim::Condition.

FunctionThresholdCondition & FunctionThresholdCondition::operator= ( const FunctionThresholdCondition aCondition  ) 

Assignment operator.

Returns:
Reference to this object.

Reimplemented from OpenSim::Condition.

void FunctionThresholdCondition::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 from OpenSim::Condition.


Member Data Documentation

Function that Condition evaluates.

Function that Condition evaluates.


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

Generated on Wed Dec 16 15:03:45 2009 for OpenSim by  doxygen 1.6.1