MagAOX::logger::telem_modalgainopt Struct Reference

Log entry recording modalGainOpt control state. More...

#include <telem_modalgainopt.hpp>

Inheritance diagram for MagAOX::logger::telem_modalgainopt:

Collaboration diagram for MagAOX::logger::telem_modalgainopt:

Classes
struct	messageT

Static Public Member Functions
static bool	verify (flatlogs::bufferPtrT &logBuff, flatlogs::msgLenT len)
static std::string	msgString (void *msgBuffer, flatlogs::msgLenT len)
static bool	updateAuto (void *msgBuffer)
static bool	opticalGainTracking (void *msgBuffer)
static float	opticalGain (void *msgBuffer)
static float	gainGain (void *msgBuffer)
static float	gainLeak (void *msgBuffer)
static logMetaDetail	getAccessor (const std::string &member)
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_MODALGAINOPT
static const flatlogs::logPrioT	defaultLevel = flatlogs::logPrio::LOG_TELEM
static timespec	lastRecord = { 0, 0 }
	The time of the last telemetry record.

Detailed Description

Log entry recording modalGainOpt control state.

Definition at line 22 of file telem_modalgainopt.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.

gainGain()

static float MagAOX::logger::telem_modalgainopt::gainGain ( void *  msgBuffer )

inlinestatic

Definition at line 91 of file telem_modalgainopt.hpp.

References MagAOX::logger::GetTelem_modalgainopt_fb().

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

gainLeak()

static float MagAOX::logger::telem_modalgainopt::gainLeak ( void *  msgBuffer )

inlinestatic

Definition at line 96 of file telem_modalgainopt.hpp.

References MagAOX::logger::GetTelem_modalgainopt_fb().

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

getAccessor()

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

inlinestatic

Definition at line 101 of file telem_modalgainopt.hpp.

References MagAOX::logger::logMeta::Bool, MagAOX::logger::logMeta::Float, gainGain(), gainLeak(), opticalGain(), opticalGainTracking(), MagAOX::logger::logMeta::State, and updateAuto().

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

inlinestatic

Definition at line 55 of file telem_modalgainopt.hpp.

References MagAOX::logger::GetTelem_modalgainopt_fb().

opticalGain()

static float MagAOX::logger::telem_modalgainopt::opticalGain ( void *  msgBuffer )

inlinestatic

Definition at line 86 of file telem_modalgainopt.hpp.

References MagAOX::logger::GetTelem_modalgainopt_fb().

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

opticalGainTracking()

static bool MagAOX::logger::telem_modalgainopt::opticalGainTracking ( void *  msgBuffer )

inlinestatic

Definition at line 81 of file telem_modalgainopt.hpp.

References MagAOX::logger::GetTelem_modalgainopt_fb().

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

updateAuto()

static bool MagAOX::logger::telem_modalgainopt::updateAuto ( void *  msgBuffer )

inlinestatic

Definition at line 76 of file telem_modalgainopt.hpp.

References MagAOX::logger::GetTelem_modalgainopt_fb().

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

verify()

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

inlinestatic

Definition at line 48 of file telem_modalgainopt.hpp.

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

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

Member Data Documentation

defaultLevel

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

static

Definition at line 25 of file telem_modalgainopt.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_modalgainopt::eventCode = eventCodes::TELEM_MODALGAINOPT

static

Definition at line 24 of file telem_modalgainopt.hpp.

lastRecord

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

static

The time of the last telemetry record.

Definition at line 27 of file telem_modalgainopt.hpp.

---

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

• libMagAOX/logger/types/telem_modalgainopt.hpp
• libMagAOX/logger/types/telem.cpp