Client-side interface for injecting log data into the log queue. More...

#include <Logger.h>

Collaboration diagram for Logger:

Public Types
enum	TimePrecisionType { TIME_PRECISION_MICROS, TIME_PRECISION_MILLIS }

Public Member Functions
	Logger (const char *facilityIn)
	Constructor. More...

	Logger (const Str &facilityIn)
	Constructor. More...

virtual	~Logger ()
	Destructor. More...

void	log (LogEntry *entry)
	The generic "put this entry in the queue". More...

void	syslog (const char *msg, Syslog::Severity sev=Syslog::DEBUG)
	Create a syslog entry, push into queue, C char* version. More...

void	syslog (const char msgA, const char msgB, Syslog::Severity sev=Syslog::DEBUG)
	Create a syslog entry, push into queue, dual C char* version. More...

void	syslog (const char *msg, const size_t intMsg, Syslog::Severity sev=Syslog::DEBUG)
	Create a syslog entry, push into queue, C char*, size_t version. More...

void	syslog (const char *msg, const int intMsg, Syslog::Severity sev=Syslog::DEBUG)
	Create a syslog entry, push into queue, C char*, int version. More...

void	syslog (const char *msg, const double doubleMsg, Syslog::Severity sev=Syslog::DEBUG)
	Create a syslog entry, push into queue, C char*, double version. More...

void	syslog (const Str &msg, Syslog::Severity sev=Syslog::DEBUG)
	Create a syslog entry, push into queue, C++ Str version. More...

void	logSetAccuracy (Component component, DataElement dataElement)
	Create a new EventEntry for setting a DataElement's accuracy. More...

void	logComponentLoad (Component *component, const bool loaded)
	Create a new EventEntry for a Component load/unload. More...

void	logComponentRun (Component *component, const short loop)
	Create a new EventEntry for a (Mission)Component run. More...

void	logComponentFailure (Component *component, const FailureMode::FailType failure, const int failCount)
	Create a new EventEntry for a Component failure. More...

void	logData (DataAccessor &accessor, bool changed)
	Create a new DataEntry. More...

const CodedStr &	getFacility () const

Static Public Member Functions
static Timestamp &	LastCriticalErrorReceived ()

Private Member Functions
	Logger (const CodedStr *facilityIn)
	Protected Constructor for use by Slate. More...

Static Private Member Functions
static void	ClearCrtiticalErrorReceived ()

Private Attributes
const CodedStr &	facility_

Static Private Attributes
static Timestamp	CriticalErrorReceived_

Friends
class	Slate

class	CBIT

Detailed Description

Client-side interface for injecting log data into the log queue.

Injects data messages into a logging queue. This queue is then processed asynchronous to the logger call.

Constructor & Destructor Documentation

Logger::Logger ( const char * facilityIn )

Constructor.

Constructor takes a "facility" name.

Used to tag all subsequent log entries.

Parameters

facilityIn Name of module for use in logs.

Logger::Logger ( const Str & facilityIn )

Constructor.

Constructor takes a "facility" name.

Used to tag all subsequent log entries.

Parameters

facilityIn Name of module for use in logs.

Logger::~Logger ( )

virtual

Destructor.

Logger::Logger ( const CodedStr * facilityIn )

private

Protected Constructor for use by Slate.

Member Function Documentation

static void Logger::ClearCrtiticalErrorReceived ( )

inlinestaticprivate

References Timestamp::NOT_SET_TIME.

Referenced by CBIT::checkCriticals().

const CodedStr& Logger::getFacility ( ) const

inline

References facility_.

Referenced by Slate::EnableDirectoryWrites(), and Handler::getName().

static Timestamp& Logger::LastCriticalErrorReceived ( )

inlinestatic

References CriticalErrorReceived_.

Referenced by CBIT::checkCriticals().

void Logger::log ( LogEntry * entry )

void Logger::logComponentFailure	(	Component *	component,
		const FailureMode::FailType	failure,
		const int	failCount
	)

Create a new EventEntry for a Component failure.

References log().

Referenced by Component::setFailure().

void Logger::logComponentLoad	(	Component *	component,
		const bool	loaded
	)

Create a new EventEntry for a Component load/unload.

References log().

Referenced by Module::registerComponent(), and Module::unregisterComponent().

void Logger::logComponentRun	(	Component *	component,
		const short	loop
	)

Create a new EventEntry for a (Mission)Component run.

References log().

Referenced by MissionItem::initialize(), MissionItem::preempted(), MissionItem::run(), and MissionItem::uninitialize().

void Logger::logData	(	DataAccessor &	accessor,
		bool	changed
	)

Create a new DataEntry.

References DataAccessor::getElement(), DataElement::isBest(), and log().

Referenced by DataElement::registerWrite().

void Logger::logSetAccuracy	(	Component *	component,
		DataElement *	dataElement
	)

Create a new EventEntry for setting a DataElement's accuracy.

References log(), and EventEntry::SET_DATA_ACCURACY.

Referenced by DataElement::setAccuracy().

void Logger::syslog	(	const char *	msg,
		Syslog::Severity	sev = `Syslog::DEBUG`
	)

Create a syslog entry, push into queue, C char* version.

Create a syslog entry, push into queue.

References facility_, and log().

void Logger::syslog	(	const char *	msgA,
		const char *	msgB,
		Syslog::Severity	sev = `Syslog::DEBUG`
	)

Create a syslog entry, push into queue, dual C char* version.

Create a syslog entry, push into queue, dual C Str version.

References syslog().

void Logger::syslog	(	const char *	msg,
		const size_t	intMsg,
		Syslog::Severity	sev = `Syslog::DEBUG`
	)

Create a syslog entry, push into queue, C char*, size_t version.

Create a syslog entry, push into queue, C Str + size_t version.

References syslog().

void Logger::syslog	(	const char *	msg,
		const int	intMsg,
		Syslog::Severity	sev = `Syslog::DEBUG`
	)

Create a syslog entry, push into queue, C char*, int version.

Create a syslog entry, push into queue, C Str + int version.

References syslog().

void Logger::syslog	(	const char *	msg,
		const double	doubleMsg,
		Syslog::Severity	sev = `Syslog::DEBUG`
	)

Create a syslog entry, push into queue, C char*, double version.

Create a syslog entry, push into queue, C Str + double version.

References syslog().

void Logger::syslog	(	const Str &	msg,
		Syslog::Severity	sev = `Syslog::DEBUG`
	)

Create a syslog entry, push into queue, C++ Str version.

Create a syslog entry, push into queue.

References Str::cStr(), facility_, and log().

Friends And Related Function Documentation

friend class CBIT

friend

friend class Slate

friend

Member Data Documentation

Timestamp Logger::CriticalErrorReceived_

staticprivate

Referenced by LastCriticalErrorReceived(), and log().

const CodedStr& Logger::facility_

private

Referenced by getFacility(), and syslog().

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

/Volumes/ubuntu_share/lrauv-application/Source/logger/Logger.h
/Volumes/ubuntu_share/lrauv-application/Source/logger/Logger.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation