libecs::LoggerBroker Class Reference
[The Data Logging Module.]

LoggerBroker creates and administrates Loggers in a model. More...

#include <LoggerBroker.hpp>

List of all members.

Public Member Functions
	DECLARE_MAP (const FullPN, LoggerPtr, std::less< const FullPN >, LoggerMap)
	LoggerBroker (ModelRef aModel)
ECELL_API LoggerPtr	getLogger (FullPNCref aFullPN) const
	Get or create a Logger for a PropertySlot.
ECELL_API LoggerPtr	createLogger (FullPNCref aFullPN, PolymorphVectorCref aParamList)
void	flush ()
	Flush the data in all the Loggers immediately.
LoggerMapCref	getLoggerMap () const
	Get a const reference to the LoggerMap.

---

Detailed Description

LoggerBroker creates and administrates Loggers in a model.

This class creates, holds in a map which associates FullPN with a Logger, and responds to requests to Loggers.

See also:

FullPN

Logger

---

Member Function Documentation

ECELL_API LoggerPtr libecs::LoggerBroker::getLogger

(

FullPNCref

aFullPN

)

const

Get or create a Logger for a PropertySlot.

This method first look for a Logger object which is logging the specified PropertySlot, and if it is found, returns the Logger. If there is no Logger connected to the PropertySlot yet, it creates and returns a new Logger.

FIXME: doc for interval needed

Parameters:

	aFullPN	a FullPN of the requested FullPN
	anInterval	a logging interval

Returns:

a borrowed pointer to the Logger

void libecs::LoggerBroker::flush

(

)

Flush the data in all the Loggers immediately.

Usually Loggers record data with logging intervals. This method orders every Logger to write the data immediately ignoring the logging interval.

LoggerMapCref libecs::LoggerBroker::getLoggerMap

(

)

const [inline]

Get a const reference to the LoggerMap.

Use this method for const operations such as LoggerMap::size() and LoggerMap::begin().

Returns:

a const reference to the LoggerMap.

---

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

• LoggerBroker.hpp