ompl::msg::OutputHandler Class Reference

Generic class to handle output from a piece of code. More...

#include <Console.h>

Inheritance diagram for ompl::msg::OutputHandler:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void debug (const std::string &text)=0
 Print a debug message.
virtual void error (const std::string &text)=0
 Print an error message: "Error: ....".
virtual void inform (const std::string &text)=0
 Print some information: "Information: ....".
 OutputHandler (void)
virtual void warn (const std::string &text)=0
 Print an warning message: "Warning: ....".
virtual ~OutputHandler (void)

Detailed Description

Generic class to handle output from a piece of code.

In order to handle output from the library in different ways, an implementation of this class needs to be provided. The Interface class forwards calls to an instance of OutputHandler. This instance can be set with the useOutputHandler function.

Definition at line 111 of file Console.h.


Constructor & Destructor Documentation

ompl::msg::OutputHandler::OutputHandler ( void   )  [inline]

Definition at line 115 of file Console.h.

virtual ompl::msg::OutputHandler::~OutputHandler ( void   )  [inline, virtual]

Definition at line 119 of file Console.h.


Member Function Documentation

virtual void ompl::msg::OutputHandler::debug ( const std::string &  text  )  [pure virtual]

Print a debug message.

Implemented in ompl::msg::OutputHandlerSTD.

virtual void ompl::msg::OutputHandler::error ( const std::string &  text  )  [pure virtual]

Print an error message: "Error: ....".

Implemented in ompl::msg::OutputHandlerSTD.

virtual void ompl::msg::OutputHandler::inform ( const std::string &  text  )  [pure virtual]

Print some information: "Information: ....".

Implemented in ompl::msg::OutputHandlerSTD.

virtual void ompl::msg::OutputHandler::warn ( const std::string &  text  )  [pure virtual]

Print an warning message: "Warning: ....".

Implemented in ompl::msg::OutputHandlerSTD.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


ompl
Author(s): Ioan Sucan/isucan@rice.edu, Mark Moll/mmoll@rice.edu, Lydia Kavraki/kavraki@rice.edu
autogenerated on Fri Jan 11 09:34:03 2013