MagAOX::logger::telem_cooler Struct Reference

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

#include <telem_cooler.hpp>

Inheritance diagram for MagAOX::logger::telem_cooler:

Collaboration diagram for MagAOX::logger::telem_cooler:

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

Public Types
enum	member {   em_liquidTemp , em_flowRate , em_pumpLevel , em_pumpSpeed ,   em_fanLevel , em_fanSpeed }

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	getDouble (flatlogs::bufferPtrT &buffer, member m)
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_COOLER
	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_cooler.hpp.

Member Enumeration Documentation

member

enum MagAOX::logger::telem_cooler::member

Enumerator
em_liquidTemp
em_flowRate
em_pumpLevel
em_pumpSpeed
em_fanLevel
em_fanSpeed

Definition at line 37 of file telem_cooler.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 53 of file flatbuffer_log.hpp.

getAccessor()

static logMetaDetail MagAOX::logger::telem_cooler::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 127 of file telem_cooler.hpp.

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

getDouble()

static double MagAOX::logger::telem_cooler::getDouble ( flatlogs::bufferPtrT &  buffer, member  m  )

inlinestatic

Definition at line 99 of file telem_cooler.hpp.

References em_fanLevel, em_fanSpeed, em_flowRate, em_liquidTemp, em_pumpLevel, em_pumpSpeed, MagAOX::logger::GetTelem_cooler_fb(), and flatlogs::logHeader::messageBuffer().

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.

Referenced by CConfigLog_0::CConfigLog_0(), CGitState_0::CGitState_0(), CObserver_0::CObserver_0(), COcamTemps_0::COcamTemps_0(), COutletChannelState_0::COutletChannelState_0(), COutletState_0::COutletState_0(), CPicoChannel_0::CPicoChannel_0(), CSavingStart_0::CSavingStart_0(), CSavingStop_0::CSavingStop_0(), CSoftwareLog_0::CSoftwareLog_0(), CSoftwareLog_1::CSoftwareLog_1(), CSoftwareLog_2::CSoftwareLog_2(), CSoftwareLog_3::CSoftwareLog_3(), CSoftwareLog_4::CSoftwareLog_4(), CSoftwareLog_5::CSoftwareLog_5(), CSoftwareLog_6::CSoftwareLog_6(), CStateChange_0::CStateChange_0(), CTelemBlockgains_0::CTelemBlockgains_0(), CTelemChronyStats_0::CTelemChronyStats_0(), CTelemChronyStatus_0::CTelemChronyStatus_0(), CTelemCooler_0::CTelemCooler_0(), CTelemCoreloads_0::CTelemCoreloads_0(), CTelemCoretemps_0::CTelemCoretemps_0(), CTelemDmmodes_0::CTelemDmmodes_0(), CTelemDmspeck_0::CTelemDmspeck_0(), CTelemDrivetemps_0::CTelemDrivetemps_0(), CTelemFgtimings_0::CTelemFgtimings_0(), CTelemFxngen_0::CTelemFxngen_0(), CTelemLoopgain_0::CTelemLoopgain_0(), CTelemObserver_0::CTelemObserver_0(), CTelemPi335_0::CTelemPi335_0(), CTelemPico_0::CTelemPico_0(), CTelemPokecenter_0::CTelemPokecenter_0(), CTelemPokecenter_1::CTelemPokecenter_1(), CTelemPokeloop_0::CTelemPokeloop_0(), CTelemPosition_0::CTelemPosition_0(), CTelemRhusb_0::CTelemRhusb_0(), CTelemSaving_0::CTelemSaving_0(), CTelemSavingState_0::CTelemSavingState_0(), CTelemSparkleclock_0::CTelemSparkleclock_0(), CTelemStage_0::CTelemStage_0(), CTelemStdcam_0::CTelemStdcam_0(), CTelemStdcam_1::CTelemStdcam_1(), CTelemTelcat_0::CTelemTelcat_0(), CTelemTeldata_0::CTelemTeldata_0(), CTelemTelenv_0::CTelemTelenv_0(), CTelemTelpos_0::CTelemTelpos_0(), CTelemTelsee_0::CTelemTelsee_0(), CTelemTelvane_0::CTelemTelvane_0(), CTelemTemps_0::CTelemTemps_0(), CTelemUsage_0::CTelemUsage_0(), CTelemZaber_0::CTelemZaber_0(), CTextLog_0::CTextLog_0(), CTextLog_1::CTextLog_1(), CTtmmodParams_0::CTtmmodParams_0(), and CUserLog_0::CUserLog_0().

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_cooler::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 67 of file telem_cooler.hpp.

References MagAOX::logger::GetTelem_cooler_fb().

verify()

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

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

Referenced by MagAOX::logger::logVerify(), and CTelemCooler_0::verify().

Member Data Documentation

defaultLevel

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

static

The default level.

Definition at line 33 of file telem_cooler.hpp.

eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_cooler::eventCode = eventCodes::TELEM_COOLER

static

The event code.

Definition at line 30 of file telem_cooler.hpp.

lastRecord

timespec MagAOX::logger::telem_cooler::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_cooler.hpp.

---

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

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