NTRT Simulator  Version: Master
 All Classes Namespaces Files Functions Variables Typedefs Friends Pages
VerticalSpineBendingController Class Reference

#include <VerticalSpineBendingController.h>

Inheritance diagram for VerticalSpineBendingController:
Collaboration diagram for VerticalSpineBendingController:

Public Member Functions

 VerticalSpineBendingController ()
 
virtual ~VerticalSpineBendingController ()
 
virtual void onSetup (VerticalSpineModel &subject)
 
virtual void onStep (VerticalSpineModel &subject, double dt)
 
virtual void onAttach (VerticalSpineModel &subject)
 
virtual void onTeardown (VerticalSpineModel &subject)
 
void attach (tgObserver< VerticalSpineBendingController > *pObserver)
 
void notifyStep (double dt)
 
void notifySetup ()
 
void notifyTeardown ()
 

Detailed Description

A controller to apply uniform rest length offset to all cables in a SpineModel. Does a one-time adjust of all cable rest lengths, thereby tightening up the structure and keeping it held together without further control input.

Definition at line 47 of file VerticalSpineBendingController.h.

Constructor & Destructor Documentation

VerticalSpineBendingController::VerticalSpineBendingController ( )

Construct a VerticalSpineRestLengthController.

Parameters
[in]restLengthDiff,theamount of cable retraction to enact. This length will be subtracted from the geometric length of each cable in the structure.

Definition at line 42 of file VerticalSpineBendingController.cpp.

virtual VerticalSpineBendingController::~VerticalSpineBendingController ( )
inlinevirtual

Nothing to delete, destructor must be virtual

Definition at line 64 of file VerticalSpineBendingController.h.

Member Function Documentation

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
void tgSubject< VerticalSpineBendingController >::notifySetup ( )
inherited

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

void tgSubject< VerticalSpineBendingController >::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

Here is the caller graph for this function:

void tgSubject< VerticalSpineBendingController >::notifyTeardown ( )
inherited

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

virtual void tgObserver< VerticalSpineModel >::onAttach ( VerticalSpineModel subject)
inlinevirtualinherited

Notify the observers when an attach action has occurred. Will only occur once, typically before setup

Parameters
[in,out]subjectthe subject being observed

Definition at line 55 of file tgObserver.h.

void VerticalSpineBendingController::onSetup ( VerticalSpineModel subject)
virtual

Apply the Bending controller. On setup, adjust the cable lengths one time.

Parameters
[in]subject- the SpineModel that is being controlled. Must have a list of allMuscles populated

Reimplemented from tgObserver< VerticalSpineModel >.

Definition at line 65 of file VerticalSpineBendingController.cpp.

Here is the call graph for this function:

void VerticalSpineBendingController::onStep ( VerticalSpineModel subject,
double  dt 
)
virtual

The onStep method is not used for this controller.

Parameters
[in]subject- the SpineModel that is being controlled. Must have a list of allMuscles populated
[in]dt,currenttimestep must be positive

Implements tgObserver< VerticalSpineModel >.

Definition at line 72 of file VerticalSpineBendingController.cpp.

virtual void tgObserver< VerticalSpineModel >::onTeardown ( VerticalSpineModel subject)
inlinevirtualinherited

Notify the observers when a teardown action has occurred.

Parameters
[in,out]subjectthe subject being observed

Definition at line 67 of file tgObserver.h.


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