API
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
MagAOX::logger::logMeta Struct Reference

Manage meta data for a log entry. More...

#include <logMeta.hpp>

Collaboration diagram for MagAOX::logger::logMeta:
Collaboration graph

Public Types

enum  valTypes {
  String = mx::fits::fitsType<std::string>() , Bool = mx::fits::fitsType<bool>() , Char = mx::fits::fitsType<char>() , UChar = mx::fits::fitsType<unsigned char>() ,
  Short = mx::fits::fitsType<short>() , UShort = mx::fits::fitsType<unsigned short>() , Int = mx::fits::fitsType<int>() , UInt = mx::fits::fitsType<unsigned int>() ,
  Long = mx::fits::fitsType<long>() , ULong = mx::fits::fitsType<unsigned long>() , LongLong = mx::fits::fitsType<long long>() , ULongLong = mx::fits::fitsType<unsigned long long>() ,
  Float = mx::fits::fitsType<float>() , Double = mx::fits::fitsType<double>() , Vector_String = 10000 , Vector_Bool = 10002 ,
  Vector_Char = 10004 , Vector_UChar = 10006 , Vector_Short = 10008 , Vector_UShort = 10010 ,
  Vector_Int = 10012 , Vector_UInt = 10014 , Vector_Long = 10016 , Vector_ULong = 10018 ,
  Vector_LongLong = 10020 , Vector_ULongLong = 10022 , Vector_Float = 10024 , Vector_Double = 10026
}
 
enum  metaTypes { State , Continuous }
 
typedef XWC_DEFAULT_VERBOSITY verboseT
 

Public Member Functions

 logMeta (const logMetaSpec &lms)
 
const std::string & device ()
 
const std::string & keyword ()
 
const std::string & comment ()
 
int setLog (const logMetaSpec &)
 
std::string value (logMap< verboseT > &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
 
std::string valueNumber (logMap< verboseT > &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
 
std::string valueString (logMap< verboseT > &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
 
mx::fits::fitsHeaderCard< verboseT > card (logMap< verboseT > &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
 

Protected Attributes

logMetaSpec m_spec
 
logMetaDetail m_detail
 
bool m_isValid { false }
 
std::string m_invalidValue { "invalid" }
 
char * m_hint { nullptr }
 

Detailed Description

Manage meta data for a log entry.

Handles cases where log is a state, i.e. has one of a finite number of values, or is a continuous variable, e.g. a temperature.

Contains the information to construct a FITS header card.

Definition at line 231 of file logMeta.hpp.

Member Typedef Documentation

◆ verboseT

typedef XWC_DEFAULT_VERBOSITY MagAOX::logger::logMeta::verboseT

Definition at line 233 of file logMeta.hpp.

Member Enumeration Documentation

◆ metaTypes

enum MagAOX::logger::logMeta::metaTypes
Enumerator
State 
Continuous 

Definition at line 268 of file logMeta.hpp.

◆ valTypes

enum MagAOX::logger::logMeta::valTypes
Enumerator
String 
Bool 
Char 
UChar 
Short 
UShort 
Int 
UInt 
Long 
ULong 
LongLong 
ULongLong 
Float 
Double 
Vector_String 
Vector_Bool 
Vector_Char 
Vector_UChar 
Vector_Short 
Vector_UShort 
Vector_Int 
Vector_UInt 
Vector_Long 
Vector_ULong 
Vector_LongLong 
Vector_ULongLong 
Vector_Float 
Vector_Double 

Definition at line 236 of file logMeta.hpp.

Constructor & Destructor Documentation

◆ logMeta()

MagAOX::logger::logMeta::logMeta ( const logMetaSpec &  lms)
Parameters
[in]lmsthe specification of this meta data entry

Definition at line 56 of file logMeta.cpp.

References setLog().

Member Function Documentation

◆ card()

mx::fits::fitsHeaderCard< logMeta::verboseT > MagAOX::logger::logMeta::card ( logMap< verboseT > &  lm,
const flatlogs::timespecX &  stime,
const flatlogs::timespecX &  atime 
)

Definition at line 454 of file logMeta.cpp.

References MagAOX::logger::logMetaSpec::comment, MagAOX::logger::logMetaSpec::device, MagAOX::logger::logMetaDetail::hierarch, MagAOX::logger::logMetaSpec::keyword, m_detail, m_invalidValue, m_spec, String, MagAOX::logger::logMetaDetail::valType, and value().

◆ comment()

const std::string & MagAOX::logger::logMeta::comment ( )

Definition at line 71 of file logMeta.cpp.

References MagAOX::logger::logMetaSpec::comment, and m_spec.

◆ device()

const std::string & MagAOX::logger::logMeta::device ( )

Definition at line 61 of file logMeta.cpp.

References MagAOX::logger::logMetaSpec::device, and m_spec.

◆ keyword()

const std::string & MagAOX::logger::logMeta::keyword ( )

Definition at line 66 of file logMeta.cpp.

References MagAOX::logger::logMetaSpec::keyword, and m_spec.

◆ setLog()

int MagAOX::logger::logMeta::setLog ( const logMetaSpec &  lms)

Definition at line 76 of file logMeta.cpp.

References Bool, Char, MagAOX::logger::logMetaSpec::comment, MagAOX::logger::logMetaDetail::comment, MagAOX::logger::logMetaSpec::device, Double, MagAOX::logger::logMetaSpec::eventCode, Float, MagAOX::logger::logMetaSpec::format, MagAOX::logger::logMetaDetail::format, Int, MagAOX::logger::logMetaSpec::keyword, MagAOX::logger::logMetaDetail::keyword, MagAOX::logger::logMemberAccessor(), Long, m_detail, m_spec, MagAOX::logger::logMetaSpec::member, Short, String, UChar, UInt, ULong, UShort, MagAOX::logger::logMetaDetail::valType, Vector_Bool, and Vector_Float.

Referenced by logMeta().

◆ value()

std::string MagAOX::logger::logMeta::value ( logMap< verboseT > &  lm,
const flatlogs::timespecX &  stime,
const flatlogs::timespecX &  atime 
)

Definition at line 144 of file logMeta.cpp.

References MagAOX::logger::logMetaDetail::accessor, m_detail, m_invalidValue, String, MagAOX::logger::logMetaDetail::valType, valueNumber(), and valueString().

Referenced by audibleAlerts.personality.Operation::__str__(), card(), and audibleAlerts.personality.Transition::compare().

◆ valueNumber()

std::string MagAOX::logger::logMeta::valueNumber ( logMap< verboseT > &  lm,
const flatlogs::timespecX &  stime,
const flatlogs::timespecX &  atime 
)

Definition at line 171 of file logMeta.cpp.

References MagAOX::logger::logMetaDetail::accessor, Bool, Char, Continuous, MagAOX::logger::logMetaSpec::device, Double, MagAOX::logger::logMetaSpec::eventCode, Float, MagAOX::logger::logMetaSpec::format, MagAOX::logger::getLogContVal(), MagAOX::logger::getLogStateVal(), Int, Long, LongLong, m_detail, m_hint, m_invalidValue, m_spec, MagAOX::logger::logMetaDetail::metaType, Short, State, UChar, UInt, ULong, ULongLong, UShort, MagAOX::logger::logMetaDetail::valType, Vector_Bool, and Vector_Float.

Referenced by value().

◆ valueString()

std::string MagAOX::logger::logMeta::valueString ( logMap< verboseT > &  lm,
const flatlogs::timespecX &  stime,
const flatlogs::timespecX &  atime 
)

Definition at line 427 of file logMeta.cpp.

References MagAOX::logger::logMetaDetail::accessor, MagAOX::logger::logMetaSpec::device, MagAOX::logger::logMetaSpec::eventCode, MagAOX::logger::getLogStateVal(), m_detail, m_hint, m_invalidValue, m_spec, MagAOX::logger::logMetaDetail::metaType, and State.

Referenced by value().

Member Data Documentation

◆ m_detail

logMetaDetail MagAOX::logger::logMeta::m_detail
protected

Definition at line 276 of file logMeta.hpp.

Referenced by card(), setLog(), value(), valueNumber(), and valueString().

◆ m_hint

char* MagAOX::logger::logMeta::m_hint { nullptr }
protected

Definition at line 281 of file logMeta.hpp.

Referenced by valueNumber(), and valueString().

◆ m_invalidValue

std::string MagAOX::logger::logMeta::m_invalidValue { "invalid" }
protected

Definition at line 279 of file logMeta.hpp.

Referenced by card(), value(), valueNumber(), and valueString().

◆ m_isValid

bool MagAOX::logger::logMeta::m_isValid { false }
protected

Definition at line 278 of file logMeta.hpp.

◆ m_spec

logMetaSpec MagAOX::logger::logMeta::m_spec
protected

Definition at line 275 of file logMeta.hpp.

Referenced by card(), comment(), device(), keyword(), setLog(), valueNumber(), and valueString().

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