Log entry recording sparkle clock status. More...

#include <telem_sparkleclock.hpp>

Inheritance diagram for MagAOX::logger::telem_sparkleclock:

Collaboration diagram for MagAOX::logger::telem_sparkleclock:

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

static bool	trigger (void *msgBuffer)

static float	frequency (void *msgBuffer)

static std::vector< float >	separations (void *msgBuffer)

static float	angleOffset (void *msgBuffer)

static float	amplitude (void *msgBuffer)

static logMetaDetail	getAccessor (const std::string &member)
	Get pointer to the accessor 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_DMSPECK
	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 sparkle clock status.

Definition at line 25 of file telem_sparkleclock.hpp.

Member Function Documentation

◆ amplitude()

static float MagAOX::logger::telem_sparkleclock::amplitude ( void * msgBuffer )

inlinestatic

Definition at line 148 of file telem_sparkleclock.hpp.

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

◆ angleOffset()

static float MagAOX::logger::telem_sparkleclock::angleOffset ( void * msgBuffer )

inlinestatic

Definition at line 143 of file telem_sparkleclock.hpp.

Referenced by MagAOX::logger::telem_sparkleclock::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 53 of file flatbuffer_log.hpp.

◆ frequency()

static float MagAOX::logger::telem_sparkleclock::frequency ( void * msgBuffer )

inlinestatic

Definition at line 123 of file telem_sparkleclock.hpp.

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

◆ getAccessor()

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

inlinestatic

Get pointer to the accessor for a member by name.

Returns: the function pointer cast to void*; -1 for an unknown member

Parameters

[in] member the name of the member

Definition at line 159 of file telem_sparkleclock.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.

◆ modulating()

static bool MagAOX::logger::telem_sparkleclock::modulating ( void * msgBuffer )

inlinestatic

Definition at line 111 of file telem_sparkleclock.hpp.

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

◆ 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_sparkleclock::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_sparkleclock.hpp.

◆ separations()

static std::vector<float> MagAOX::logger::telem_sparkleclock::separations ( void * msgBuffer )

inlinestatic

Definition at line 129 of file telem_sparkleclock.hpp.

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

◆ trigger()

static bool MagAOX::logger::telem_sparkleclock::trigger ( void * msgBuffer )

inlinestatic

Definition at line 117 of file telem_sparkleclock.hpp.

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

◆ verify()

static bool MagAOX::logger::telem_sparkleclock::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_sparkleclock.hpp.

Member Data Documentation

◆ defaultLevel

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

static

The default level.

Definition at line 31 of file telem_sparkleclock.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_sparkleclock::eventCode = eventCodes::TELEM_DMSPECK

static

The event code.

Definition at line 28 of file telem_sparkleclock.hpp.

◆ lastRecord

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

static

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

Definition at line 33 of file telem_sparkleclock.hpp.

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

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

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ amplitude()

◆ angleOffset()

◆ format()

◆ frequency()

◆ getAccessor()

◆ length()

◆ modulating()

◆ msgJSON()

◆ msgString()

◆ separations()

◆ trigger()

◆ verify()

Member Data Documentation

◆ defaultLevel

◆ eventCode

◆ lastRecord