Public Member Functions | List of all members
PointMatcherSupport::Logger Struct Reference

The logger interface, used to output warnings and informations. More...

#include <PointMatcher.h>

Inheritance diagram for PointMatcherSupport::Logger:
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...
 
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...
 
 Logger ()
 Construct without parameter. More...
 
 Logger (const std::string &className, const ParametersDoc paramsDoc, const Parameters &params)
 Construct with parameters. More...
 
virtual std::ostream * warningStream ()
 Return the warning stream, 0 if hasWarningChannel() returns false. 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...
 

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...
 
- 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 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...
 

Detailed Description

The logger interface, used to output warnings and informations.

Definition at line 104 of file PointMatcher.h.

Constructor & Destructor Documentation

◆ Logger() [1/2]

PointMatcherSupport::Logger::Logger ( )

Construct without parameter.

Definition at line 45 of file Logger.cpp.

◆ Logger() [2/2]

PointMatcherSupport::Logger::Logger ( const std::string &  className,
const ParametersDoc  paramsDoc,
const Parameters params 
)

Construct with parameters.

Definition at line 49 of file Logger.cpp.

◆ ~Logger()

PointMatcherSupport::Logger::~Logger ( )
virtual

Virtual destructor, do nothing.

Definition at line 54 of file Logger.cpp.

Member Function Documentation

◆ beginInfoEntry()

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

Start a new entry into the info channel.

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 64 of file Logger.cpp.

◆ beginWarningEntry()

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

Start a new entry into the warning channel.

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 84 of file Logger.cpp.

◆ finishInfoEntry()

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

Finish the entry into the info channel.

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 74 of file Logger.cpp.

◆ finishWarningEntry()

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

Finish the entry into the warning channel.

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 94 of file Logger.cpp.

◆ hasInfoChannel()

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

Return whether this logger provides the info channel.

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 58 of file Logger.cpp.

◆ hasWarningChannel()

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

Return whether this logger provides the warning channel.

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 78 of file Logger.cpp.

◆ infoStream()

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

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

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 68 of file Logger.cpp.

◆ warningStream()

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

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

Reimplemented in PointMatcherSupport::FileLogger.

Definition at line 88 of file Logger.cpp.


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


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