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

Logger module for logging and retrieving data runtime. More...

#include <Logger.hpp>

List of all members.

Public Types

enum  Policy { STEP_SIZE = 0, TIME_INTERVAL, END_POLICY, MAX_SPACE }

Public Member Functions

 DECLARE_TYPE (PhysicalLogger::size_type, size_type)
 Logger (LoggerAdapterPtr aLoggerAdapter)
 Constructor.
 ~Logger (void)
 Destructor.
void setLoggerPolicy (IntegerParam aMinimumStep, RealParam aMinimumTimeInterval, IntegerParam anEndPolicy, IntegerParam aMaxSpace)
 Sets logging policy that is a vector of 4 numerical values.
ECELL_API void setLoggerPolicy (PolymorphCref aParamList)
 Sets logging policy as a PolymorphVector of 4 numerical values.
ECELL_API const Polymorph getLoggerPolicy (void)
 Returns logging policy vector.
void log (RealParam aTime)
 Log current value that theLoggerAdapter gives with aTime.
ECELL_API
DataPointVectorSharedPtr 
getData (void) const
 Returns contents of the whole logger.
ECELL_API
DataPointVectorSharedPtr 
getData (RealParam aStartTime, RealParam anEndTime) const
 Returns a slice of the data from aStartTime to anEndTime.
ECELL_API
DataPointVectorSharedPtr 
getData (RealParam aStartTime, RealParam anEndTime, RealParam anInterval) const
 Returns a summary of the data from aStartTime to anEndTime with intervals anInterval between data elements.
ECELL_API const Real getStartTime (void) const
 Returns time of the first element in Logger.
ECELL_API const Real getEndTime (void) const
 Returns time of the last element in Logger.
const size_type getSize () const
 Returns size of logger.
ECELL_API void setMinimumInterval (RealParam anInterval)
 DEPRECATED - Use setLoggerPolicy.
const Real getMinimumInterval (void) const
 DEPRECATED - Use getLoggerPolicy.
void flush ()
 This method does nothing as of version 3.1.103.

Protected Member Functions

DataPointVectorIterator binary_search (DataPointVectorIterator begin, DataPointVectorIterator end, RealParam t)
 

For internal use only.


void pushData (RealParam aTime, RealParam aValue)
 Writes data (aTime, aValue ) onto the logger.

Static Protected Member Functions

static
DataPointVectorSharedPtr 
createEmptyVector ()


Detailed Description

Logger module for logging and retrieving data runtime.

Constructor & Destructor Documentation

libecs::Logger::Logger ( LoggerAdapterPtr  aLoggerAdapter  ) 

Constructor.

Takes up the ownership of the given LoggerAdapter.


Member Function Documentation

void libecs::Logger::setLoggerPolicy ( IntegerParam  aMinimumStep,
RealParam  aMinimumTimeInterval,
IntegerParam  anEndPolicy,
IntegerParam  aMaxSpace 
)

Sets logging policy that is a vector of 4 numerical values.

0 (int) - minimum step size between logs 1 (real) - minimum time interval between logs 2 (int) - action to be taken when disk space runs out 3 (int) - user set max disk space, if 0 nothing


The documentation for this class was generated from the following file:
Generated on Fri Aug 31 18:33:05 2007 for E-CELL C++ libraries (libecs and libemc) 3.1.105 by  doxygen 1.5.3