Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
PointMatcherSupport::FileLogger Struct Reference

#include <LoggerImpl.h>

Inheritance diagram for PointMatcherSupport::FileLogger:
Inheritance graph
[legend]

Public Member Functions

virtual void beginInfoEntry (const char *file, unsigned line, const char *func)
 Start a new entry into the info channel. More...
 
virtual void beginWarningEntry (const char *file, unsigned line, const char *func)
 Start a new entry into the warning channel. More...
 
 FileLogger (const Parameters &params=Parameters())
 
virtual void finishInfoEntry (const char *file, unsigned line, const char *func)
 Finish the entry into the info channel. More...
 
virtual void finishWarningEntry (const char *file, unsigned line, const char *func)
 Finish the entry into the warning channel. More...
 
virtual bool hasInfoChannel () const
 Return whether this logger provides the info channel. More...
 
virtual bool hasWarningChannel () const
 Return whether this logger provides the warning channel. More...
 
virtual std::ostream * infoStream ()
 Return the info stream, 0 if hasInfoChannel() returns false. More...
 
virtual std::ostream * warningStream ()
 Return the warning stream, 0 if hasWarningChannel() returns false. More...
 
- Public Member Functions inherited from PointMatcherSupport::Logger
 Logger ()
 Construct without parameter. More...
 
 Logger (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual ~Logger ()
 Virtual destructor, do nothing. More...
 
- Public Member Functions inherited from PointMatcherSupport::Parametrizable
template<typename S >
get (const std::string &paramName)
 Return the value of paramName, lexically-casted to S. More...
 
std::string getParamValueString (const std::string &paramName)
 Get the value of a parameter, as a string. More...
 
 Parametrizable ()
 Construct a documentation of parameters from a description in the source. More...
 
 Parametrizable (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with documented parameters. More...
 
virtual ~Parametrizable ()
 Virtual destructor, do nothing. More...
 

Static Public Member Functions

static const ParametersDoc availableParameters ()
 
static const std::string description ()
 
- Static Public Member Functions inherited from PointMatcherSupport::Parametrizable
template<typename S >
static bool Comp (std::string a, std::string b)
 Return whether a < b, lexically casted to S. More...
 

Public Attributes

const bool displayLocation
 
const std::string infoFileName
 
const std::string warningFileName
 
- Public Attributes inherited from PointMatcherSupport::Parametrizable
const std::string className
 name of the class More...
 
Parameters parameters
 parameters with their values encoded in string More...
 
const ParametersDoc parametersDoc
 documentation of parameters More...
 
ParametersUsed parametersUsed
 parameters whose value has actually been read More...
 

Protected Attributes

std::ofstream _infoFileStream
 
std::ostream _infoStream
 
std::ofstream _warningFileStream
 
std::ostream _warningStream
 

Additional Inherited Members

- Public Types inherited from PointMatcherSupport::Parametrizable
typedef bool(* LexicalComparison) (std::string a, std::string b)
 A function that returns whether a is smaller than b. More...
 
typedef std::string Parameter
 alias More...
 
typedef std::map< std::string, ParameterParameters
 Parameters stored as a map of string->string. More...
 
typedef std::vector< ParameterDocParametersDoc
 The documentation of all parameters. More...
 
typedef std::set< std::string > ParametersUsed
 Parameters whose value has been read. More...
 

Detailed Description

Definition at line 55 of file LoggerImpl.h.

Constructor & Destructor Documentation

◆ FileLogger()

PointMatcherSupport::FileLogger::FileLogger ( const Parameters params = Parameters())

Definition at line 45 of file LoggerImpl.cpp.

Member Function Documentation

◆ availableParameters()

static const ParametersDoc PointMatcherSupport::FileLogger::availableParameters ( )
inlinestatic

Definition at line 61 of file LoggerImpl.h.

◆ beginInfoEntry()

void PointMatcherSupport::FileLogger::beginInfoEntry ( const char *  file,
unsigned  line,
const char *  func 
)
virtual

Start a new entry into the info channel.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 87 of file LoggerImpl.cpp.

◆ beginWarningEntry()

void PointMatcherSupport::FileLogger::beginWarningEntry ( const char *  file,
unsigned  line,
const char *  func 
)
virtual

Start a new entry into the warning channel.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 109 of file LoggerImpl.cpp.

◆ description()

static const std::string PointMatcherSupport::FileLogger::description ( )
inlinestatic

Definition at line 57 of file LoggerImpl.h.

◆ finishInfoEntry()

void PointMatcherSupport::FileLogger::finishInfoEntry ( const char *  file,
unsigned  line,
const char *  func 
)
virtual

Finish the entry into the info channel.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 96 of file LoggerImpl.cpp.

◆ finishWarningEntry()

void PointMatcherSupport::FileLogger::finishWarningEntry ( const char *  file,
unsigned  line,
const char *  func 
)
virtual

Finish the entry into the warning channel.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 118 of file LoggerImpl.cpp.

◆ hasInfoChannel()

bool PointMatcherSupport::FileLogger::hasInfoChannel ( ) const
virtual

Return whether this logger provides the info channel.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 82 of file LoggerImpl.cpp.

◆ hasWarningChannel()

bool PointMatcherSupport::FileLogger::hasWarningChannel ( ) const
virtual

Return whether this logger provides the warning channel.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 104 of file LoggerImpl.cpp.

◆ infoStream()

std::ostream * PointMatcherSupport::FileLogger::infoStream ( )
virtual

Return the info stream, 0 if hasInfoChannel() returns false.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 91 of file LoggerImpl.cpp.

◆ warningStream()

std::ostream * PointMatcherSupport::FileLogger::warningStream ( )
virtual

Return the warning stream, 0 if hasWarningChannel() returns false.

Reimplemented from PointMatcherSupport::Logger.

Definition at line 113 of file LoggerImpl.cpp.

Member Data Documentation

◆ _infoFileStream

std::ofstream PointMatcherSupport::FileLogger::_infoFileStream
protected

Definition at line 86 of file LoggerImpl.h.

◆ _infoStream

std::ostream PointMatcherSupport::FileLogger::_infoStream
protected

Definition at line 88 of file LoggerImpl.h.

◆ _warningFileStream

std::ofstream PointMatcherSupport::FileLogger::_warningFileStream
protected

Definition at line 87 of file LoggerImpl.h.

◆ _warningStream

std::ostream PointMatcherSupport::FileLogger::_warningStream
protected

Definition at line 89 of file LoggerImpl.h.

◆ displayLocation

const bool PointMatcherSupport::FileLogger::displayLocation

Definition at line 72 of file LoggerImpl.h.

◆ infoFileName

const std::string PointMatcherSupport::FileLogger::infoFileName

Definition at line 68 of file LoggerImpl.h.

◆ warningFileName

const std::string PointMatcherSupport::FileLogger::warningFileName

Definition at line 71 of file LoggerImpl.h.


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


libpointmatcher
Author(s):
autogenerated on Sat May 27 2023 02:38:04