MagAOX::logger::logMeta Struct Reference

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

#include <logMeta.hpp>

Collaboration diagram for MagAOX::logger::logMeta:

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 }

Public Member Functions
	logMeta (const logMetaSpec &lms)
std::string	keyword ()
std::string	comment ()
int	setLog (const logMetaSpec &)
std::string	value (logMap &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
std::string	valueNumber (logMap &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
std::string	valueString (logMap &lm, const flatlogs::timespecX &stime, const flatlogs::timespecX &atime)
mx::fits::fitsHeaderCard	card (logMap &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 252 of file logMeta.hpp.

Member Enumeration Documentation

metaTypes

enum MagAOX::logger::logMeta::metaTypes

Enumerator
State
Continuous

Definition at line 287 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 255 of file logMeta.hpp.

Constructor & Destructor Documentation

logMeta()

MagAOX::logger::logMeta::logMeta

(

const logMetaSpec &

lms

)

Parameters

[in]

lms

the specification of this meta data entry

Definition at line 53 of file logMeta.cpp.

Member Function Documentation

card()

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

Definition at line 446 of file logMeta.cpp.

comment()

std::string MagAOX::logger::logMeta::comment

(

)

Definition at line 63 of file logMeta.cpp.

keyword()

std::string MagAOX::logger::logMeta::keyword

(

)

Definition at line 58 of file logMeta.cpp.

setLog()

int MagAOX::logger::logMeta::setLog

(

const logMetaSpec &

lms

)

Definition at line 68 of file logMeta.cpp.

Referenced by logMeta().

value()

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

Definition at line 136 of file logMeta.cpp.

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

valueNumber()

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

Definition at line 163 of file logMeta.cpp.

Referenced by value().

valueString()

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

Definition at line 419 of file logMeta.cpp.

Referenced by value().

Member Data Documentation

m_detail

logMetaDetail MagAOX::logger::logMeta::m_detail

protected

Definition at line 296 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 301 of file logMeta.hpp.

Referenced by valueNumber(), and valueString().

m_invalidValue

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

protected

Definition at line 299 of file logMeta.hpp.

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

m_isValid

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

protected

Definition at line 298 of file logMeta.hpp.

m_spec

logMetaSpec MagAOX::logger::logMeta::m_spec

protected

Definition at line 295 of file logMeta.hpp.

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

---

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

• libMagAOX/logger/logMeta.hpp
• libMagAOX/logger/logMeta.cpp