MagAOX::logger::telem_position Struct Reference

Log entry recording position stage specific status. More...

#include <telem_position.hpp>

Inheritance diagram for MagAOX::logger::telem_position:

Collaboration diagram for MagAOX::logger::telem_position:

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

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 formatte for human consumption. More...
static float	pos (void *msgBuffer)
static logMetaDetail	getAccessor (const std::string &member)
	Get the logMetaDetail for a member by name. 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::TELEM_POSITION
	The event code. More...
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_TELEM
	The default level. More...
static timespec	lastRecord = {0,0}
	The timestamp of the last time this log was recorded. Used by the telemetry system. More...

Detailed Description

Log entry recording position stage specific status.

Definition at line 23 of file telem_position.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.

getAccessor()

static logMetaDetail MagAOX::logger::telem_position::getAccessor ( const std::string &  member )

inlinestatic

Get the logMetaDetail for a member by name.

Returns

the a logMetaDetail filled in with the appropriate details

an empty logmegaDetail if member not recognized

Parameters

[in]

member

the name of the member

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

inlinestatic

Get the message formatte for human consumption.

Parameters

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

Definition at line 55 of file telem_position.hpp.

pos()

static float MagAOX::logger::telem_position::pos ( void *  msgBuffer )

inlinestatic

Definition at line 72 of file telem_position.hpp.

Referenced by MagAOX::logger::telem_position::messageT::messageT(), and getAccessor().

verify()

static bool MagAOX::logger::telem_position::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 46 of file telem_position.hpp.

Member Data Documentation

defaultLevel

const flatlogs::logPrioT MagAOX::logger::telem_position::defaultLevel = flatlogs::logPrio::LOG_TELEM

static

The default level.

Definition at line 29 of file telem_position.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_position::eventCode = eventCodes::TELEM_POSITION

static

The event code.

Definition at line 26 of file telem_position.hpp.

lastRecord

timespec MagAOX::logger::telem_position::lastRecord = {0,0}

static

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

Definition at line 31 of file telem_position.hpp.

---

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

• libMagAOX/logger/types/telem_position.hpp
• libMagAOX/logger/types/telem.cpp