#include <flxLogger.h>

Inheritance diagram for flxLogger:

Public Types
enum	Timestamp_t { TimeStampNone , TimeStampMillis , TimeStampEpoch , TimeStampDateTimeUSA , TimeStampDateTime , TimeStampISO8601 , TimeStampISO8601TZ }

Public Member Functions
	flxLogger ()

void	logMessage (char header, char message)

template<typename... Args>
	flxLogger (flxOutputFormat *a1, Args &&...args)

template<typename... Args>
	flxLogger (flxOutputFormat &a1, Args &&...args)

template<typename... Args>
	flxLogger (flxOperation *a1, Args &...args)

template<typename... Args>
	flxLogger (flxOperation &a1, Args &...args)

template<typename... Args>
	flxLogger (flxParameterOut *a1, Args &...args)

template<typename... Args>
	flxLogger (flxParameterOut &a1, Args &...args)

void	logObservation (void)

void	listen (flxSignalVoid &theEvent)

template<typename T >
void	logObservation (T value)

template<typename T >
void	listen (T &theEvent)

void	logEvent (flxOperation *theObj)

void	listenLogEvent (flxSignalVoid &theEvent, flxOperation *theObj)

template<typename T >
void	logEvent (flxOperation *theObj, T value)

template<typename T >
void	listenLogEvent (T &theEvent, flxOperation *theObj)

template<typename... Args>
void	add (flxOutputFormat *a1, Args &&...args)

template<typename... Args>
void	add (flxOutputFormat &a1, Args &&...args)

template<typename... Args>
void	add (flxOperation &a1, Args &&...args)

template<typename... Args>
void	add (flxOperation *a1, Args &&...args)

template<typename... Args>
void	add (flxParameterOut *a1, Args &&...args)

template<typename... Args>
void	add (flxParameterOut &a1, Args &&...args)

template<typename... Args>
void	add (flxParameterOutList &a1, Args &&...args)

template<typename... Args>
void	add (flxProperty &a1, Args &&...args)

template<typename... Args>
void	add (flxProperty *a1, Args &&...args)

template<typename... Args>
void	add (flxPropertyList &a1, Args &&...args)

template<typename... Args>
void	remove (flxOperation &a1, Args &&...args)

template<typename... Args>
void	remove (flxOperation *a1, Args &&...args)

void	setEnableLogRate (bool enable)

bool	enabledLogRate (void)

float	getLogRate (void)

Public Member Functions inherited from flxActionType< flxLogger >
flxTypeID	getType (void)

Public Member Functions inherited from flxAction
virtual bool	initialize (void)

Public Member Functions inherited from flxOperation
virtual flxTypeID	getType (void)

virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...

virtual bool	onSave (flxStorageBlock *stBlk)

virtual bool	onRestore (flxStorageBlock *stBlk)

Public Member Functions inherited from flxObject
	flxObject ()

virtual	~flxObject ()

void	setParent (flxObject *parent)

void	setParent (flxObject &parent)

flxObject *	parent ()

void	setHidden (bool bHide=true)

bool	hidden ()

void	setIsDirty (bool bDirty=true)

bool	isDirty (void)

virtual bool	onSave (flxStorageBlock *stBlk)

virtual bool	save (flxStorage *pStorage)

virtual bool	onRestore (flxStorageBlock *stBlk)

virtual bool	restore (flxStorage *pStorage)

virtual flxTypeID	getType (void)

virtual bool	save (flxStorage *)=0

virtual bool	restore (flxStorage *)=0

Public Member Functions inherited from _flxPropertyContainer
	_flxPropertyContainer ()

void	addProperty (flxProperty *newProperty)

void	addProperty (flxProperty &newProperty)

void	removeProperty (flxProperty *rmProp)

void	removeProperty (flxProperty &rmProp)

flxPropertyList &	getProperties (void)

uint	nProperties (void)

bool	saveProperties (flxStorageBlock *stBlk)

bool	restoreProperties (flxStorageBlock *stBlk)

size_t	propertySaveSize ()

void	hideProperty (flxProperty &theProp)

Public Member Functions inherited from flxDescriptor
	flxDescriptor ()

void	setName (const char *new_name)
	Set the Name object - storing the pointer to the provided string No allocation is performed. If the previous name was allocated, it is freed. More...

void	setName (const char new_name, const char new_desc)
	Set the Name object and the Description for the object. Both strings are constants. More...

void	setName (char *new_name)
	Set the Name object, but makes a copy of the input string since the input is not const. If the previous name was allocated, it is freed. More...

const char *	name ()
	Return a const char pointer to the name of the object. More...

std::string	name_ (void)
	Returns a std::string of the name of the object. More...

void	setDescription (const char *new_desc)
	Set the Description object - the input value is constant and not copied. If the previous description was allocated, it is freed. More...

void	setDescription (char *new_desc)
	Set the Description object - the input value is not constant and is copied. If the previous description was allocated, it is freed. More...

const char *	description ()
	Return the constant C string pointer to the description of the object. More...

std::string	description_ (void)
	Return the description of the object as a std::string. More...

void	setTitle (const char *title)
	Set the Title object - the title is optional and is used mostly for UX or organizational purposes. The input value is constant and not copied. If the previous title was allocated, it is freed. More...

void	setTitleAlloc (char *new_title)
	Set the Title of the object , but make an explict copy of the provided string. More...

const char *	title (void)
	Return the C constant string pointer to the title of the object. More...

Public Member Functions inherited from _flxParameterContainer
void	addParameter (flxParameterIn *newParam, bool head=false)

void	addParameter (flxParameterIn &newParam, bool head=false)

void	removeParameter (flxParameterIn *rmParam)

void	removeParameter (flxParameterIn &rmParam)

size_t	nInputParameters ()

void	addParameter (flxParameterOut *newParam, bool head=false)

void	addParameter (flxParameterOut &newParam, bool head=false)

void	removeParameter (flxParameterOut *rmParam)

void	removeParameter (flxParameterOut &rmParam)

size_t	nOutputParameters ()

flxParameterOutList &	getOutputParameters (void)

flxParameterInList &	getInputParameters (void)

Public Attributes
flxPropertyRWUInt32< flxLogger, &flxLogger::get_ts_type, &flxLogger::set_ts_type >	timestampMode

flxParameterOutString< flxLogger, &flxLogger::get_timestamp >	timestamp

flxPropertyRWBool< flxLogger, &flxLogger::get_id_enable, &flxLogger::set_id_enable >	enableIDOutput = {false}

flxParameterOutString< flxLogger, &flxLogger::get_device_id >	getDeviceID

flxPropertyRWBool< flxLogger, &flxLogger::get_name_enable, &flxLogger::set_name_enable >	enableNameOutput = {false}

flxParameterOutString< flxLogger, &flxLogger::get_name >	getLocalName

flxPropertyRWBool< flxLogger, &flxLogger::get_num_mode, &flxLogger::set_num_mode >	numberMode = {false}

flxParameterOutUInt32< flxLogger, &flxLogger::get_sample_number >	sampleNumber

flxPropertyUInt32< flxLogger >	numberIncrement = {1, 1, 10000}

flxParameterInUInt32< flxLogger, &flxLogger::reset_sample_number >	resetSampleNumber = {0, 10000}

flxPropertyRWBool< flxLogger, &flxLogger::enabledLogRate, &flxLogger::setEnableLogRate >	logRateMetric = {false}

Additional Inherited Members
Static Public Member Functions inherited from flxActionType< flxLogger >
static flxTypeID	type (void)

Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)

Protected Attributes inherited from flxDescriptor
const char *	_name

bool	_nameAlloc

const char *	_desc

bool	_descAlloc

const char *	_title

bool	_titleAlloc

Member Enumeration Documentation

◆ Timestamp_t

enum flxLogger::Timestamp_t

Enumerator
TimeStampNone
TimeStampMillis
TimeStampEpoch
TimeStampDateTimeUSA
TimeStampDateTime
TimeStampISO8601
TimeStampISO8601TZ

Constructor & Destructor Documentation

◆ flxLogger() [1/7]

flxLogger::flxLogger ( )

◆ flxLogger() [2/7]

template<typename... Args>

flxLogger::flxLogger	(	flxOutputFormat *	a1,
		Args &&...	args
	)

inline

◆ flxLogger() [3/7]

template<typename... Args>

flxLogger::flxLogger	(	flxOutputFormat &	a1,
		Args &&...	args
	)

inline

◆ flxLogger() [4/7]

template<typename... Args>

flxLogger::flxLogger	(	flxOperation *	a1,
		Args &...	args
	)

inline

◆ flxLogger() [5/7]

template<typename... Args>

flxLogger::flxLogger	(	flxOperation &	a1,
		Args &...	args
	)

inline

◆ flxLogger() [6/7]

template<typename... Args>

flxLogger::flxLogger	(	flxParameterOut *	a1,
		Args &...	args
	)

inline

◆ flxLogger() [7/7]

template<typename... Args>

flxLogger::flxLogger	(	flxParameterOut &	a1,
		Args &...	args
	)

inline

Member Function Documentation

◆ add() [1/10]

template<typename... Args>

void flxLogger::add	(	flxOperation &	a1,
		Args &&...	args
	)

inline

◆ add() [2/10]

template<typename... Args>

void flxLogger::add	(	flxOperation *	a1,
		Args &&...	args
	)

inline

◆ add() [3/10]

template<typename... Args>

void flxLogger::add	(	flxOutputFormat &	a1,
		Args &&...	args
	)

inline

◆ add() [4/10]

template<typename... Args>

void flxLogger::add	(	flxOutputFormat *	a1,
		Args &&...	args
	)

inline

◆ add() [5/10]

template<typename... Args>

void flxLogger::add	(	flxParameterOut &	a1,
		Args &&...	args
	)

inline

◆ add() [6/10]

template<typename... Args>

void flxLogger::add	(	flxParameterOut *	a1,
		Args &&...	args
	)

inline

◆ add() [7/10]

template<typename... Args>

void flxLogger::add	(	flxParameterOutList &	a1,
		Args &&...	args
	)

inline

◆ add() [8/10]

template<typename... Args>

void flxLogger::add	(	flxProperty &	a1,
		Args &&...	args
	)

inline

◆ add() [9/10]

template<typename... Args>

void flxLogger::add	(	flxProperty *	a1,
		Args &&...	args
	)

inline

◆ add() [10/10]

template<typename... Args>

void flxLogger::add	(	flxPropertyList &	a1,
		Args &&...	args
	)

inline

◆ enabledLogRate()

bool flxLogger::enabledLogRate ( void )

inline

◆ getLogRate()

float flxLogger::getLogRate ( void )

◆ listen() [1/2]

void flxLogger::listen ( flxSignalVoid & theEvent )

inline

◆ listen() [2/2]

template<typename T >

void flxLogger::listen ( T & theEvent )

inline

◆ listenLogEvent() [1/2]

void flxLogger::listenLogEvent	(	flxSignalVoid &	theEvent,
		flxOperation *	theObj
	)

inline

◆ listenLogEvent() [2/2]

template<typename T >

void flxLogger::listenLogEvent	(	T &	theEvent,
		flxOperation *	theObj
	)

inline

◆ logEvent() [1/2]

void flxLogger::logEvent ( flxOperation * theObj )

inline

◆ logEvent() [2/2]

template<typename T >

void flxLogger::logEvent	(	flxOperation *	theObj,
		T	value
	)

inline

◆ logMessage()

void flxLogger::logMessage	(	char *	header,
		char *	message
	)

◆ logObservation() [1/2]

template<typename T >

void flxLogger::logObservation ( T value )

inline

◆ logObservation() [2/2]

void flxLogger::logObservation ( void )

◆ remove() [1/2]

template<typename... Args>

void flxLogger::remove	(	flxOperation &	a1,
		Args &&...	args
	)

inline

◆ remove() [2/2]

template<typename... Args>

void flxLogger::remove	(	flxOperation *	a1,
		Args &&...	args
	)

inline

◆ setEnableLogRate()

void flxLogger::setEnableLogRate ( bool enable )

Member Data Documentation

◆ enableIDOutput

flxPropertyRWBool<flxLogger, &flxLogger::get_id_enable, &flxLogger::set_id_enable> flxLogger::enableIDOutput = {false}

◆ enableNameOutput

flxPropertyRWBool<flxLogger, &flxLogger::get_name_enable, &flxLogger::set_name_enable> flxLogger::enableNameOutput = {false}

◆ getDeviceID

flxParameterOutString<flxLogger, &flxLogger::get_device_id> flxLogger::getDeviceID

◆ getLocalName

flxParameterOutString<flxLogger, &flxLogger::get_name> flxLogger::getLocalName

◆ logRateMetric

flxPropertyRWBool<flxLogger, &flxLogger::enabledLogRate, &flxLogger::setEnableLogRate> flxLogger::logRateMetric = {false}

◆ numberIncrement

flxPropertyUInt32<flxLogger> flxLogger::numberIncrement = {1, 1, 10000}

◆ numberMode

flxPropertyRWBool<flxLogger, &flxLogger::get_num_mode, &flxLogger::set_num_mode> flxLogger::numberMode = {false}

◆ resetSampleNumber

flxParameterInUInt32<flxLogger, &flxLogger::reset_sample_number> flxLogger::resetSampleNumber = {0, 10000}

◆ sampleNumber

flxParameterOutUInt32<flxLogger, &flxLogger::get_sample_number> flxLogger::sampleNumber

◆ timestamp

flxParameterOutString<flxLogger, &flxLogger::get_timestamp> flxLogger::timestamp

◆ timestampMode

flxPropertyRWUInt32<flxLogger, &flxLogger::get_ts_type, &flxLogger::set_ts_type> flxLogger::timestampMode

Initial value:

= {
        TimeStampNone,
        {{"No Timestamp", TimeStampNone},
         {"Milliseconds since program start", TimeStampMillis},
         {"Seconds since Epoch", TimeStampEpoch},
         {"Date Time - USA Date format", TimeStampDateTimeUSA},
         {"Date Time", TimeStampDateTime},
         {"ISO8601 Timestamp", TimeStampISO8601},
         {"ISO8601 Timestamp with Time Zone", TimeStampISO8601TZ}}}

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

src/core/flux_logging/flxLogger.h
src/core/flux_logging/flxLogger.cpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ Timestamp_t

Constructor & Destructor Documentation

◆ flxLogger() [1/7]

◆ flxLogger() [2/7]

◆ flxLogger() [3/7]

◆ flxLogger() [4/7]

◆ flxLogger() [5/7]

◆ flxLogger() [6/7]

◆ flxLogger() [7/7]

Member Function Documentation

◆ add() [1/10]

◆ add() [2/10]

◆ add() [3/10]

◆ add() [4/10]

◆ add() [5/10]

◆ add() [6/10]

◆ add() [7/10]

◆ add() [8/10]

◆ add() [9/10]

◆ add() [10/10]

◆ enabledLogRate()

◆ getLogRate()

◆ listen() [1/2]

◆ listen() [2/2]

◆ listenLogEvent() [1/2]

◆ listenLogEvent() [2/2]

◆ logEvent() [1/2]

◆ logEvent() [2/2]

◆ logMessage()

◆ logObservation() [1/2]

◆ logObservation() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ setEnableLogRate()

Member Data Documentation

◆ enableIDOutput

◆ enableNameOutput

◆ getDeviceID

◆ getLocalName

◆ logRateMetric

◆ numberIncrement

◆ numberMode

◆ resetSampleNumber

◆ sampleNumber

◆ timestamp

◆ timestampMode