MagAOX::logger::state_change Struct Reference

Application State Change. More...

#include <state_change.hpp>

Inheritance diagram for MagAOX::logger::state_change:

Collaboration diagram for MagAOX::logger::state_change:

Classes
struct	messageT
	The type of the message. More...

Static Public Member Functions
static std::string	msgString (void *msgBuffer, flatlogs::msgLenT len)
	Format the message for text output, including translation of state codes to text form. More...
static flatlogs::msgLenT	length (const fbMessage &msg)
	Get the length of the message. More...
static int	format (void *msgBuffer, const fbMessage &msg)
	Format the buffer given the input message. More...

Static Public Attributes
static const flatlogs::eventCodeT	eventCode = eventCodes::STATE_CHANGE
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_INFO

Detailed Description

Application State Change.

Definition at line 27 of file state_change.hpp.

Member Function Documentation

format()

static int MagAOX::logger::flatbuffer_log::format ( void *  msgBuffer, const fbMessage &  msg  )

inlinestaticinherited

Format the buffer given the input message.

Todo:

this is an unneccesary memcpy from the FlatBufferBuilder, we need to figure out how to not do this.

Parameters

msgBuffer	the buffer, must be pre-allocated to size length(msg)
msg	the message which contains a flatbuffer builder, from which the data are memcpy-ed.

Definition at line 47 of file flatbuffer_log.hpp.

length()

static flatlogs::msgLenT MagAOX::logger::flatbuffer_log::length ( const fbMessage &  msg )

inlinestaticinherited

Get the length of the message.

Parameters

msg	the fbMessage type holding a FlatBufferBuilder

Definition at line 39 of file flatbuffer_log.hpp.

msgString()

static std::string MagAOX::logger::state_change::msgString ( void *  msgBuffer, flatlogs::msgLenT  len  )

inlinestatic

Format the message for text output, including translation of state codes to text form.

Returns

the message formatted as "State changed from UNINITIALIZED to INITIALIZED"

Parameters

[in]	msgBuffer	Buffer containing the flatbuffer serialized message.
[in]	len	[unused] length of msgBuffer.

Definition at line 51 of file state_change.hpp.

Member Data Documentation

defaultLevel

const flatlogs::logPrioT MagAOX::logger::state_change::defaultLevel = flatlogs::logPrio::LOG_INFO

static

Definition at line 33 of file state_change.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::state_change::eventCode = eventCodes::STATE_CHANGE

static

Definition at line 30 of file state_change.hpp.

---

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

• /home/jrmales/Source/MagAOX/libMagAOX/logger/types/state_change.hpp