Focus offload-control telemetry. More...

#include <telem_tcsi_focus.hpp>

Inheritance diagram for MagAOX::logger::telem_tcsi_focus:

Collaboration diagram for MagAOX::logger::telem_tcsi_focus:

Static Public Member Functions
static std::string	msgString (void *msgBuffer, flatlogs::msgLenT len)
	Format the message for human consumption.

static bool	verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)

static bool	enabled (void *msgBuffer)
	Access the enabled state.

static float	gain (void *msgBuffer)
	Access the offload gain.

static float	avgInt (void *msgBuffer)
	Access the offload averaging interval.

static float	thresh (void *msgBuffer)
	Access the offload threshold.

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_TCSI_FOCUS
	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.

Static Protected Member Functions
static std::string	formatMsgString (const char label, void msgBuffer, flatlogs::msgLenT len)
	Format a shared offload-control message body with a caller-supplied label.

Detailed Description

Focus offload-control telemetry.

Definition at line 21 of file telem_tcsi_focus.hpp.

Member Function Documentation

◆ avgInt()

static float MagAOX::logger::telem_tcsi_offload::avgInt ( void * msgBuffer )

inlinestaticinherited

Access the offload averaging interval.

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 104 of file telem_tcsi_offload.hpp.

References MagAOX::logger::GetTelem_tcsi_offload_fb().

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

◆ enabled()

static bool MagAOX::logger::telem_tcsi_offload::enabled ( void * msgBuffer )

inlinestaticinherited

Access the enabled state.

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 90 of file telem_tcsi_offload.hpp.

References MagAOX::logger::GetTelem_tcsi_offload_fb().

Referenced by MagAOX::logger::telem_tcsi_offload::messageT::messageT(), and MagAOX::logger::telem_tcsi_offload::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.

◆ formatMsgString()

static std::string MagAOX::logger::telem_tcsi_offload::formatMsgString	(	const char *	label,
		void *	msgBuffer,
		flatlogs::msgLenT	len
	)

inlinestaticprotectedinherited

Format a shared offload-control message body with a caller-supplied label.

Parameters

[in]	label	Label identifying the telemetry type.
[in]	msgBuffer	Buffer containing the flatbuffer serialized message.
[in]	len	[unused] length of msgBuffer.

Definition at line 31 of file telem_tcsi_offload.hpp.

References MagAOX::logger::GetTelem_tcsi_offload_fb().

Referenced by msgString(), MagAOX::logger::telem_tcsi_offload::msgString(), and MagAOX::logger::telem_tcsi_tiptilt::msgString().

◆ gain()

static float MagAOX::logger::telem_tcsi_offload::gain ( void * msgBuffer )

inlinestaticinherited

Access the offload gain.

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 97 of file telem_tcsi_offload.hpp.

References MagAOX::logger::GetTelem_tcsi_offload_fb().

Referenced by MagAOX::logger::telem_tcsi_offload::messageT::messageT(), pupilCorAlign.pupilCorAlign::control_position(), MagAOX::logger::telem_tcsi_offload::getAccessor(), and pupilCorAlign.pupilCorAlign::handle_gain().

◆ getAccessor()

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

inlinestaticinherited

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 122 of file telem_tcsi_offload.hpp.

References MagAOX::logger::telem_tcsi_offload::avgInt(), MagAOX::logger::logMeta::Bool, MagAOX::logger::telem_tcsi_offload::enabled(), MagAOX::logger::logMeta::Float, MagAOX::logger::telem_tcsi_offload::gain(), MagAOX::logger::logMeta::State, and MagAOX::logger::telem_tcsi_offload::thresh().

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_tcsi_focus::msgString	(	void *	msgBuffer,
		flatlogs::msgLenT	len
	)

inlinestatic

Format the message for human consumption.

Parameters

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

Definition at line 30 of file telem_tcsi_focus.hpp.

References MagAOX::logger::telem_tcsi_offload::formatMsgString().

◆ thresh()

static float MagAOX::logger::telem_tcsi_offload::thresh ( void * msgBuffer )

inlinestaticinherited

Access the offload threshold.

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 111 of file telem_tcsi_offload.hpp.

References MagAOX::logger::GetTelem_tcsi_offload_fb().

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

◆ verify()

static bool MagAOX::logger::telem_tcsi_offload::verify	(	flatlogs::bufferPtrT &	logBuff,
		flatlogs::msgLenT	len
	)

inlinestaticinherited

Parameters

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

Definition at line 72 of file telem_tcsi_offload.hpp.

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

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

Member Data Documentation

◆ defaultLevel

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

static

The default level.

Definition at line 27 of file telem_tcsi_focus.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_tcsi_focus::eventCode = eventCodes::TELEM_TCSI_FOCUS

static

The event code.

Definition at line 24 of file telem_tcsi_focus.hpp.

◆ lastRecord

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

static

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

Definition at line 37 of file telem_tcsi_focus.hpp.

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

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

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ avgInt()

◆ enabled()

◆ format()

◆ formatMsgString()

◆ gain()

◆ getAccessor()

◆ length()

◆ msgJSON()

◆ msgString()

◆ thresh()

◆ verify()

Member Data Documentation

◆ defaultLevel

◆ eventCode

◆ lastRecord