guWhiteboard::FSMState Class Reference

Class for transmitting machine names over the whiteboard. More...

#include <FSMControlStatus.hpp>

Inheritance diagram for guWhiteboard::FSMState:

Collaboration diagram for guWhiteboard::FSMState:

Public Member Functions
	FSMState ()
	designated constructor More...
	FSMState (const FSMState &other)
	copy constructor More...
const FSMState &	operator= (const FSMState &other)
	assignment operator More...
uint8_t	getStateForMachineID (uint8_t machineID)
	names getter More...
void	setStateForMachineID (uint8_t machineID, uint8_t state)
	Record the given state for the given Machine ID. More...
void	reset ()
	Reset all machines to INVALIDMACHINE. More...
	FSMState (std::string states)
	string constructor More...
std::string	description ()
	convert to a string More...
void	from_string (const std::string &states)
	convert from a string More...
Public Member Functions inherited from wb_fsm_state_status
	ARRAY_PROPERTY (uint8_t, fsms,(sizeof(gu_simple_message))) wb_fsm_state_status()
	Data structure for Machine status. More...

Detailed Description

Class for transmitting machine names over the whiteboard.

Definition at line 251 of file FSMControlStatus.hpp.

Constructor & Destructor Documentation

FSMState() [1/3]

guWhiteboard::FSMState::FSMState ( )

inline

designated constructor

Definition at line 256 of file FSMControlStatus.hpp.

FSMState() [2/3]

guWhiteboard::FSMState::FSMState ( const FSMState &  other )

inline

copy constructor

Definition at line 259 of file FSMControlStatus.hpp.

FSMState() [3/3]

guWhiteboard::FSMState::FSMState ( std::string  states )

inline

string constructor

Definition at line 290 of file FSMControlStatus.hpp.

References from_string().

Member Function Documentation

description()

std::string guWhiteboard::FSMState::description ( )

inline

convert to a string

Definition at line 293 of file FSMControlStatus.hpp.

References INVALIDMACHINE, STATE_BYTE_SIZE, and STATESTATUS_GET_STATE.

from_string()

void guWhiteboard::FSMState::from_string ( const std::string &  states )

inline

convert from a string

Definition at line 311 of file FSMControlStatus.hpp.

References STATE_BYTE_SIZE, and STATESTATUS_SET_STATE.

Referenced by FSMState().

getStateForMachineID()

uint8_t guWhiteboard::FSMState::getStateForMachineID ( uint8_t  machineID )

inline

names getter

Definition at line 265 of file FSMControlStatus.hpp.

References INVALIDMACHINE, STATE_BYTE_SIZE, and STATESTATUS_GET_STATE.

operator=()

const FSMState & guWhiteboard::FSMState::operator= ( const FSMState &  other )

inline

assignment operator

Definition at line 262 of file FSMControlStatus.hpp.

reset()

void guWhiteboard::FSMState::reset ( )

inline

Reset all machines to INVALIDMACHINE.

Definition at line 286 of file FSMControlStatus.hpp.

References INVALIDMACHINE.

setStateForMachineID()

void guWhiteboard::FSMState::setStateForMachineID ( uint8_t  machineID, uint8_t  state  )

inline

Record the given state for the given Machine ID.

Parameters

machineID	Machine to record the state number for
state	State number for the machine

Definition at line 279 of file FSMControlStatus.hpp.

References STATE_BYTE_SIZE, and STATESTATUS_SET_STATE.

---

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

• typeClassDefs/FSMControlStatus.hpp