Public Member Functions | Public Attributes | List of all members
gazebo::ElevatorPluginPrivate::MoveState Class Reference

State used to move the elevator to a floor. More...

#include <ElevatorPluginPrivate.hh>

Inheritance diagram for gazebo::ElevatorPluginPrivate::MoveState:
Inheritance graph
[legend]

Public Member Functions

 MoveState (int _floor, LiftController *_ctrl)
 Constructor. More...
 
virtual void Start ()
 Used to start a state. More...
 
virtual bool Update ()
 Used to update a state. More...
 
- Public Member Functions inherited from gazebo::ElevatorPluginPrivate::State
 State ()
 Constructor. More...
 
virtual ~State ()=default
 Destructor. More...
 

Public Attributes

LiftControllerctrl
 Lift controller. More...
 
int floor
 Target floor number. More...
 
- Public Attributes inherited from gazebo::ElevatorPluginPrivate::State
std::string name
 State name. More...
 

Additional Inherited Members

- Protected Attributes inherited from gazebo::ElevatorPluginPrivate::State
bool started
 True when started. More...
 

Detailed Description

State used to move the elevator to a floor.

Constructor & Destructor Documentation

gazebo::ElevatorPluginPrivate::MoveState::MoveState ( int  _floor,
LiftController _ctrl 
)

Constructor.

Parameters
[in]_floorFloor index to move to.
[in]_ctrlLift controller pointer.

Member Function Documentation

virtual void gazebo::ElevatorPluginPrivate::MoveState::Start ( )
virtual

Used to start a state.

Reimplemented from gazebo::ElevatorPluginPrivate::State.

virtual bool gazebo::ElevatorPluginPrivate::MoveState::Update ( )
virtual

Used to update a state.

Reimplemented from gazebo::ElevatorPluginPrivate::State.

Member Data Documentation

LiftController* gazebo::ElevatorPluginPrivate::MoveState::ctrl

Lift controller.

int gazebo::ElevatorPluginPrivate::MoveState::floor

Target floor number.


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