Base class for software logs. More...

#include <software_log.hpp>

Inheritance diagram for MagAOX::logger::software_log:

Collaboration diagram for MagAOX::logger::software_log:

Classes
struct	messageT
	The type of the 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 formatted for human consumption.

static logMetaDetail	getAccessor (const std::string &member)
	Get an empty logMetaDetail because meta data doesn't make sense for this log.

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::SOFTWARE_LOG
	The event code.

Detailed Description

Base class for software logs.

Such logs are used to log software status, warnings, and errors. Does not have defaultLevel, so this can not be used as a log type in logger.

Definition at line 29 of file software_log.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::software_log::getAccessor ( const std::string & member )

inlinestatic

Get an empty logMetaDetail because meta data doesn't make sense for this log.

Returns: an empty logMetaDetail

Parameters

[in] member the name of the member

Definition at line 190 of file software_log.hpp.

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

inlinestatic

Get the message formatted for human consumption.

Parameters

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

Definition at line 145 of file software_log.hpp.

References MagAOX::logger::GetSoftware_log_fb().

◆ verify()

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

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

Referenced by MagAOX::logger::logVerify(), CSoftwareLog_0::verify(), CSoftwareLog_1::verify(), CSoftwareLog_2::verify(), CSoftwareLog_3::verify(), CSoftwareLog_4::verify(), CSoftwareLog_5::verify(), and CSoftwareLog_6::verify().

Member Data Documentation

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::software_log::eventCode = eventCodes::SOFTWARE_LOG

static

The event code.

Definition at line 32 of file software_log.hpp.

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

libMagAOX/logger/types/software_log.hpp

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ format()

◆ getAccessor()

◆ length()

◆ msgJSON()

◆ msgString()

◆ verify()

Member Data Documentation

◆ eventCode