#include <Category.hpp>

Inheritance diagram for OCL::logging::Category:

Public Member Functions
void	alert (const RTT::rt_string &message) throw ()

bool	connectToLogPort (RTT::base::PortInterface &otherPort)

bool	connectToLogPort (RTT::base::PortInterface &otherPort, RTT::ConnPolicy &cp)

void	crit (const RTT::rt_string &message) throw ()

void	debug (const RTT::rt_string &message) throw ()

void	emerg (const RTT::rt_string &message) throw ()

void	error (const RTT::rt_string &message) throw ()

void	fatal (const RTT::rt_string &message) throw ()

const RTT::OutputPort< OCL::logging::LoggingEvent > &	get_log_port () const

CategoryStream	getRTStream (log4cpp::Priority::Value priority)

void	info (const RTT::rt_string &message) throw ()

virtual void	log (log4cpp::Priority::Value priority, const RTT::rt_string &message) throw ()

void	notice (const RTT::rt_string &message) throw ()

void	warn (const RTT::rt_string &message) throw ()

virtual	~Category ()

Public Member Functions inherited from log4cpp::Category
virtual void	addAppender (Appender *appender)

virtual void	addAppender (Appender &appender)

void	alert (const std::string &message)

void	alert (const char *stringFormat,...)

CategoryStream	alertStream ()

virtual void	callAppenders (const LoggingEvent &event)

void	crit (const std::string &message)

void	crit (const char *stringFormat,...)

CategoryStream	critStream ()

void	debug (const char *stringFormat,...)

void	debug (const std::string &message)

CategoryStream	debugStream ()

void	emerg (const char *stringFormat,...)

void	emerg (const std::string &message)

CategoryStream	emergStream ()

void	error (const char *stringFormat,...)

void	error (const std::string &message)

CategoryStream	errorStream ()

void	fatal (const char *stringFormat,...)

void	fatal (const std::string &message)

CategoryStream	fatalStream ()

virtual bool	getAdditivity () const

virtual AppenderSet	getAllAppenders () const

virtual Appender *	getAppender () const

virtual Appender *	getAppender (const std::string &name) const

virtual Priority::Value	getChainedPriority () const

virtual const std::string &	getName () const

virtual Category *	getParent ()

virtual const Category *	getParent () const

virtual Priority::Value	getPriority () const

virtual CategoryStream	getStream (Priority::Value priority)

void	info (const char *stringFormat,...)

void	info (const std::string &message)

CategoryStream	infoStream ()

bool	isAlertEnabled () const

bool	isCritEnabled () const

bool	isDebugEnabled () const

bool	isEmergEnabled () const

bool	isErrorEnabled () const

bool	isFatalEnabled () const

bool	isInfoEnabled () const

bool	isNoticeEnabled () const

virtual bool	isPriorityEnabled (Priority::Value priority) const

bool	isWarnEnabled () const

virtual void	log (Priority::Value priority, const char *stringFormat,...)

virtual void	log (Priority::Value priority, const std::string &message)

virtual void	logva (Priority::Value priority, const char *stringFormat, va_list va)

void	notice (const char *stringFormat,...)

void	notice (const std::string &message)

CategoryStream	noticeStream ()

virtual CategoryStream	operator<< (Priority::Value priority)

virtual bool	ownsAppender () const

virtual bool	ownsAppender (Appender *appender) const

virtual void	removeAllAppenders ()

virtual void	removeAppender (Appender *appender)

virtual void	setAdditivity (bool additivity)

void	setAppender (Appender *appender)

void	setAppender (Appender &appender)

virtual void	setPriority (Priority::Value priority)

void	warn (const std::string &message)

void	warn (const char *stringFormat,...)

CategoryStream	warnStream ()

Static Public Member Functions
static log4cpp::Category *	createOCLCategory (const std::string &name, log4cpp::Category *parent, log4cpp::Priority::Value priority)

Static Public Member Functions inherited from log4cpp::Category
static Category *	exists (const std::string &name)

static std::vector< Category * > *	getCurrentCategories ()

static Category &	getInstance (const std::string &name)

static Category &	getRoot ()

static Priority::Value	getRootPriority ()

static void	setRootPriority (Priority::Value priority)

static void	shutdown ()

Protected Member Functions
void	_logUnconditionally2 (log4cpp::Priority::Value priority, const RTT::rt_string &message) throw ()

virtual void	callAppenders (const OCL::logging::LoggingEvent &event) throw ()

	Category (const std::string &name, log4cpp::Category *parent, log4cpp::Priority::Value priority=log4cpp::Priority::NOTSET)

Protected Member Functions inherited from log4cpp::Category
virtual void	_logUnconditionally (Priority::Value priority, const char *format, va_list arguments)

virtual void	_logUnconditionally2 (Priority::Value priority, const std::string &message)

	Category (const std::string &name, Category *parent, Priority::Value priority=Priority::NOTSET)

Static Protected Member Functions
static std::string	convertName (const std::string &name)

Protected Attributes
RTT::OutputPort< OCL::logging::LoggingEvent >	log_port

Private Member Functions
	Category (const Category &other)

Category &	operator= (const Category &other)

Friends
class	OCL::logging::LoggingService
	for access to log_port More...

Detailed Description

A real-time capable category

Warning: This class uses intentionally private inheritance to hide all functions with std::string in the base class. Only use RTT::rt_string objects.

Definition at line 25 of file Category.hpp.

Constructor & Destructor Documentation

OCL::logging::Category::~Category ( )

virtual

Reimplemented from log4cpp::Category.

Definition at line 20 of file Category.cpp.

OCL::logging::Category::Category	(	const std::string &	name,
		log4cpp::Category *	parent,
		log4cpp::Priority::Value	priority = `log4cpp::Priority::NOTSET`
	)

protected

Definition at line 12 of file Category.cpp.

OCL::logging::Category::Category ( const Category & other )

private

Member Function Documentation

void OCL::logging::Category::_logUnconditionally2	(	log4cpp::Priority::Value	priority,
		const RTT::rt_string &	message
	)
throw	(
	)

protected

Todo:: ++numFailedLog

Definition at line 88 of file Category.cpp.

void OCL::logging::Category::alert	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 69 of file Category.cpp.

void OCL::logging::Category::callAppenders	(	const OCL::logging::LoggingEvent &	event	)
throw	(
	)

protectedvirtual

Send event to all attached appenders.

Parameters

event The event of interest

Note: Real-time capable for all attached OCL-configured appenders

Definition at line 106 of file Category.cpp.

bool OCL::logging::Category::connectToLogPort ( RTT::base::PortInterface & otherPort )

Connect otherPort to log_port. Typically used by unit test code to directly syphon off logging events.

Returns: true if connected sucessfully, otherwise false

Note: No error is logged if fails to connect

Definition at line 156 of file Category.cpp.

bool OCL::logging::Category::connectToLogPort	(	RTT::base::PortInterface &	otherPort,
		RTT::ConnPolicy &	cp
	)

Connect otherPort to log_port with connection policy cp. Typically used by unit test code to directly syphon off logging events.

Returns: true if connected sucessfully, otherwise false

Note: No error is logged if fails to connect

Definition at line 161 of file Category.cpp.

std::string OCL::logging::Category::convertName ( const std::string & name )

staticprotected

Convert name into Orocos notation (e.g. "org.me.app" -> "org_me_app")

Warning: Not real-time capable

Definition at line 126 of file Category.cpp.

log4cpp::Category * OCL::logging::Category::createOCLCategory	(	const std::string &	name,
		log4cpp::Category *	parent,
		log4cpp::Priority::Value	priority
	)

static

Factory function for log4cpp::HierarchyMaintainer Creates an OCL logging category.

Warning: Not real-time capable

Definition at line 138 of file Category.cpp.

void OCL::logging::Category::crit	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 63 of file Category.cpp.

void OCL::logging::Category::debug	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 33 of file Category.cpp.

void OCL::logging::Category::emerg	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 75 of file Category.cpp.

void OCL::logging::Category::error	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 57 of file Category.cpp.

void OCL::logging::Category::fatal	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 81 of file Category.cpp.

const RTT::OutputPort<OCL::logging::LoggingEvent>& OCL::logging::Category::get_log_port ( ) const

inline

Definition at line 166 of file Category.hpp.

CategoryStream OCL::logging::Category::getRTStream ( log4cpp::Priority::Value priority )

Returns a stream-like object into which you can log arbitrary data which supports the operator<<().

Definition at line 150 of file Category.cpp.

void OCL::logging::Category::info	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 39 of file Category.cpp.

void OCL::logging::Category::log	(	log4cpp::Priority::Value	priority,
		const RTT::rt_string &	message
	)
throw	(
	)

virtual

Definition at line 24 of file Category.cpp.

void OCL::logging::Category::notice	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 45 of file Category.cpp.

Category& OCL::logging::Category::operator= ( const Category & other )

private

void OCL::logging::Category::warn	(	const RTT::rt_string &	message	)
throw	(
	)

Definition at line 51 of file Category.cpp.

Friends And Related Function Documentation

friend class OCL::logging::LoggingService

friend

for access to log_port

Definition at line 164 of file Category.hpp.

Member Data Documentation

RTT::OutputPort<OCL::logging::LoggingEvent> OCL::logging::Category::log_port

protected

Definition at line 162 of file Category.hpp.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation