MagAOX::logger::loop_closed Struct Reference

Loop Closed event log. More...

#include <loop_closed.hpp>

Inheritance diagram for MagAOX::logger::loop_closed:

Collaboration diagram for MagAOX::logger::loop_closed:

Public Types
typedef emptyMessage	messageT
	The type of the message. More...

Static Public Member Functions
static const char *	msg ()
	The message string. More...
static flatlogs::msgLenT	length (const messageT &msg)
	Get the length of the message. More...
static int	format (void *msgBuffer, const messageT &msg)
	Format the buffer given a message – a no-op since the message is an emptyMessage. More...
static int	extract (messageT &msg, void *msgBuffer, flatlogs::msgLenT len)
	Extract the message from a buffer – a no-op since it is an emptyMessage. More...
static bool	verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
static std::string	msgString (void *msgBuffer, flatlogs::msgLenT len)
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::LOOP_CLOSED
	The event code. More...
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_NOTICE
	The default level. More...

Detailed Description

Loop Closed event log.

Definition at line 23 of file loop_closed.hpp.

Member Typedef Documentation

messageT

typedef emptyMessage MagAOX::logger::empty_log< loop_closed >::messageT

inherited

The type of the message.

Definition at line 40 of file empty_log.hpp.

Member Function Documentation

extract()

static int MagAOX::logger::empty_log< loop_closed >::extract ( messageT &  msg, void *  msgBuffer, flatlogs::msgLenT  len  )

inlinestaticinherited

Extract the message from a buffer – a no-op since it is an emptyMessage.

Returns

0

Parameters

[out]	msg	an emptyMessage to which nothing is done.
[in]	msgBuffer	the empty buffer. Is ignored.
[in]	len	ignored length of the empty buffer.

Definition at line 68 of file empty_log.hpp.

format()

static int MagAOX::logger::empty_log< loop_closed >::format ( void *  msgBuffer, const messageT &  msg  )

inlinestaticinherited

Format the buffer given a message – a no-op since the message is an emptyMessage.

Returns

0

Parameters

[out]	msgBuffer	the buffer, which is ignored.
[in]	msg	an emptyMessage.

Definition at line 54 of file empty_log.hpp.

length()

static flatlogs::msgLenT MagAOX::logger::empty_log< loop_closed >::length ( const messageT &  msg )

inlinestaticinherited

Get the length of the message.

Definition at line 43 of file empty_log.hpp.

msg()

static const char* MagAOX::logger::loop_closed::msg ( )

inlinestatic

The message string.

Definition at line 32 of file loop_closed.hpp.

msgJSON()

static std::string MagAOX::logger::empty_log< loop_closed >::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	[unused]
[in]	binarySchemaLength	[unused]

Definition at line 97 of file empty_log.hpp.

msgString()

static std::string MagAOX::logger::empty_log< loop_closed >::msgString ( void *  msgBuffer, flatlogs::msgLenT  len  )

inlinestaticinherited

Definition at line 89 of file empty_log.hpp.

verify()

static bool MagAOX::logger::empty_log< loop_closed >::verify ( flatlogs::bufferPtrT &  logBuff, flatlogs::msgLenT  len  )

inlinestaticinherited

Parameters

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

Definition at line 81 of file empty_log.hpp.

Member Data Documentation

defaultLevel

const flatlogs::logPrioT MagAOX::logger::loop_closed::defaultLevel = flatlogs::logPrio::LOG_NOTICE

static

The default level.

Definition at line 29 of file loop_closed.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::loop_closed::eventCode = eventCodes::LOOP_CLOSED

static

The event code.

Definition at line 26 of file loop_closed.hpp.

---

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

• libMagAOX/logger/types/loop_closed.hpp