Log entry recording the modulator state. More...

#include <ttmmod_params.hpp>

Inheritance diagram for MagAOX::logger::ttmmod_params:

Collaboration diagram for MagAOX::logger::ttmmod_params:

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 std::string	modState (void *msgBuffer)

static double	modFreq (void *msgBuffer)

static double	modRad (void *msgBuffer)

static double	offset1 (void *msgBuffer)

static double	offset2 (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::TTMMOD_PARAMS
	The event code.

static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_INFO
	The default level.

Detailed Description

Log entry recording the modulator state.

Definition at line 25 of file ttmmod_params.hpp.

Member Function Documentation

◆ 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::ttmmod_params::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 138 of file ttmmod_params.hpp.

References MagAOX::logger::logMeta::Double, modFreq(), modRad(), modState(), offset1(), MagAOX::logger::logMeta::State, and MagAOX::logger::logMeta::String.

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.

◆ modFreq()

static double MagAOX::logger::ttmmod_params::modFreq ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 109 of file ttmmod_params.hpp.

References MagAOX::logger::GetTtmmod_params_fb().

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

◆ modRad()

static double MagAOX::logger::ttmmod_params::modRad ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 115 of file ttmmod_params.hpp.

References MagAOX::logger::GetTtmmod_params_fb().

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

◆ modState()

static std::string MagAOX::logger::ttmmod_params::modState ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 91 of file ttmmod_params.hpp.

References MagAOX::logger::GetTtmmod_params_fb().

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

◆ msgString()

static std::string MagAOX::logger::ttmmod_params::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 61 of file ttmmod_params.hpp.

References MagAOX::logger::GetTtmmod_params_fb().

◆ offset1()

static double MagAOX::logger::ttmmod_params::offset1 ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 121 of file ttmmod_params.hpp.

References MagAOX::logger::GetTtmmod_params_fb().

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

◆ offset2()

static double MagAOX::logger::ttmmod_params::offset2 ( void * msgBuffer )

inlinestatic

Parameters

[in] msgBuffer Buffer containing the flatbuffer serialized message.

Definition at line 127 of file ttmmod_params.hpp.

References MagAOX::logger::GetTtmmod_params_fb().

Referenced by MagAOX::logger::ttmmod_params::messageT::messageT().

◆ verify()

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

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

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

Member Data Documentation

◆ defaultLevel

const flatlogs::logPrioT MagAOX::logger::ttmmod_params::defaultLevel = flatlogs::logPrio::LOG_INFO

static

The default level.

Definition at line 31 of file ttmmod_params.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::ttmmod_params::eventCode = eventCodes::TTMMOD_PARAMS

static

The event code.

Definition at line 28 of file ttmmod_params.hpp.

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

libMagAOX/logger/types/ttmmod_params.hpp

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ format()

◆ getAccessor()

◆ length()

◆ modFreq()

◆ modRad()

◆ modState()

◆ msgJSON()

◆ msgString()

◆ offset1()

◆ offset2()

◆ verify()

Member Data Documentation

◆ defaultLevel

◆ eventCode