Inheritance diagram for VerticalSpineModel:

Collaboration diagram for VerticalSpineModel:

Public Types
typedef std::map< std::string, std::vector< tgBasicActuator * > >	MuscleMap

Public Member Functions
	VerticalSpineModel (size_t segments)

virtual	~VerticalSpineModel ()

virtual void	setup (tgWorld &world)

virtual void	step (const double dt)

const std::vector < tgBasicActuator * > &	getMuscles (const std::string &key) const

const std::vector < tgBasicActuator * > &	getAllMuscles () const

size_t	getSegments () const

void	attach (tgObserver< VerticalSpineModel > *pObserver)

void	notifyStep (double dt)

void	notifySetup ()

void	notifyTeardown ()

virtual void	teardown ()

virtual void	onVisit (const tgModelVisitor &r) const

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 43 of file VerticalSpineModel.h.

Member Typedef Documentation

typedef std::map<std::string, std::vector<tgBasicActuator*> > VerticalSpineModel::MuscleMap

Used within this function to map segments to string keys

Definition at line 50 of file VerticalSpineModel.h.

Constructor & Destructor Documentation

VerticalSpineModel::VerticalSpineModel ( size_t segments )

The only constructor. The model details are instantiated once setup is called typically when the model is added to a simulation.

Parameters

[in] segments,a positive integer dictating how many rigid segments will be constructed.

Definition at line 47 of file VerticalSpineModel.cpp.

virtual VerticalSpineModel::~VerticalSpineModel ( )

inlinevirtual

Nothing to do. Most functions already handled by tgModel::teardown

Definition at line 63 of file VerticalSpineModel.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< VerticalSpineModel >::attach ( tgObserver< VerticalSpineModel > * 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:

const std::vector< tgBasicActuator * > & VerticalSpineModel::getMuscles ( const std::string & key ) const

Get a group of muscles according to the provided key. Groups are populated during setup.

Parameters

[in] key - a std:string* used as a key to a std::map from a string to a vector of muscles

Returns: a std::vector of pointers to the muscles found by the key

Definition at line 285 of file VerticalSpineModel.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

size_t VerticalSpineModel::getSegments ( ) const

inline

Return a std::size_t indicating the number of segments in the tetraSpine.

Returns: a std::size_t with the value of m_segments

Definition at line 98 of file VerticalSpineModel.h.

void tgSubject< VerticalSpineModel >::notifySetup ( )

inherited

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

void tgSubject< VerticalSpineModel >::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< VerticalSpineModel >::notifyTeardown ( )

inherited

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

void tgModel::onVisit ( const tgModelVisitor & r ) const

virtualinherited

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

Parameters

[in,out] r a reference to a tgModelVisitor

Reimplemented in ConnectorTestModel, BuildTestModel, tgKinematicActuator, tgSphere, tgBox, tgRod, MuscleNPCons, tgBasicActuator, hillyMuscleNP, simpleMuscleNP, tgBaseRigid, and tgGhostModel.

Definition at line 107 of file tgModel.cpp.

Here is the call graph for this function:

void VerticalSpineModel::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 196 of file VerticalSpineModel.cpp.

void VerticalSpineModel::step ( const double dt )

virtual

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

Parameters

[in] dt,the timestep. Must be positive.

Reimplemented from tgModel.

Definition at line 269 of file VerticalSpineModel.cpp.

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

dev/SpineHardwareProject/VerticalSpine/VerticalSpineModel.h
dev/SpineHardwareProject/VerticalSpine/VerticalSpineModel.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation