mcx::state_machine

  2 minute read  

mcx::state_machine

Classes

Name
class mcx::state_machine::ErrorHandle
class mcx::state_machine::ErrorHandleBase
class mcx::state_machine::ErrorPublisher
struct mcx::state_machine::DR
struct mcx::state_machine::DR< R & >
struct mcx::state_machine::DR< const R & >
class mcx::state_machine::Event
class mcx::state_machine::_Event0
class mcx::state_machine::_Event1
class mcx::state_machine::_Event2
class mcx::state_machine::_Event3
class mcx::state_machine::EventBase
class mcx::state_machine::Event0
class mcx::state_machine::Event1
class mcx::state_machine::Event2
class mcx::state_machine::Event3
struct mcx::state_machine::id_caller
class mcx::state_machine::StateMachine
States machine manager and event interpreter.
class mcx::state_machine::State

Types

Name
enum EventPriority { HIGH_PRIORITY_EVENT = 0, LOW_PRIORITY_EVENT = 1}
enum EventStatus { EVENT_NONE = -1, EVENT_DONE = 0, EVENT_DELAY = 1, EVENT_REPEAT = 2, EVENT_TERMINATE = 3, EVENT_REPEAT_NO_TERMINATE = 4}
using signal_monitor::SignalId Error
using signal_monitor::SignalIdGroup ErrorGroup
using signal_monitor::TriggerType TriggerType
using motorcortex_Error MotorcortexError
using motorcortex_ErrorList MotorcortexErrorList
using motorcortex_ErrorLevel MotorcortexErrorLevel

Functions

Name
size_t encodeErrorMsg(const MotorcortexErrorList & error_list, uint8_t * error_list_msg, size_t size)
MotorcortexError createError(const Error & error, motorcortex_ErrorLevel error_level, uint64_t timestamp)
void printError(const std::string & name, const MotorcortexError & error)

Attributes

Name
constexpr auto MAX_NUM_OF_ERRORS
constexpr auto EVENT_DEFAULT_TIMEOUT_SEC
constexpr auto MAX_NUMBER_OF_STATES
constexpr auto DEFAULT_TERMINATE_EVENT

Types Documentation

enum EventPriority

Enumerator Value Description
HIGH_PRIORITY_EVENT 0
LOW_PRIORITY_EVENT 1

enum EventStatus

Enumerator Value Description
EVENT_NONE -1
EVENT_DONE 0
EVENT_DELAY 1
EVENT_REPEAT 2
EVENT_TERMINATE 3
EVENT_REPEAT_NO_TERMINATE 4

using Error

using mcx::state_machine::Error = typedef signal_monitor::SignalId;

using ErrorGroup

using mcx::state_machine::ErrorGroup = typedef signal_monitor::SignalIdGroup;

using TriggerType

using mcx::state_machine::TriggerType = typedef signal_monitor::TriggerType;

using MotorcortexError

using mcx::state_machine::MotorcortexError = typedef motorcortex_Error;

using MotorcortexErrorList

using mcx::state_machine::MotorcortexErrorList = typedef motorcortex_ErrorList;

using MotorcortexErrorLevel

using mcx::state_machine::MotorcortexErrorLevel = typedef motorcortex_ErrorLevel;

Functions Documentation

function encodeErrorMsg

size_t encodeErrorMsg(
    const MotorcortexErrorList & error_list,
    uint8_t * error_list_msg,
    size_t size
)

function createError

MotorcortexError createError(
    const Error & error,
    motorcortex_ErrorLevel error_level,
    uint64_t timestamp
)

function printError

void printError(
    const std::string & name,
    const MotorcortexError & error
)

Attributes Documentation

variable MAX_NUM_OF_ERRORS

constexpr auto MAX_NUM_OF_ERRORS = sizeof(MotorcortexErrorList::errors) / sizeof(MotorcortexErrorList::errors[0]);

variable EVENT_DEFAULT_TIMEOUT_SEC

constexpr auto EVENT_DEFAULT_TIMEOUT_SEC = std::numeric_limits<double>::max();

variable MAX_NUMBER_OF_STATES

constexpr auto MAX_NUMBER_OF_STATES = 100;

variable DEFAULT_TERMINATE_EVENT

constexpr auto DEFAULT_TERMINATE_EVENT = nullptr;

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