API
MagAOX::logger::software_warning Struct Reference

Software WARN log entry. More...

#include <software_log.hpp>

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

Static Public Member Functions

static bool verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
 
static std::string msgString (void *msgBuffer, flatlogs::msgLenT len)
 Get the message formatted for human consumption. 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::logPrioT defaultLevel = flatlogs::logPrio::LOG_WARNING
 The default level. More...
 
static const flatlogs::eventCodeT eventCode = eventCodes::SOFTWARE_LOG
 The event code. More...
 

Detailed Description

Software WARN log entry.

Used to record an abnormal condition.

Definition at line 245 of file software_log.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::software_log::msgString ( void *  msgBuffer,
flatlogs::msgLenT  len 
)
inlinestaticinherited

Get the message formatted for human consumption.

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

Definition at line 145 of file software_log.hpp.

◆ verify()

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

Definition at line 136 of file software_log.hpp.

Member Data Documentation

◆ defaultLevel

const flatlogs::logPrioT MagAOX::logger::software_warning::defaultLevel = flatlogs::logPrio::LOG_WARNING
static

The default level.

Definition at line 248 of file software_log.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::software_log::eventCode = eventCodes::SOFTWARE_LOG
staticinherited

The event code.

Definition at line 32 of file software_log.hpp.


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