Inheritance diagram for BuildTestModel:

Collaboration diagram for BuildTestModel:

Public Member Functions
	BuildTestModel (std::string name)

virtual void	setup (tgWorld &world)

virtual void	step (double dt)

virtual void	onVisit (const tgModelVisitor &r) const

void	changeMuscle (double length)

void	attach (tgObserver< BuildTestModel > *pObserver)

void	notifyStep (double dt)

void	notifySetup ()

void	notifyTeardown ()

virtual void	teardown ()

void	addChild (tgModel *pChild)

virtual std::string	toString (std::string prefix="") const

template<typename T >
std::vector< T * >	find (const tgTagSearch &tagSearch)

template<typename T >
std::vector< T * >	find (const std::string &tagSearch)

std::vector< tgModel * >	getDescendants () const

const std::vector < abstractMarker > &	getMarkers () const

void	addMarker (abstractMarker a)

void	addTags (const std::string &space_separated_tags)

void	addTags (const tgTags &tags)

bool	hasTag (const std::string tag) const

bool	hasAllTags (std::string tags)

bool	hasAnyTags (const std::string tags)

bool	hasNoTags ()

tgTags &	getTags ()

const tgTags &	getTags () const

void	setTags (tgTags tags)

std::string	getTagStr (std::string delim=" ") const

Detailed Description

Definition at line 37 of file BuildTestModel.h.

Member Function Documentation

void tgModel::addChild ( tgModel * pChild )

inherited

Add a sub-model to this model. The model takes ownership of the child sub-model and is responsible for deallocating it.

Parameters

[in,out] pChild a pointer to a sub-model

Exceptions

std::invalid_argument is pChild is NULL, this object, or already a descendant

Todo:: Make sure that every child appears no more than once in the tree.

Definition at line 124 of file tgModel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void tgSubject< BuildTestModel >::attach ( tgObserver< BuildTestModel > * pObserver )

inherited

Attach an observer to the subject of the observer.

Parameters

[in,out] pObserver a pointer to an observer for the subject; do nothing if the pointer is NULL

template<typename T >

std::vector<T*> tgModel::find ( const tgTagSearch & tagSearch )

inlineinherited

Get a vector of descendants sorted by type and a tagsearch. Useful for pulling out muscle groups, or similar.

Parameters

[in] tagSearch,a tagSearch that contains the desired tags

Returns: a std::vector of pointers to members that match the tag search and typename T

Definition at line 125 of file tgModel.h.

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

std::vector<T*> tgModel::find ( const std::string & tagSearch )

inlineinherited

Get a vector of descendants sorted by type and a tagsearch. Useful for pulling out muscle groups, or similar.

Parameters

[in] tagSearch,a std::string& that contains the desired tags

Returns: a std::vector of pointers to members that match the tag search and typename T

Definition at line 138 of file tgModel.h.

Here is the call graph for this function:

std::vector< tgModel * > tgModel::getDescendants ( ) const

inherited

Return a std::vector of const pointers to all sub-models.

Todo:

examine whether this should be public, and perhaps create a read only version

Returns: a std::vector of const pointers all sub-models.

Todo:: Unnecessary copying can be avoided by pasing the result collection in the recursive step.

Definition at line 172 of file tgModel.cpp.

Here is the call graph for this function:

void tgSubject< BuildTestModel >::notifySetup ( )

inherited

Call tgObserver<T>::onSetup() on all observers in the order in which they were attached.

void tgSubject< BuildTestModel >::notifyStep ( double dt )

inherited

Call tgObserver<T>::onStep() on all observers in the order in which they were attached.

Parameters

[in] dt the number of seconds since the previous call; do nothing if not positive

Here is the caller graph for this function:

void tgSubject< BuildTestModel >::notifyTeardown ( )

inherited

Call tgObserver<T>::onTeardown() on all observers in the order in which they were attached.

virtual void BuildTestModel::onVisit ( const tgModelVisitor & r ) const

inlinevirtual

Call tgModelVisitor::render() on self and all descendants.

Parameters

[in,out] r a reference to a tgModelVisitor

Reimplemented from tgModel.

Definition at line 150 of file BuildTestModel.h.

virtual void BuildTestModel::setup ( tgWorld & world )

inlinevirtual

Setup takes a tgWorld and passes it to any children for their own setup functions. All subclasses should call this at the appropriate time (usually end of setup) within their own setup function.

Parameters

[in] world - the tgWorld the models will exist in.

Reimplemented from tgModel.

Definition at line 50 of file BuildTestModel.h.

Here is the call graph for this function:

virtual void BuildTestModel::step ( double dt )

inlinevirtual

Advance the simulation.

Parameters

[in] dt the number of seconds since the previous call; std::invalid_argument is thrown if dt is not positive

Exceptions

std::invalid_argument if dt is not positive

Note: This is not necessarily const for every child.

Reimplemented from tgModel.

Definition at line 138 of file BuildTestModel.h.

Here is the call graph for this function:

void tgModel::teardown ( )

virtualinherited

Deletes the children (undoes setup)

Reimplemented in tgSpringCableActuator, ContactTestModel, tgKinematicActuator, tgSphere, tgBox, tgRod, tgCraterDeep, Wall, CraterDeep, tgCraterShallow, Crater, T6Model, pidTestRig, PrismModel, SuperBallModel, MuscleNPCons, tsTestRig, PrismModel, tgPrismatic, T6Model, T12SuperBallPayload, CaterpillarModel, T6SphereModel, T6Model, T6Model, Escape_T6Model, EscapeModel, T6Model, hillyMuscleNP, simpleMuscleNP, tgBasicActuator, TetraSpineStaticModel_hf, BaseSpineModelLearning, tgGhostModel, TetraSpineCollisions, tgBaseRigid, TetraSpineStaticModel, TetraSpineLearningModel, FlemonsSpineModelContact, FlemonsSpineModelLearningCL, FlemonsSpineModelLearning, and RibModel.

Definition at line 68 of file tgModel.cpp.

std::string tgModel::toString ( std::string prefix = "" ) const

virtualinherited

Returns the tag names of this model and its children

Parameters

[in] prefix a string to append to

Returns: the original string with this model and its children's tags appended

Definition at line 154 of file tgModel.cpp.

Here is the caller graph for this function:

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

dev/tests/BuildTestModel.h

Public Member Functions

Detailed Description

Member Function Documentation