NTRT Simulator  v1.1
 All Classes Namespaces Files Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
hillyMuscleNP Class Reference

#include <hillyMuscleNP.h>

Inheritance diagram for hillyMuscleNP:
Inheritance graph
[legend]
Collaboration diagram for hillyMuscleNP:
Collaboration graph
[legend]

Public Member Functions

 hillyMuscleNP ()
 
virtual ~hillyMuscleNP ()
 
virtual void setup (tgWorld &world)
 
virtual void teardown ()
 
virtual void step (double dt)
 
virtual void onVisit (const tgModelVisitor &r) const
 
void attach (tgObserver< hillyMuscleNP > *pObserver)
 
void notifyStep (double dt)
 
void notifySetup ()
 
void notifyTeardown ()
 
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

A class that constructs a three bar tensegrity prism using the tools in tgcreator.

Definition at line 46 of file hillyMuscleNP.h.

Constructor & Destructor Documentation

hillyMuscleNP::hillyMuscleNP ( )

The only constructor. Configuration parameters are within the .cpp file in this case, not passed in.

Definition at line 33 of file hillyMuscleNP.cpp.

hillyMuscleNP::~hillyMuscleNP ( )
virtual

Destructor. Deletes controllers, if any were added during setup. Teardown handles everything else.

Definition at line 37 of file hillyMuscleNP.cpp.

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]pChilda pointer to a sub-model
Exceptions
std::invalid_argumentis 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< hillyMuscleNP >::attach ( tgObserver< hillyMuscleNP > *  pObserver)
inherited

Attach an observer to the subject of the observer.

Parameters
[in,out]pObservera 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,atagSearch 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,astd::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< hillyMuscleNP >::notifySetup ( )
inherited

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

Here is the caller graph for this function:

void tgSubject< hillyMuscleNP >::notifyStep ( double  dt)
inherited

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

Parameters
[in]dtthe number of seconds since the previous call; do nothing if not positive
void tgSubject< hillyMuscleNP >::notifyTeardown ( )
inherited

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

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

Receives a tgModelVisitor and dispatches itself into the visitor's "render" function. This model will go to the default tgModel function, which does nothing.

Parameters
[in]r- a tgModelVisitor which will pass this model back to itself

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

Parameters
[in,out]ra reference to a tgModelVisitor

Reimplemented from tgModel.

Definition at line 142 of file hillyMuscleNP.cpp.

Here is the call graph for this function:

void hillyMuscleNP::setup ( tgWorld &  world)
virtual

Create the model. Place the rods and strings into the world that is passed into the simulation. This is triggered automatically when the model is added to the simulation, when tgModel::setup(world) is called (if this model is a child), and when reset is called. Also notifies controllers of setup.

Parameters
[in]world- the world we're building into

Reimplemented from tgModel.

Definition at line 41 of file hillyMuscleNP.cpp.

void hillyMuscleNP::step ( double  dt)
virtual

Step the model, its children. Notifies controllers of step.

Parameters
[in]dt,thetimestep. Must be positive.

Reimplemented from tgModel.

Definition at line 117 of file hillyMuscleNP.cpp.

void hillyMuscleNP::teardown ( )
virtual

Undoes setup. Deletes child models. Called automatically on reset and end of simulation. Notifies controllers of teardown

Reimplemented from tgModel.

Definition at line 112 of file hillyMuscleNP.cpp.

Here is the call graph for this function:

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

Returns the tag names of this model and its children

Parameters
[in]prefixa 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 files: