OpenSim::ConditionalPathPoint Class Reference

A class implementing a conditional path point, which is a point that is active only for a specified range of a coordinate. More...

#include <ConditionalPathPoint.h>

Inheritance diagram for OpenSim::ConditionalPathPoint:

List of all members.

Public Member Functions
	ConditionalPathPoint ()
	Default constructor.
	ConditionalPathPoint (const ConditionalPathPoint &aPoint)
	Copy constructor.
virtual	~ConditionalPathPoint ()
	Destructor.
virtual Object *	copy () const
	Copy this conditional point and return a pointer to the copy.
ConditionalPathPoint &	operator= (const ConditionalPathPoint &aPoint)
	Assignment operator.
void	copyData (const ConditionalPathPoint &aPoint)
	Copy data members from one ConditionalPathPoint to another.
virtual void	init (const PathPoint &aPoint)
	Initialize a ConditionalPathPoint with data from a PathPoint.
Array< double > &	getRange () const
const Coordinate *	getCoordinate () const
const std::string &	getCoordinateName () const
void	setCoordinate (const SimTK::State &s, Coordinate &aCoordinate)
	Set the coordinate that this point is linked to.
void	setRangeMin (const SimTK::State &s, double aMin)
	Set the range min.
void	setRangeMax (const SimTK::State &s, double aMax)
	Set the range max.
virtual bool	isActive (const SimTK::State &s) const
	Determine if this point is active by checking the value of the coordinate that it is linked to.
virtual void	setup (const Model &aModel, GeometryPath &aPath)
	Perform some set up functions that happen after the object has been deserialized or copied.
	OPENSIM_DECLARE_DERIVED (ConditionalPathPoint, PathPoint)
Protected Attributes
PropertyDblArray	_rangeProp
Array< double > &	_range
PropertyStr	_coordinateNameProp
std::string &	_coordinateName
const Coordinate *	_coordinate

---

Detailed Description

A class implementing a conditional path point, which is a point that is active only for a specified range of a coordinate.

Author:

Peter Loan

Version:

1.0

---

Constructor & Destructor Documentation

ConditionalPathPoint::ConditionalPathPoint

(

)

Default constructor.

ConditionalPathPoint::ConditionalPathPoint

(

const ConditionalPathPoint &

aPoint

)

Copy constructor.

Parameters:

aPoint

ConditionalPathPoint to be copied.

ConditionalPathPoint::~ConditionalPathPoint

(

)

[virtual]

Destructor.

---

Member Function Documentation

Object * ConditionalPathPoint::copy

(

)

const [virtual]

Copy this conditional point and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this ConditionalPathPoint.

Reimplemented from OpenSim::PathPoint.

void ConditionalPathPoint::copyData

(

const ConditionalPathPoint &

aPoint

)

Copy data members from one ConditionalPathPoint to another.

Parameters:

aPoint

ConditionalPathPoint to be copied.

Reimplemented from OpenSim::PathPoint.

const Coordinate* OpenSim::ConditionalPathPoint::getCoordinate

(

)

const [inline]

const std::string& OpenSim::ConditionalPathPoint::getCoordinateName

(

)

const [inline]

Array<double>& OpenSim::ConditionalPathPoint::getRange

(

)

const [inline]

void ConditionalPathPoint::init

(

const PathPoint &

aPoint

)

[virtual]

Initialize a ConditionalPathPoint with data from a PathPoint.

This function should not do anything to invalidate the path, because the via point may not be added to it.

Parameters:

aPoint

PathPoint to be copied.

bool ConditionalPathPoint::isActive

(

const SimTK::State &

s

)

const [virtual]

Determine if this point is active by checking the value of the coordinate that it is linked to.

Returns:

Whether or not this point is active.

Reimplemented from OpenSim::PathPoint.

OpenSim::ConditionalPathPoint::OPENSIM_DECLARE_DERIVED	(	ConditionalPathPoint	,
		PathPoint
	)

ConditionalPathPoint & ConditionalPathPoint::operator=

(

const ConditionalPathPoint &

aPoint

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::PathPoint.

void ConditionalPathPoint::setCoordinate	(	const SimTK::State &	s,
		Coordinate &	aCoordinate
	)

Set the coordinate that this point is linked to.

Returns:

Whether or not this point is active.

void ConditionalPathPoint::setRangeMax	(	const SimTK::State &	s,
		double	aMax
	)

Set the range max.

Parameters:

aRange

range max to change to.

void ConditionalPathPoint::setRangeMin	(	const SimTK::State &	s,
		double	aMin
	)

Set the range min.

Parameters:

aRange

range min to change to.

void ConditionalPathPoint::setup	(	const Model &	aModel,
		GeometryPath &	aPath
	)			[virtual]

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

Parameters:

aModel

model containing this ConditionalPathPoint.

Reimplemented from OpenSim::PathPoint.

---

Member Data Documentation

const Coordinate* OpenSim::ConditionalPathPoint::_coordinate [protected]

std::string& OpenSim::ConditionalPathPoint::_coordinateName [protected]

PropertyStr OpenSim::ConditionalPathPoint::_coordinateNameProp [protected]

Array<double>& OpenSim::ConditionalPathPoint::_range [protected]

PropertyDblArray OpenSim::ConditionalPathPoint::_rangeProp [protected]

---

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

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