MagAOX::logger::pico_channel Struct Reference

Application State Change. More...

#include <pico_channel.hpp>

Inheritance diagram for MagAOX::logger::pico_channel:

Collaboration diagram for MagAOX::logger::pico_channel:

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

Static Public Member Functions
static bool	verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
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 std::string	msgJSON (void *msgBuffer, flatlogs::msgLenT len, const uint8_t *binarySchema, const unsigned int binarySchemaLength)

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

Detailed Description

Application State Change.

Definition at line 25 of file pico_channel.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

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

Definition at line 53 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

[in]

msg

the fbMessage type holding a FlatBufferBuilder

Definition at line 45 of file flatbuffer_log.hpp.

msgJSON()

static std::string MagAOX::logger::flatbuffer_log::msgJSON ( void *  msgBuffer, flatlogs::msgLenT  len, const uint8_t *  binarySchema, const unsigned int  binarySchemaLength  )

inlinestaticinherited

Parameters

[in]	msgBuffer	Buffer containing the flatbuffer serialized message.
[in]	len	[unused] length of msgBuffer.
[in]	binarySchema	flatbuffers binary schema for this log type
[in]	binarySchemaLength	flatbuffers binary schema length

Definition at line 64 of file flatbuffer_log.hpp.

msgString()

static std::string MagAOX::logger::pico_channel::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"

Definition at line 60 of file pico_channel.hpp.

verify()

static bool MagAOX::logger::pico_channel::verify ( flatlogs::bufferPtrT &  logBuff, flatlogs::msgLenT  len  )

inlinestatic

Parameters

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

Definition at line 48 of file pico_channel.hpp.

Member Data Documentation

defaultLevel

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

static

Definition at line 31 of file pico_channel.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::pico_channel::eventCode = eventCodes::PICO_CHANNEL

static

Definition at line 28 of file pico_channel.hpp.

---

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

• libMagAOX/logger/types/pico_channel.hpp