OCL::logging::Category Class Reference

#include <Category.hpp>

Inheritance diagram for OCL::logging::Category:

List of all members.

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 ()
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 ()
Static Public Member Functions
static log4cpp::Category *	createOCLCategory (const std::string &name, log4cpp::Category *parent, log4cpp::Priority::Value priority)
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)
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

---

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]

Reimplemented from log4cpp::Category.

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 () [protected, virtual]

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 109 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 155 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 160 of file Category.cpp.

std::string OCL::logging::Category::convertName

(

const std::string &

name

)

[static, protected]

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

Warning:

Not real-time capable

Definition at line 125 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 137 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.

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 149 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:

• Category.hpp
• Category.cpp