API
MagAOX::logger::telem_stdcam Struct Reference

Log entry recording stdcam stage specific status. More...

#include <telem_stdcam.hpp>

Inheritance diagram for MagAOX::logger::telem_stdcam:
Inheritance graph
Collaboration diagram for MagAOX::logger::telem_stdcam:
Collaboration graph

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 formatted for human consumption. More...
 
static std::string mode (void *msgBuffer)
 
static float xcen (void *msgBuffer)
 
static float ycen (void *msgBuffer)
 
static int width (void *msgBuffer)
 
static int height (void *msgBuffer)
 
static int xbin (void *msgBuffer)
 
static int ybin (void *msgBuffer)
 
static float exptime (void *msgBuffer)
 
static float fps (void *msgBuffer)
 
static float emGain (void *msgBuffer)
 
static float adcSpeed (void *msgBuffer)
 
static float temp (void *msgBuffer)
 
static float tempSetpt (void *msgBuffer)
 
static int tempStatus (void *msgBuffer)
 
static int tempOnTarget (void *msgBuffer)
 
static std::string tempStatusStr (void *msgBuffer)
 
static std::string shutterStatusStr (void *msgBuffer)
 
static std::string shutterState (void *msgBuffer)
 
static bool synchro (void *msgBuffer)
 
static float vshift (void *msgBuffer)
 
static bool cropMode (void *msgBuffer)
 
static logMetaDetail getAccessor (const std::string &member)
 Get the logMetaDetail for a member by name. More...
 
static flatlogs::msgLenT length (const fbMessage &msg)
 Get the length of the message. More...
 
static int format (void *msgBuffer, const fbMessage &msg)
 Format the buffer given the input message. More...
 
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_STDCAM
 The event code. More...
 
static const flatlogs::logPrioT defaultLevel = flatlogs::logPrio::LOG_TELEM
 The default level. More...
 
static timespec lastRecord = {0,0}
 The timestamp of the last time this log was recorded. Used by the telemetry system. More...
 

Detailed Description

Log entry recording stdcam stage specific status.

Definition at line 25 of file telem_stdcam.hpp.

Member Function Documentation

◆ adcSpeed()

static float MagAOX::logger::telem_stdcam::adcSpeed ( void *  msgBuffer)
inlinestatic

◆ cropMode()

static bool MagAOX::logger::telem_stdcam::cropMode ( void *  msgBuffer)
inlinestatic

◆ emGain()

static float MagAOX::logger::telem_stdcam::emGain ( void *  msgBuffer)
inlinestatic

◆ exptime()

static float MagAOX::logger::telem_stdcam::exptime ( void *  msgBuffer)
inlinestatic

◆ 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]msgBufferthe buffer, must be pre-allocated to size length(msg)
[in]msgthe message which contains a flatbuffer builder, from which the data are memcpy-ed.

Definition at line 53 of file flatbuffer_log.hpp.

◆ fps()

static float MagAOX::logger::telem_stdcam::fps ( void *  msgBuffer)
inlinestatic

◆ getAccessor()

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

Get the logMetaDetail for a member by name.

Returns
the function pointer cast to void*
-1 for an unknown member
Parameters
[in]memberthe name of the member

Definition at line 386 of file telem_stdcam.hpp.

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

◆ height()

static int MagAOX::logger::telem_stdcam::height ( void *  msgBuffer)
inlinestatic

◆ length()

static flatlogs::msgLenT MagAOX::logger::flatbuffer_log::length ( const fbMessage msg)
inlinestaticinherited

Get the length of the message.

Parameters
[in]msgthe fbMessage type holding a FlatBufferBuilder

Definition at line 45 of file flatbuffer_log.hpp.

◆ mode()

static std::string MagAOX::logger::telem_stdcam::mode ( void *  msgBuffer)
inlinestatic

◆ 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]msgBufferBuffer containing the flatbuffer serialized message.
[in]len[unused] length of msgBuffer.
[in]binarySchemaflatbuffers binary schema for this log type
[in]binarySchemaLengthflatbuffers binary schema length

Definition at line 64 of file flatbuffer_log.hpp.

◆ msgString()

static std::string MagAOX::logger::telem_stdcam::msgString ( void *  msgBuffer,
flatlogs::msgLenT  len 
)
inlinestatic

Get the message formatted for human consumption.

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

Definition at line 121 of file telem_stdcam.hpp.

◆ shutterState()

static std::string MagAOX::logger::telem_stdcam::shutterState ( void *  msgBuffer)
inlinestatic

◆ shutterStatusStr()

static std::string MagAOX::logger::telem_stdcam::shutterStatusStr ( void *  msgBuffer)
inlinestatic

Definition at line 336 of file telem_stdcam.hpp.

Referenced by getAccessor().

◆ synchro()

static bool MagAOX::logger::telem_stdcam::synchro ( void *  msgBuffer)
inlinestatic

◆ temp()

static float MagAOX::logger::telem_stdcam::temp ( void *  msgBuffer)
inlinestatic

◆ tempOnTarget()

static int MagAOX::logger::telem_stdcam::tempOnTarget ( void *  msgBuffer)
inlinestatic

Definition at line 318 of file telem_stdcam.hpp.

Referenced by getAccessor().

◆ tempSetpt()

static float MagAOX::logger::telem_stdcam::tempSetpt ( void *  msgBuffer)
inlinestatic

Definition at line 304 of file telem_stdcam.hpp.

Referenced by getAccessor().

◆ tempStatus()

static int MagAOX::logger::telem_stdcam::tempStatus ( void *  msgBuffer)
inlinestatic

Definition at line 311 of file telem_stdcam.hpp.

Referenced by getAccessor().

◆ tempStatusStr()

static std::string MagAOX::logger::telem_stdcam::tempStatusStr ( void *  msgBuffer)
inlinestatic

Definition at line 325 of file telem_stdcam.hpp.

Referenced by getAccessor().

◆ verify()

static bool MagAOX::logger::telem_stdcam::verify ( flatlogs::bufferPtrT logBuff,
flatlogs::msgLenT  len 
)
inlinestatic
Parameters
[in]logBuffBuffer containing the flatbuffer serialized message.
[in]lenlength of msgBuffer.

Definition at line 112 of file telem_stdcam.hpp.

◆ vshift()

static float MagAOX::logger::telem_stdcam::vshift ( void *  msgBuffer)
inlinestatic

◆ width()

static int MagAOX::logger::telem_stdcam::width ( void *  msgBuffer)
inlinestatic

◆ xbin()

static int MagAOX::logger::telem_stdcam::xbin ( void *  msgBuffer)
inlinestatic

◆ xcen()

static float MagAOX::logger::telem_stdcam::xcen ( void *  msgBuffer)
inlinestatic

◆ ybin()

static int MagAOX::logger::telem_stdcam::ybin ( void *  msgBuffer)
inlinestatic

◆ ycen()

static float MagAOX::logger::telem_stdcam::ycen ( void *  msgBuffer)
inlinestatic

Member Data Documentation

◆ defaultLevel

const flatlogs::logPrioT MagAOX::logger::telem_stdcam::defaultLevel = flatlogs::logPrio::LOG_TELEM
static

The default level.

Definition at line 31 of file telem_stdcam.hpp.

◆ eventCode

const flatlogs::eventCodeT MagAOX::logger::telem_stdcam::eventCode = eventCodes::TELEM_STDCAM
static

The event code.

Definition at line 28 of file telem_stdcam.hpp.

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

◆ lastRecord

timespec MagAOX::logger::telem_stdcam::lastRecord = {0,0}
static

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

Definition at line 33 of file telem_stdcam.hpp.


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