ConsoleWriter inherits from BaseWriter and writes output to the console. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/util/output/ConsoleWriter.h>

Inheritance diagram for orxonox::ConsoleWriter:

Public Member Functions
	ConsoleWriter (std::ostream &outputStream)
	Constructor, initializes the output level. More...

virtual	~ConsoleWriter ()
	Destructor. More...

void	disable ()
	Disables the instance by unregistering itself from OutputManager. More...

void	enable ()
	Enables the instance by registering itself as listener at OutputManager. More...

const std::ostream &	getOutputStream () const

Public Member Functions inherited from orxonox::BaseWriter
	BaseWriter (const std::string &name, bool bRegister=true)
	Constructor: Initializes the config-values. More...

virtual	~BaseWriter ()
	Destructor. More...

void	changedConfigurableAdditionalContexts ()
	Called if the config-vector of accepted contexts has changed, updates the masks in SubcontextOutputListener. More...

void	changedConfigurableAdditionalContextsLevel ()
	Called if the config value has changed, updates the corresponding mask in OutputListener. More...

void	changedConfigurableLevel ()
	Called if the config value has changed, updates the corresponding mask in OutputListener. More...

std::string	getConfigurableAdditionalContextsMaxLevelName () const
	Returns the name of the config value which defines the maximum output level of additional context. More...

std::string	getConfigurableAdditionalContextsName () const
	Returns the name of the config vector which defines the additional contexts (and sub-contexts) More...

std::string	getConfigurableMaxLevelName () const
	Returns the name of the config value which defines the maximum output level (independent of contexts). More...

const std::string &	getName () const
	Returns the name of this instance. More...

void	setAdditionalContextsLevelMax (OutputLevel max)
	Overwritten implementation of the function inherited from OutputListener, sets also the corresponding config-value. More...

void	setLevelMax (OutputLevel max)
	Overwritten implementation of the function inherited from OutputListener, sets also the corresponding config-value. More...

Public Member Functions inherited from orxonox::SubcontextOutputListener
	SubcontextOutputListener (bool bRegister=true)
	Constructor, initializes the context masks. More...

virtual	~SubcontextOutputListener ()
	Destructor. More...

virtual bool	acceptsOutput (OutputLevel level, const OutputContextContainer &context) const override
	Returns true if this listener accepts output of the given level and context, based on the levels and contexts masks, as well as the set of accepted sub-contexts. More...

const std::set< OutputContextSubID > &	getSubcontexts () const

virtual void	setAdditionalContextsMask (OutputContextMask mask) override
	Overwritten implementation of the function defined by OutputListener. More...

void	setAdditionalSubcontexts (const std::set< const OutputContextContainer * > &subcontexts)
	Defines the set of accepted sub-contexts. More...

Public Member Functions inherited from orxonox::OutputListener
	OutputListener (bool bRegister=true)
	Constructor, initializes the values and registers the instance at OutputManager if requested. More...

virtual	~OutputListener ()
	Destructor, unregisters the instance from OutputManager. More...

OutputLevel	getAdditionalContextsLevelMask () const
	Returns the additional contexts level mask. More...

OutputContextMask	getAdditionalContextsMask () const
	Returns the additional contexts mask. More...

OutputLevel	getLevelMask () const
	Returns the level mask. More...

void	registerListener (AdditionalContextListener *listener)
	Adds a listener to the list. More...

void	setAdditionalContextsLevelMask (OutputLevel mask)
	Defines the level mask of additional contexts. More...

void	setAdditionalContextsLevelMax (OutputLevel max)
	Defines the level mask of additional contexts in a way which accepts all output up to the level `max`. More...

void	setAdditionalContextsLevelRange (OutputLevel min, OutputLevel max)
	Defines the level mask of additional contexts in a way which accepts all output between the levels `min` and `max`. More...

void	setLevelMask (OutputLevel mask)
	Defines the level mask. More...

void	setLevelMax (OutputLevel max)
	Defines the level mask in a way which accepts all output up to the level `max`. More...

void	setLevelRange (OutputLevel min, OutputLevel max)
	Defines the level mask in a way which accepts all output between the levels `min` and `max`. More...

virtual void	unfilteredOutput (OutputLevel level, const OutputContextContainer &context, const std::vector< std::string > &lines)
	Called by OutputManager for each line of output, checks if this listener actually accepts this output before it calls the output() function. More...

void	unregisterListener (AdditionalContextListener *listener)
	Removes a listener from the list. More...

Protected Member Functions
virtual void	printLine (const std::string &line, OutputLevel level) override
	Inherited function from BaseWriter, writes output to the console using std::cout. More...

Protected Member Functions inherited from orxonox::BaseWriter
virtual void	output (OutputLevel level, const OutputContextContainer &context, const std::vector< std::string > &lines) override
	This function is inherited from OutputListener, each message is split into lines and sent to printLine(). More...

Protected Member Functions inherited from orxonox::OutputListener
const std::vector< AdditionalContextListener * > &	getListeners () const

Private Member Functions
	ConsoleWriter (const ConsoleWriter &)=delete

ConsoleWriter &	operator= (const ConsoleWriter &)=delete

Private Attributes
bool	bEnabled_
	If false, the instance will not write output to the console. More...

std::ostream &	outputStream_
	The ostream to which the console writer writes its output. More...

Additional Inherited Members
Static Public Member Functions inherited from orxonox::BaseWriter
static std::string	getConfigurableSectionName ()
	Returns the (static) name of the section wherein the config-values are defined. More...

Public Attributes inherited from orxonox::BaseWriter
std::vector< std::string >	configurableAdditionalContexts_
	Config vector, used to define the additional contexts (and sub-contexts) More...

int	configurableAdditionalContextsMaxLevel_
	Config value, used to define the maximum output level of additional context. More...

int	configurableMaxLevel_
	Config value, used to define the maximum output level (independent of contexts) More...

Detailed Description

ConsoleWriter inherits from BaseWriter and writes output to the console.

This class can be seen as an equivalent to std::cout within the output system.

Constructor & Destructor Documentation

orxonox::ConsoleWriter::ConsoleWriter ( std::ostream & outputStream )

Constructor, initializes the output level.

In debug builds, it writes output up to level::internal_warning to the console, in release builds only up to level::user_info.

After creation, the instance is enabled.

orxonox::ConsoleWriter::~ConsoleWriter ( )

virtual

Destructor.

orxonox::ConsoleWriter::ConsoleWriter ( const ConsoleWriter & )

privatedelete

Member Function Documentation

void orxonox::ConsoleWriter::disable ( )

Disables the instance by unregistering itself from OutputManager.

void orxonox::ConsoleWriter::enable ( )

Enables the instance by registering itself as listener at OutputManager.

const std::ostream& orxonox::ConsoleWriter::getOutputStream ( ) const

inline

ConsoleWriter& orxonox::ConsoleWriter::operator= ( const ConsoleWriter & )

privatedelete

void orxonox::ConsoleWriter::printLine	(	const std::string &	line,
		OutputLevel	level
	)

overrideprotectedvirtual

Inherited function from BaseWriter, writes output to the console using std::cout.

Implements orxonox::BaseWriter.

Member Data Documentation

bool orxonox::ConsoleWriter::bEnabled_

private

If false, the instance will not write output to the console.

std::ostream& orxonox::ConsoleWriter::outputStream_

private

The ostream to which the console writer writes its output.

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

libraries/util/output/ConsoleWriter.h
libraries/util/output/ConsoleWriter.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation