API
MagAOX::logger::saving_stop Struct Reference

Saving started log. More...

#include <saving_stop.hpp>

Inheritance diagram for MagAOX::logger::saving_stop:
Inheritance graph
Collaboration diagram for MagAOX::logger::saving_stop:
Collaboration graph

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::SAVING_STOP
 The event code. More...
 
static const flatlogs::logPrioT defaultLevel = flatlogs::logPrio::LOG_NOTICE
 The default level. More...
 
static timespec lastRecord
 The time of the last time this log was recorded. Used by the telemetry system. More...
 

Detailed Description

Saving started log.

Definition at line 23 of file saving_stop.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]msgBufferthe buffer, must be pre-allocated to size length(msg)
[in]msgthe 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]msgthe 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]msgBufferBuffer containing the flatbuffer serialized message.
[in]len[unused] length of msgBuffer.
[in]binarySchemaflatbuffers binary schema for this log type
[in]binarySchemaLengthflatbuffers binary schema length

Definition at line 64 of file flatbuffer_log.hpp.

◆ msgString()

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

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]msgBufferBuffer containing the flatbuffer serialized message.
[in]len[unused] length of msgBuffer.

Definition at line 55 of file saving_state_change.hpp.

◆ verify()

static bool MagAOX::logger::saving_state_change::verify ( flatlogs::bufferPtrT logBuff,
flatlogs::msgLenT  len 
)
inlinestaticinherited
Parameters
[in]logBuffBuffer containing the flatbuffer serialized message.
[in]lenlength of msgBuffer.

Definition at line 43 of file saving_state_change.hpp.

Member Data Documentation

◆ defaultLevel

const flatlogs::logPrioT MagAOX::logger::saving_stop::defaultLevel = flatlogs::logPrio::LOG_NOTICE
static

The default level.

Definition at line 29 of file saving_stop.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::saving_stop::eventCode = eventCodes::SAVING_STOP
static

The event code.

Definition at line 26 of file saving_stop.hpp.

◆ lastRecord

timespec MagAOX::logger::saving_stop::lastRecord
static

The time of the last time this log was recorded. Used by the telemetry system.

Definition at line 31 of file saving_stop.hpp.


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