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

#include <telem_telpos.hpp>

Inheritance diagram for MagAOX::logger::telem_telpos:

Collaboration diagram for MagAOX::logger::telem_telpos:

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

Public Types
enum	member { em_epoch , em_ra , em_dec , em_el , em_ha , em_am , em_rotoff }

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	epoch (void *msgBuffer)

static double	ra (void *msgBuffer)

static double	dec (void *msgBuffer)

static double	el (void *msgBuffer)

static double	ha (void *msgBuffer)

static double	am (void *msgBuffer)

static double	ro (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_TELPOS
	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 27 of file telem_telpos.hpp.

Member Enumeration Documentation

◆ member

enum MagAOX::logger::telem_telpos::member

Enumerator
em_epoch
em_ra
em_dec
em_el
em_ha
em_am
em_rotoff

Definition at line 37 of file telem_telpos.hpp.

Member Function Documentation

◆ am()

static double MagAOX::logger::telem_telpos::am ( void * msgBuffer )

inlinestatic

Definition at line 133 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

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

◆ dec()

static double MagAOX::logger::telem_telpos::dec ( void * msgBuffer )

inlinestatic

Definition at line 115 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

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

◆ el()

static double MagAOX::logger::telem_telpos::el ( void * msgBuffer )

inlinestatic

Definition at line 121 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

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

◆ epoch()

static double MagAOX::logger::telem_telpos::epoch ( void * msgBuffer )

inlinestatic

Definition at line 103 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

Referenced by MagAOX::logger::telem_telpos::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_telpos::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 151 of file telem_telpos.hpp.

References am(), MagAOX::logger::logMeta::Continuous, dec(), MagAOX::logger::logMeta::Double, el(), epoch(), ha(), ra(), and ro().

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

◆ ha()

static double MagAOX::logger::telem_telpos::ha ( void * msgBuffer )

inlinestatic

Definition at line 127 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

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

◆ 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_telpos::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 68 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

◆ ra()

static double MagAOX::logger::telem_telpos::ra ( void * msgBuffer )

inlinestatic

Definition at line 109 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

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

◆ ro()

static double MagAOX::logger::telem_telpos::ro ( void * msgBuffer )

inlinestatic

Definition at line 139 of file telem_telpos.hpp.

References MagAOX::logger::GetTelem_telpos_fb().

Referenced by getAccessor().

◆ verify()

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

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

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

Member Data Documentation

◆ defaultLevel

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

static

The default level.

Definition at line 33 of file telem_telpos.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_telpos::eventCode = eventCodes::TELEM_TELPOS

static

The event code.

Definition at line 30 of file telem_telpos.hpp.

◆ lastRecord

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

static

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

Definition at line 35 of file telem_telpos.hpp.

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

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

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ member

Member Function Documentation

◆ am()

◆ dec()

◆ el()

◆ epoch()

◆ format()

◆ getAccessor()

◆ ha()

◆ length()

◆ msgJSON()

◆ msgString()

◆ ra()

◆ ro()

◆ verify()

Member Data Documentation

◆ defaultLevel

◆ eventCode

◆ lastRecord