Log entry recording the build-time git state. More...

#include <telem_telvane.hpp>

Inheritance diagram for MagAOX::logger::telem_telvane:

Collaboration diagram for MagAOX::logger::telem_telvane:

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.

static double	secz (void *msgBuffer)

static double	encz (void *msgBuffer)

static double	secx (void *msgBuffer)

static double	encx (void *msgBuffer)

static double	secy (void *msgBuffer)

static double	ency (void *msgBuffer)

static double	sech (void *msgBuffer)

static double	ench (void *msgBuffer)

static double	secv (void *msgBuffer)

static double	encv (void *msgBuffer)

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_TELVANE
	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 build-time git state.

Definition at line 25 of file telem_telvane.hpp.

Member Function Documentation

◆ ench()

static double MagAOX::logger::telem_telvane::ench ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 160 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ encv()

static double MagAOX::logger::telem_telvane::encv ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 174 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ encx()

static double MagAOX::logger::telem_telvane::encx ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 132 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ ency()

static double MagAOX::logger::telem_telvane::ency ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 146 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ encz()

static double MagAOX::logger::telem_telvane::encz ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 118 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

Referenced by MagAOX::logger::telem_telvane::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_telvane::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 logMetaDetail if member not recognized

Parameters

[in] member the name of the member

Definition at line 186 of file telem_telvane.hpp.

References MagAOX::logger::logMeta::Double, ench(), encv(), encx(), ency(), encz(), sech(), secv(), secx(), secy(), secz(), and MagAOX::logger::logMeta::State.

Referenced by MagAOX::logger::logMemberAccessor(), and libXWCTest::loggerTest::logTypeAccessorTest::TEST_CASE().

◆ 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_telvane::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 67 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

◆ sech()

static double MagAOX::logger::telem_telvane::sech ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 153 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ secv()

static double MagAOX::logger::telem_telvane::secv ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 167 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ secx()

static double MagAOX::logger::telem_telvane::secx ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 125 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ secy()

static double MagAOX::logger::telem_telvane::secy ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 139 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ secz()

static double MagAOX::logger::telem_telvane::secz ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 111 of file telem_telvane.hpp.

References MagAOX::logger::GetTelem_telvane_fb().

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

◆ verify()

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

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

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

Member Data Documentation

◆ defaultLevel

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

static

The default level.

Definition at line 31 of file telem_telvane.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_telvane::eventCode = eventCodes::TELEM_TELVANE

static

The event code.

Definition at line 28 of file telem_telvane.hpp.

◆ lastRecord

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

static

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

Definition at line 33 of file telem_telvane.hpp.

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

libMagAOX/logger/types/telem_telvane.hpp
libMagAOX/logger/types/telem.cpp

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ ench()

◆ encv()

◆ encx()

◆ ency()

◆ encz()

◆ format()

◆ getAccessor()

◆ length()

◆ msgJSON()

◆ msgString()

◆ sech()

◆ secv()

◆ secx()

◆ secy()

◆ secz()

◆ verify()

Member Data Documentation

◆ defaultLevel

◆ eventCode

◆ lastRecord