OCL::logging::Appender Class Reference

#include <Appender.hpp>

Inheritance diagram for OCL::logging::Appender:

[legend]

List of all members.

Public Member Functions
	Appender (std::string name)
	Appender (std::string name)
virtual bool	configureLayout ()
virtual bool	configureLayout ()
virtual bool	startHook ()
	ensure port is connected before we start
virtual bool	startHook ()
	ensure port is connected before we start
virtual	~Appender ()
virtual	~Appender ()
Protected Attributes
log4cpp::Appender *	appender
	Appender created by derived class.
RTT::Property< std::string >	layoutName_prop
	Layout name (e.g. "simple", "basic", "pattern").
RTT::Property< std::string >	layoutPattern_prop
	Layout conversion pattern (for those layouts that use a pattern).
RTT::InputPort < OCL::logging::LoggingEvent >	log_port

---

Detailed Description

Definition at line 16 of file install/include/orocos/ocl/Appender.hpp.

---

Constructor & Destructor Documentation

OCL::logging::Appender::Appender

(

std::string

name

)

Definition at line 10 of file Appender.cpp.

OCL::logging::Appender::~Appender

(

)

[virtual]

Definition at line 22 of file Appender.cpp.

OCL::logging::Appender::Appender

(

std::string

name

)

virtual OCL::logging::Appender::~Appender

(

)

[virtual]

---

Member Function Documentation

virtual bool OCL::logging::Appender::configureLayout

(

)

[virtual]

Optionally create a layout according to layoutName and layoutPattern.

Precondition:

!appender, if you want a layout to actually be created

Returns:

true if not layout or no appender or a layout was created successfully, otherwise false

bool OCL::logging::Appender::configureLayout

(

)

[virtual]

Optionally create a layout according to layoutName and layoutPattern.

Precondition:

!appender, if you want a layout to actually be created

Returns:

true if not layout or no appender or a layout was created successfully, otherwise false

Todo:

ensure "" != layoutPattern?

Definition at line 26 of file Appender.cpp.

virtual bool OCL::logging::Appender::startHook

(

)

[virtual]

ensure port is connected before we start

bool OCL::logging::Appender::startHook

(

)

[virtual]

ensure port is connected before we start

Todo:

input ports must be connected?

Definition at line 66 of file Appender.cpp.

---

Member Data Documentation

log4cpp::Appender * OCL::logging::Appender::appender [protected]

Appender created by derived class.

Definition at line 37 of file install/include/orocos/ocl/Appender.hpp.

RTT::Property< std::string > OCL::logging::Appender::layoutName_prop [protected]

Layout name (e.g. "simple", "basic", "pattern").

Definition at line 41 of file install/include/orocos/ocl/Appender.hpp.

RTT::Property< std::string > OCL::logging::Appender::layoutPattern_prop [protected]

Layout conversion pattern (for those layouts that use a pattern).

Definition at line 43 of file install/include/orocos/ocl/Appender.hpp.

RTT::InputPort< OCL::logging::LoggingEvent > OCL::logging::Appender::log_port [protected]

Port we receive logging events on Initially unconnected. The logging service connects appenders.

Definition at line 34 of file install/include/orocos/ocl/Appender.hpp.

---

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

• install/include/orocos/ocl/Appender.hpp
• logging/Appender.hpp
• Appender.cpp