Alex exoskeleton
ALEX SoftwareDocumentation
Public Member Functions | Protected Attributes | List of all members
ExoTestState Class Referenceabstract

Example Implementation of State Class. Used with ExoTestMachine. More...

#include <ExoTestState.h>

Inheritance diagram for ExoTestState:
Inheritance graph
Collaboration diagram for ExoTestState:
Collaboration graph

Public Member Functions

virtual void entry ()=0
 Called once when the state is entered. Pure virtual function, must be overwritten by each state. More...
 
virtual void during ()=0
 Called continuously whilst in that state. Pure virtual function, must be overwritten by each state. More...
 
virtual void exit ()=0
 Called once when the state exits. Pure virtual function, must be overwritten by each state. More...
 
 ExoTestState (StateMachine *m, ExoRobot *exo, DummyTrajectoryGenerator *tg, const char *name=NULL)
 
- Public Member Functions inherited from State
 State (StateMachine *p, const char n[]=NULL)
 Construct a new State object. More...
 
 ~State ()
 
bool addArc (Transition *t)
 
Transition * getActiveArc (void)
 
const char * getName (void)
 Returns the name of the state - Note that this. More...
 
void printName (void)
 Prints the name of the state. More...
 

Protected Attributes

ExoRobot * robot
 
DummyTrajectoryGenerator * trajectoryGenerator
 

Additional Inherited Members

- Public Attributes inherited from State
StateMachine * owner
 Pointer to the owning state machine. More...
 

Detailed Description

Example Implementation of State Class. Used with ExoTestMachine.

/file ExoTestState.h /author Justin Fong /brief Virtual Class to include all required classes for ExoTestStates /version 0.1 /date 2020-05-07

Copyright
Copyright (c) 2020 Note: This is used to ensure that all states here have an ExoRobot, and a DummyTrajectoryGenerator (as opposed to more generic Robot and TrajectoryGenerator)

Definition at line 30 of file ExoTestState.h.

Constructor & Destructor Documentation

ExoTestState::ExoTestState ( StateMachine *  m,
ExoRobot *  exo,
DummyTrajectoryGenerator *  tg,
const char *  name = NULL 
)

Definition at line 3 of file ExoTestState.cpp.

Member Function Documentation

virtual void ExoTestState::during ( )
pure virtual

Called continuously whilst in that state. Pure virtual function, must be overwritten by each state.

Implements State.

Implemented in Sitting, InitState, Standing, StandingUp, and SittingDwn.

virtual void ExoTestState::entry ( )
pure virtual

Called once when the state is entered. Pure virtual function, must be overwritten by each state.

Implements State.

Implemented in Sitting, InitState, Standing, StandingUp, and SittingDwn.

virtual void ExoTestState::exit ( )
pure virtual

Called once when the state exits. Pure virtual function, must be overwritten by each state.

Implements State.

Implemented in Sitting, InitState, Standing, StandingUp, and SittingDwn.

Member Data Documentation

ExoRobot* ExoTestState::robot
protected

Definition at line 33 of file ExoTestState.h.

DummyTrajectoryGenerator* ExoTestState::trajectoryGenerator
protected

Definition at line 34 of file ExoTestState.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11