rokubimini::fsm Namespace Reference

Enumerations
enum	StateEnum {   StateEnum::CALIBRATE, StateEnum::DEVICE_MISSING, StateEnum::ERROR, StateEnum::FATAL,   StateEnum::OPERATIONAL, StateEnum::NA, StateEnum::STANDBY }

Functions
std::ostream &	operator<< (std::ostream &out, const StateEnum stateEnum)
	Outputs the name of the state enumeration to an output stream. More...
uint16_t	stateEnumToId (const StateEnum stateEnum)
	Gets an ID matching the state enumeration. More...
std::string	stateEnumToName (const StateEnum stateEnum)
	Gets a name matching the state enumeration. More...
StateEnum	stateIdToEnum (uint16_t stateId)
	Gets a state enumeration matching the state ID. More...
StateEnum	stateNameToEnum (const std::string &string)
	Gets a state enumeration matching the state name. More...
	TEST (StateEnumTest, StateEnumToIdWorksCorrectly)
	TEST (StateEnumTest, StateIdToEnumWorksCorrectly)
	TEST (StateEnumTest, StateEnumToNameWorksCorrectly)
	TEST (StateEnumTest, StateNameToEnumWorksCorrectly)

Enumeration Type Documentation

enum rokubimini::fsm::StateEnum

strong

Enumerator
CALIBRATE
DEVICE_MISSING
ERROR
FATAL
OPERATIONAL
NA
STANDBY

Definition at line 36 of file StateEnum.hpp.

Function Documentation

std::ostream & rokubimini::fsm::operator<<	(	std::ostream &	out,
		const StateEnum	stateEnum
	)

Outputs the name of the state enumeration to an output stream.

Parameters

out	The output stream.
stateEnum	The state enumeration.

Returns

The output stream with the state enumeration streamed to it.

Definition at line 132 of file StateEnum.cpp.

uint16_t rokubimini::fsm::stateEnumToId

(

const StateEnum

stateEnum

)

Gets an ID matching the state enumeration.

Parameters

stateEnum

The state enumeration.

Returns

The ID matching the state enumeration.

Definition at line 16 of file StateEnum.cpp.

std::string rokubimini::fsm::stateEnumToName

(

const StateEnum

stateEnum

)

Gets a name matching the state enumeration.

Parameters

stateEnum

The state enumeration.

Returns

The name matching the state enumeration.

Definition at line 74 of file StateEnum.cpp.

StateEnum rokubimini::fsm::stateIdToEnum

(

uint16_t

stateId

)

Gets a state enumeration matching the state ID.

Parameters

stateId

The state ID.

Returns

The state enumeration matching the state ID.

Definition at line 45 of file StateEnum.cpp.

StateEnum rokubimini::fsm::stateNameToEnum

(

const std::string &

string

)

Gets a state enumeration matching the state name.

Parameters

string

The state name.

Returns

The state enumeration matching the state name.

Definition at line 103 of file StateEnum.cpp.

rokubimini::fsm::TEST	(	StateEnumTest	,
		StateEnumToIdWorksCorrectly
	)

Definition at line 15 of file TestStateEnum.cpp.

rokubimini::fsm::TEST	(	StateEnumTest	,
		StateIdToEnumWorksCorrectly
	)

Definition at line 26 of file TestStateEnum.cpp.

rokubimini::fsm::TEST	(	StateEnumTest	,
		StateEnumToNameWorksCorrectly
	)

Definition at line 37 of file TestStateEnum.cpp.

rokubimini::fsm::TEST	(	StateEnumTest	,
		StateNameToEnumWorksCorrectly
	)

Definition at line 47 of file TestStateEnum.cpp.