Log entry recording psf acquisition per-star properties. More...

#include <telem_psfacq.hpp>

Inheritance diagram for MagAOX::logger::telem_psfacq:

Collaboration diagram for MagAOX::logger::telem_psfacq:

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 format for human consumption.

static int	star_no (void *msgBuffer)
	Get the one-based star index.

static int	num_stars (void *msgBuffer)
	Get the total number of stars emitted this cycle.

static float	x_pos (void *msgBuffer)

static float	y_pos (void *msgBuffer)

static float	m_pix (void *msgBuffer)

static float	fwhm (void *msgBuffer)

static float	seeing (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::TELEM_PSFACQ
	The event code.

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

static timespec	lastRecord = { 0, 0 }
	The timestamp of the last time this log was recorded. Used by telemetry.

Detailed Description

Log entry recording psf acquisition per-star properties.

Definition at line 21 of file telem_psfacq.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.

◆ fwhm()

static float MagAOX::logger::telem_psfacq::fwhm ( void * msgBuffer )

inlinestatic

Definition at line 108 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

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

◆ getAccessor()

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

inlinestatic

Get the logMetaDetail for a member by name.

Returns: 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 125 of file telem_psfacq.hpp.

References MagAOX::logger::logMeta::Continuous, MagAOX::logger::logMeta::Float, fwhm(), MagAOX::logger::logMeta::Int, m_pix(), num_stars(), seeing(), star_no(), MagAOX::logger::logMeta::State, x_pos(), and y_pos().

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.

◆ m_pix()

static float MagAOX::logger::telem_psfacq::m_pix ( void * msgBuffer )

inlinestatic

Definition at line 102 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

Referenced by MagAOX::logger::telem_psfacq::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::telem_psfacq::msgString	(	void *	msgBuffer,
		flatlogs::msgLenT	len
	)

inlinestatic

Get the message format for human consumption.

Parameters

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

Definition at line 58 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

◆ num_stars()

static int MagAOX::logger::telem_psfacq::num_stars ( void * msgBuffer )

inlinestatic

Get the total number of stars emitted this cycle.

Definition at line 84 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

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

◆ seeing()

static float MagAOX::logger::telem_psfacq::seeing ( void * msgBuffer )

inlinestatic

Definition at line 114 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

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

◆ star_no()

static int MagAOX::logger::telem_psfacq::star_no ( void * msgBuffer )

inlinestatic

Get the one-based star index.

Definition at line 77 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

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

◆ verify()

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

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

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

◆ x_pos()

static float MagAOX::logger::telem_psfacq::x_pos ( void * msgBuffer )

inlinestatic

Definition at line 90 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

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

◆ y_pos()

static float MagAOX::logger::telem_psfacq::y_pos ( void * msgBuffer )

inlinestatic

Definition at line 96 of file telem_psfacq.hpp.

References MagAOX::logger::GetTelem_psfacq_fb().

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

Member Data Documentation

◆ defaultLevel

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

static

The default level.

Definition at line 27 of file telem_psfacq.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_psfacq::eventCode = eventCodes::TELEM_PSFACQ

static

The event code.

Definition at line 24 of file telem_psfacq.hpp.

◆ lastRecord

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

static

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

Definition at line 29 of file telem_psfacq.hpp.

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

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

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ format()

◆ fwhm()

◆ getAccessor()

◆ length()

◆ m_pix()

◆ msgJSON()

◆ msgString()

◆ num_stars()

◆ seeing()

◆ star_no()

◆ verify()

◆ x_pos()

◆ y_pos()

Member Data Documentation

◆ defaultLevel

◆ eventCode

◆ lastRecord