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:

Public Member Functions
	ConditionalPathPoint ()
	ConditionalPathPoint (const ConditionalPathPoint &aPoint)
virtual	~ConditionalPathPoint ()
ConditionalPathPoint &	operator= (const ConditionalPathPoint &aPoint)
void	copyData (const ConditionalPathPoint &aPoint)
virtual void	init (const PathPoint &aPoint)
virtual void	updateFromXMLNode (SimTK::Xml::Element &aNode, int versionNumber=-1)
	Use this method to deserialize an object from a SimTK::Xml::Element.
Array< double > &	getRange () const
const Coordinate *	getCoordinate () const
const std::string &	getCoordinateName () const
void	setCoordinate (const SimTK::State &s, Coordinate &aCoordinate)
void	setRangeMin (const SimTK::State &s, double aMin)
void	setRangeMax (const SimTK::State &s, double aMax)
bool	isActive (const SimTK::State &s) const override
void	connectToModelAndPath (const Model &aModel, GeometryPath &aPath) override
Public Member Functions inherited from OpenSim::PathPoint
	PathPoint ()
	PathPoint (const PathPoint &aPoint)
virtual	~PathPoint ()
PathPoint &	operator= (const PathPoint &aPoint)
void	copyData (const PathPoint &aPoint)
const SimTK::Vec3 &	getLocation () const
SimTK::Vec3 &	getLocation ()
const double &	getLocationCoord (int aXYZ) const
void	setLocationCoord (int aXYZ, double aValue)
void	setLocation (const SimTK::State &s, const SimTK::Vec3 &aLocation)
void	setLocation (const SimTK::State &s, int aCoordIndex, double aLocation)
void	setLocation (const SimTK::State &s, double pt[])
void	setBody (OpenSim::Body &aBody)
void	changeBodyPreserveLocation (const SimTK::State &s, OpenSim::Body &aBody)
OpenSim::Body &	getBody () const
const std::string &	getBodyName () const
GeometryPath *	getPath () const
virtual void	scale (const SimTK::State &s, const SimTK::Vec3 &aScaleFactors)
virtual WrapObject *	getWrapObject () const
virtual void	update (const SimTK::State &s)
virtual void	getVelocity (const SimTK::State &s, SimTK::Vec3 &aVelocity)
virtual const VisibleObject *	getDisplayer () const
	Methods to support making the object displayable in the GUI or Visualizer Implemented only in few objects.
virtual VisibleObject *	updDisplayer ()
	get Non const pointer to VisibleObject
virtual void	updateGeometry ()
Public Member Functions inherited from OpenSim::Object
virtual	~Object ()
	Virtual destructor for cleanup.
virtual Object *	clone () const =0
	Create a new heap-allocated copy of the concrete object to which this Object refers.
virtual const std::string &	getConcreteClassName () const =0
	Returns the class name of the concrete %Object-derived class of the actual object referenced by this Object, as a string.
bool	isEqualTo (const Object &aObject) const
	Equality operator wrapper for use from languages not supporting operator overloading.
Object &	operator= (const Object &aObject)
	Copy assignment copies he base class fields, including the properties.
virtual bool	operator== (const Object &aObject) const
	Determine if two objects are equal.
virtual bool	operator< (const Object &aObject) const
	Provide an ordering for objects so they can be put in sorted containers.
void	setName (const std::string &name)
	Set the name of the Object.
const std::string &	getName () const
	Get the name of this Object.
void	setDescription (const std::string &description)
	Set description, a one-liner summary.
const std::string &	getDescription () const
	Get description, a one-liner summary.
const std::string &	getAuthors () const
	Get Authors of this Object.
void	setAuthors (const std::string &authors)
	Set Authors of this object, call this method in your constructor if needed.
const std::string &	getReferences () const
	Get references or publications to cite if using this object.
void	setReferences (const std::string &references)
	Set references or publications to cite if using this object.
int	getNumProperties () const
	Determine how many properties are stored with this Object.
const AbstractProperty &	getPropertyByIndex (int propertyIndex) const
	Get a const reference to a property by its index number, returned as an AbstractProperty.
AbstractProperty &	updPropertyByIndex (int propertyIndex)
	Get a writable reference to a property by its index number, returned as an AbstractProperty.
bool	hasProperty (const std::string &name) const
	Return true if this %Object has a property of any type with the given name, which must not be empty.
const AbstractProperty &	getPropertyByName (const std::string &name) const
	Get a const reference to a property by its name, returned as an AbstractProperty.
AbstractProperty &	updPropertyByName (const std::string &name)
	Get a writable reference to a property by its name, returned as an AbstractProperty.
template<class T >
bool	hasProperty () const
	Return true if this %Object contains an unnamed, one-object property that contains objects of the given template type T.
template<class T >
const Property< T > &	getProperty (const PropertyIndex &index) const
	Get property of known type Property\<T> as a const reference; the property must be present and have the right type.
template<class T >
Property< T > &	updProperty (const PropertyIndex &index)
	Get property of known type Property\<T> as a writable reference; the property must be present and have the right type.
void	setObjectIsUpToDateWithProperties ()
	When an object is initialized using the current values of its properties, it can set a flag indicating that it is up to date.
bool	isObjectUpToDateWithProperties () const
	Returns \c true if any property's value has changed since the last time setObjectIsUpToDateWithProperties() was called.
void	readObjectFromXMLNodeOrFile (SimTK::Xml::Element &objectElement, int versionNumber)
	We're given an XML element from which we are to populate this Object.
virtual void	updateXMLNode (SimTK::Xml::Element &parent)
	Serialize this object into the XML node that represents it.
bool	getInlined () const
	Inlined means an in-memory Object that is not associated with an XMLDocument.
void	setInlined (bool aInlined, const std::string &aFileName="")
	Mark this as inlined or not and optionally provide a file name to associate with the new XMLDocument for the non-inline case.
std::string	getDocumentFileName () const
	If there is a document associated with this object then return the file name maintained by the document.
void	setAllPropertiesUseDefault (bool aUseDefault)
bool	print (const std::string &fileName)
	Write this %Object into an XML file of the given name; conventionally the suffix to use is ".osim".
std::string	dump (bool dumpName=false)
	dump the XML representation of this Object into an std::string and return it.
void	clearObjectIsUpToDateWithProperties ()
	For testing or debugging purposes, manually clear the "object is up to date with respect to properties" flag.
virtual bool	isA (const char *type) const
	The default implementation returns true only if the supplied string is "Object"; each Object-derived class overrides this to match its own class name.
const std::string &	toString () const
	Wrapper to be used on Java side to display objects in tree; this returns just the object's name.
PropertySet &	getPropertySet ()
	OBSOLETE: Get a reference to the PropertySet maintained by the Object.
const PropertySet &	getPropertySet () const

Protected Attributes
PropertyDblArray	_rangeProp
Array< double > &	_range
PropertyStr	_coordinateNameProp
std::string &	_coordinateName
const Coordinate *	_coordinate
Protected Attributes inherited from OpenSim::PathPoint
const Model *	_model
PropertyDblVec3	_locationProp
SimTK::Vec3 &	_location
PropertyStr	_bodyNameProp
std::string &	_bodyName
VisibleObject	_displayer
OpenSim::Body *	_body
GeometryPath *	_path
Protected Attributes inherited from OpenSim::Object
PropertySet	_propertySet
	OBSOLETE: Property_Deprecated set for serializable member variables of this and derived classes.

Additional Inherited Members
Static Public Member Functions inherited from OpenSim::PathPoint
static PathPoint *	makePathPointOfType (PathPoint *aPoint, const std::string &aNewTypeName)
static void	deletePathPoint (PathPoint *aPoint)
Static Public Attributes inherited from OpenSim::Object
static const std::string	DEFAULT_NAME
	Name used for default objects when they are serialized.
Protected Member Functions inherited from OpenSim::Object
	Object ()
	The default constructor is only for use by constructors of derived types.
	Object (const std::string &fileName, bool aUpdateFromXMLNode=true) SWIG_DECLARE_EXCEPTION
	Constructor from a file, to be called from other constructors that take a file as input.
	Object (const Object &source)
	Copy constructor is invoked automatically by derived classes with default copy constructors; otherwise it must be invoked explicitly.
	Object (SimTK::Xml::Element &aElement)
	Construct the base class portion of an %Object from a given Xml element that describes this Object.
template<class T >
PropertyIndex	addProperty (const std::string &name, const std::string &comment, const T &value)
	Define a new single-value property of known type T, with the given name, associated comment, and initial value.
template<class T >
PropertyIndex	addOptionalProperty (const std::string &name, const std::string &comment)
	Add an optional property, meaning it can contain either no value or a single value.
template<class T >
PropertyIndex	addOptionalProperty (const std::string &name, const std::string &comment, const T &value)
	Add an optional property, meaning it can contain either no value or a single value.
template<class T >
PropertyIndex	addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize)
	Define a new list-valued property of known type T, with the given name, associated comment, minimum (==0) and maximum (>0) allowable list lengths, and a zero-length initial value.
template<class T , template< class > class Container>
PropertyIndex	addListProperty (const std::string &name, const std::string &comment, int minSize, int maxSize, const Container< T > &valueList)
	Define a new list-valued property as above, but assigning an initial value via some templatized container class that supports size() and indexing.
PropertyIndex	getPropertyIndex (const std::string &name) const
	Look up a property by name and return its PropertyIndex if it is found.
template<class T >
PropertyIndex	getPropertyIndex () const
	Look up an unnamed property by the type of object it contains, and return its PropertyIndex if it is found.
void	updateFromXMLDocument ()
	Use this method only if you're deserializing from a file and the object is at the top level; that is, primarily in constructors that take a file name as input.
void	setDocument (XMLDocument *doc)
	Unconditionally set the XMLDocument associated with this object.
const XMLDocument *	getDocument () const
	Get a const pointer to the document (if any) associated with this object.
XMLDocument *	updDocument ()
	Get a writable pointer to the document (if any) associated with this object.
Static Protected Attributes inherited from OpenSim::PathPoint
static Geometry *	_defaultGeometry
	A temporary kluge until the default mechanism is working.
Related Functions inherited from OpenSim::Object
#define	OpenSim_DECLARE_CONCRETE_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any non-templatized, concrete class that derives from OpenSim::Object.
#define	OpenSim_DECLARE_ABSTRACT_OBJECT(ConcreteClass, SuperClass)
	Macro to be included as the first line of the class declaration for any still-abstract class that derives from OpenSim::Object.
#define	OpenSim_DECLARE_CONCRETE_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, concrete class that derives from OpenSim::Object, like Set<T>.
#define	OpenSim_DECLARE_ABSTRACT_OBJECT_T(ConcreteClass, TArg, SuperClass)
	Macro to be included as the first line of the class declaration for any templatized, still-abstract class that derives from OpenSim::Object.

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

OpenSim::ConditionalPathPoint::ConditionalPathPoint

(

)

OpenSim::ConditionalPathPoint::ConditionalPathPoint

(

const ConditionalPathPoint &

aPoint

)

virtual OpenSim::ConditionalPathPoint::~ConditionalPathPoint ( )

virtual

Member Function Documentation

void OpenSim::ConditionalPathPoint::connectToModelAndPath ( const Model &  aModel, GeometryPath &  aPath  )

overridevirtual

Reimplemented from OpenSim::PathPoint.

void OpenSim::ConditionalPathPoint::copyData

(

const ConditionalPathPoint &

aPoint

)

const Coordinate* OpenSim::ConditionalPathPoint::getCoordinate ( ) const

inline

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

inline

Array<double>& OpenSim::ConditionalPathPoint::getRange ( ) const

inline

virtual void OpenSim::ConditionalPathPoint::init ( const PathPoint &  aPoint )

virtual

Reimplemented from OpenSim::PathPoint.

bool OpenSim::ConditionalPathPoint::isActive ( const SimTK::State &  s ) const

overridevirtual

Reimplemented from OpenSim::PathPoint.

ConditionalPathPoint& OpenSim::ConditionalPathPoint::operator=

(

const ConditionalPathPoint &

aPoint

)

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

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

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

virtual void OpenSim::ConditionalPathPoint::updateFromXMLNode ( SimTK::Xml::Element &  objectElement, int  versionNumber = -1  )

virtual

Use this method to deserialize an object from a SimTK::Xml::Element.

The element is assumed to be in the format consistent with the passed-in versionNumber. If there is a file attribute in objectElement it will be ignored; if you want it processed you should call readObjectFromXMLNodeOrFile() instead.

Reimplemented from OpenSim::Object.

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 file:

• E:/Projects/OpenSim30Br/OpenSim30/OpenSim/Simulation/Model/ConditionalPathPoint.h