mcx::state_machine::Event

mcx::state_machine::Event

More…

Inherited by mcx::state_machine::_Event0< STATE >, mcx::state_machine::_Event1< STATE, P1 >, mcx::state_machine::_Event2< STATE, P1, P2 >, mcx::state_machine::_Event3< STATE, P1, P2, P3 >

Public Functions

Name
Event()
virtual ~Event() =default
virtual EventStatus dispatchEvent(STATE * state) =0
void setTerminateFunc(Signature term_func)
const Signature & getTerminateFunc()
void setExecutedOnceFlag(bool once_executed_flag)
bool getExecutedOnceFlag()
void setTimeoutSec(double timeout_sec)
double getTimeoutSec()
virtual bool compare(const Event * cmp)

Protected Attributes

Name
bool onceExecutedFlag_
double timeoutSec_
Signature termFunc_

Detailed Description

template <class STATE >
class mcx::state_machine::Event;

Public Functions Documentation

function Event

inline Event()

function ~Event

virtual ~Event() =default

function dispatchEvent

virtual EventStatus dispatchEvent(
    STATE * state
) =0

Reimplemented by: mcx::state_machine::_Event0::dispatchEvent, mcx::state_machine::_Event1::dispatchEvent, mcx::state_machine::_Event2::dispatchEvent, mcx::state_machine::_Event3::dispatchEvent

function setTerminateFunc

inline void setTerminateFunc(
    Signature term_func
)

function getTerminateFunc

inline const Signature & getTerminateFunc()

function setExecutedOnceFlag

inline void setExecutedOnceFlag(
    bool once_executed_flag
)

function getExecutedOnceFlag

inline bool getExecutedOnceFlag()

function setTimeoutSec

inline void setTimeoutSec(
    double timeout_sec
)

function getTimeoutSec

inline double getTimeoutSec()

function compare

inline virtual bool compare(
    const Event * cmp
)

Reimplemented by: mcx::state_machine::_Event0::compare, mcx::state_machine::_Event1::compare, mcx::state_machine::_Event2::compare, mcx::state_machine::_Event3::compare

Protected Attributes Documentation

variable onceExecutedFlag_

bool onceExecutedFlag_;

variable timeoutSec_

double timeoutSec_;

variable termFunc_

Signature termFunc_;

Updated on 2022-04-05 at 16:21:27 +0200