StateMachine< System, IDType, Message, delay_ms, do_log >::MaybeMessage Class Reference

MaybeMessage a message of Message type or nothing MaybeMessage m = {}; // empty MaybeMessage m = Message::EnumField1. More...

#include <state_machine.h>

Public Member Functions
	MaybeMessage ()
	Empty message - when theres no message.
	MaybeMessage (Message msg)
	Create a maybemessage with a message.
bool	has_message ()
	check if the message is here
Message	message ()
	Get the message stored. The return value is invalid unless has_message returned true.

Detailed Description

template<typename System, typename IDType, typename Message, int32_t delay_ms, bool do_log = false>
class StateMachine< System, IDType, Message, delay_ms, do_log >::MaybeMessage

MaybeMessage a message of Message type or nothing MaybeMessage m = {}; // empty MaybeMessage m = Message::EnumField1.

Constructor & Destructor Documentation

MaybeMessage()

template<typename System, typename IDType, typename Message, int32_t delay_ms, bool do_log = false>

StateMachine< System, IDType, Message, delay_ms, do_log >::MaybeMessage::MaybeMessage ( Message msg )

inline

Create a maybemessage with a message.

Parameters

msg	the message to hold on to

Member Function Documentation

has_message()

template<typename System, typename IDType, typename Message, int32_t delay_ms, bool do_log = false>

bool StateMachine< System, IDType, Message, delay_ms, do_log >::MaybeMessage::has_message ( )

inline

check if the message is here

Returns

true if there is a message

message()

template<typename System, typename IDType, typename Message, int32_t delay_ms, bool do_log = false>

Message StateMachine< System, IDType, Message, delay_ms, do_log >::MaybeMessage::message ( )

inline

Get the message stored. The return value is invalid unless has_message returned true.

Returns

The message if it exists. Undefined otherwise

---

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

• state_machine.h