MagAOX::logger::telem_flowrpm Struct Reference

Log entry recording the displayed flow value and source age. More...

#include <telem_flowrpm.hpp>

Inheritance diagram for MagAOX::logger::telem_flowrpm:

Collaboration diagram for MagAOX::logger::telem_flowrpm:

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 formatted for human consumption.
static double	flowRate (void *msgBuffer)
	Recover the flow rate from a serialized message.
static double	age (void *msgBuffer)
	Recover the age from a serialized message.
static bool	valid (void *msgBuffer)
	Recover the validity flag from a serialized message.
static logMetaDetail	getAccessor (const std::string &member)
	Get the logMetaDetail for a member by name.
static flatlogs::msgLenT	length (const fbMessage &msg)
	Get the length of the message.
static int	format (void *msgBuffer, const fbMessage &msg)
	Format the buffer given the input message.
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_FLOWRPM
	The event code.
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_TELEM
	The default level.
static timespec	lastRecord = { 0, 0 }
	The time of the last time this log was recorded. Used by the telemetry system.

Detailed Description

Log entry recording the displayed flow value and source age.

Definition at line 22 of file telem_flowrpm.hpp.

Member Function Documentation

age()

static double MagAOX::logger::telem_flowrpm::age ( void *  msgBuffer )

inlinestatic

Recover the age from a serialized message.

Definition at line 82 of file telem_flowrpm.hpp.

References MagAOX::logger::GetTelem_flowrpm_fb().

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

flowRate()

static double MagAOX::logger::telem_flowrpm::flowRate ( void *  msgBuffer )

inlinestatic

Recover the flow rate from a serialized message.

Definition at line 76 of file telem_flowrpm.hpp.

References MagAOX::logger::GetTelem_flowrpm_fb().

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

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 54 of file flatbuffer_log.hpp.

getAccessor()

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

inlinestatic

Get the logMetaDetail for a member by name.

Parameters

[in]

member

the name of the member

Definition at line 94 of file telem_flowrpm.hpp.

References age(), MagAOX::logger::logMeta::Bool, MagAOX::logger::logMeta::Continuous, MagAOX::logger::logMeta::Double, flowRate(), MagAOX::logger::logMeta::State, and valid().

Referenced by MagAOX::logger::logMemberAccessor().

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 46 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 65 of file flatbuffer_log.hpp.

msgString()

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

inlinestatic

Get the message formatted for human consumption.

Parameters

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

Definition at line 56 of file telem_flowrpm.hpp.

References MagAOX::logger::GetTelem_flowrpm_fb().

valid()

static bool MagAOX::logger::telem_flowrpm::valid ( void *  msgBuffer )

inlinestatic

Recover the validity flag from a serialized message.

Definition at line 88 of file telem_flowrpm.hpp.

References MagAOX::logger::GetTelem_flowrpm_fb().

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

verify()

static bool MagAOX::logger::telem_flowrpm::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_flowrpm.hpp.

References flatlogs::logHeader::messageBuffer(), and MagAOX::logger::VerifyTelem_flowrpm_fbBuffer().

Referenced by MagAOX::logger::logVerify().

Member Data Documentation

defaultLevel

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

static

The default level.

Definition at line 28 of file telem_flowrpm.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_flowrpm::eventCode = eventCodes::TELEM_FLOWRPM

static

The event code.

Definition at line 25 of file telem_flowrpm.hpp.

lastRecord

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

static

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

Definition at line 30 of file telem_flowrpm.hpp.

---

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

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