ompl::msg::Interface Class Reference

The piece of code that desires interaction with an action or an output handler should use an instance of this class. This class connects to the active OutputHandler (if any) and forwards messages. More...

#include <Console.h>

List of all members.

Public Member Functions
void	debug (const char *msg,...) const
	Forward a debug message.
void	debug (const std::string &text) const
	Forward a debug message.
void	error (const char *msg,...) const
	Forward an error.
void	error (const std::string &text) const
	Forward an error.
const std::string &	getPrefix (void) const
	Get the text that appears in front of every forwarded message.
void	inform (const char *msg,...) const
	Forward information.
void	inform (const std::string &text) const
	Forward information.
	Interface (const std::string &prefix="")
	The text that will appear in front of every message forwarded by this Interface instance can be optionally set as a constructor argument.
void	setPrefix (const std::string &prefix)
	Set the text that will appear in front of every message forwarded by this Interface instance.
void	warn (const char *msg,...) const
	Forward a warning.
void	warn (const std::string &text) const
	Forward a warning.
virtual	~Interface (void)
Protected Attributes
std::string	prefix_
	The string that appears in front of very forwarded message.

---

Detailed Description

The piece of code that desires interaction with an action or an output handler should use an instance of this class. This class connects to the active OutputHandler (if any) and forwards messages.

Definition at line 55 of file Console.h.

---

Constructor & Destructor Documentation

ompl::msg::Interface::Interface

(

const std::string &

prefix = ""

)

[explicit]

The text that will appear in front of every message forwarded by this Interface instance can be optionally set as a constructor argument.

virtual ompl::msg::Interface::~Interface

(

void

)

[virtual]

---

Member Function Documentation

void ompl::msg::Interface::debug	(	const char *	msg,
			...
	)			const

Forward a debug message.

void ompl::msg::Interface::debug

(

const std::string &

text

)

const

Forward a debug message.

void ompl::msg::Interface::error	(	const char *	msg,
			...
	)			const

Forward an error.

void ompl::msg::Interface::error

(

const std::string &

text

)

const

Forward an error.

const std::string& ompl::msg::Interface::getPrefix

(

void

)

const

Get the text that appears in front of every forwarded message.

void ompl::msg::Interface::inform	(	const char *	msg,
			...
	)			const

Forward information.

void ompl::msg::Interface::inform

(

const std::string &

text

)

const

Forward information.

void ompl::msg::Interface::setPrefix

(

const std::string &

prefix

)

Set the text that will appear in front of every message forwarded by this Interface instance.

void ompl::msg::Interface::warn	(	const char *	msg,
			...
	)			const

Forward a warning.

void ompl::msg::Interface::warn

(

const std::string &

text

)

const

Forward a warning.

---

Member Data Documentation

std::string ompl::msg::Interface::prefix_ [protected]

The string that appears in front of very forwarded message.

Definition at line 100 of file Console.h.

---

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

• Console.h