#include <Appender.hpp>

Inheritance diagram for OCL::logging::Appender:

[legend]

Public Member Functions
	Appender (std::string name)

virtual bool	configureLayout ()

virtual void	drainBuffer ()

virtual bool	startHook ()
	ensure port is connected before we start More...

virtual void	stopHook ()
	Drain the buffer. More...

virtual	~Appender ()

Public Member Functions inherited from RTT::TaskContext
bool	addAttribute (const std::string &name, T &attr)

bool	addAttribute (base::AttributeBase &a)

bool	addAttribute (base::AttributeBase &a)

bool	addAttribute (const std::string &name, T &attr)

bool	addConstant (const std::string &name, const T &attr)

bool	addConstant (const std::string &name, const T &attr)

base::InputPortInterface &	addEventPort (const std::string &name, base::InputPortInterface &port, SlotFunction callback=SlotFunction())

base::InputPortInterface &	addEventPort (base::InputPortInterface &port, SlotFunction callback=SlotFunction())

Operation< Signature > &	addOperation (Operation< Signature > &op)

Operation< Signature > &	addOperation (Operation< Signature > &op)

Operation< typename internal::GetSignature< Func >::Signature > &	addOperation (const std::string name, Func func, Service *serv, ExecutionThread et=ClientThread)

Operation< Signature > &	addOperation (const std::string name, Signature *func, ExecutionThread et=ClientThread)

Operation< typename internal::GetSignature< Func >::Signature > &	addOperation (const std::string name, Func func, Service *serv, ExecutionThread et=ClientThread)

Operation< Signature > &	addOperation (const std::string name, Signature *func, ExecutionThread et=ClientThread)

virtual bool	addPeer (TaskContext *peer, std::string alias="")

virtual bool	addPeer (TaskContext *peer, std::string alias="")

base::PortInterface &	addPort (const std::string &name, base::PortInterface &port)

base::PortInterface &	addPort (base::PortInterface &port)

Property< T > &	addProperty (const std::string &name, T &attr)

bool	addProperty (base::PropertyBase &pb)

Property< T > &	addProperty (const std::string &name, T &attr)

bool	addProperty (base::PropertyBase &pb)

ConfigurationInterface *	attributes ()

ConfigurationInterface *	attributes ()

virtual void	clear ()

virtual bool	connectPeers (TaskContext *peer)

virtual bool	connectPeers (TaskContext *peer)

virtual bool	connectPorts (TaskContext *peer)

virtual bool	connectServices (TaskContext *peer)

virtual bool	connectServices (TaskContext *peer)

virtual void	disconnect ()

virtual void	disconnect ()

virtual void	disconnectPeers (const std::string &name)

virtual void	disconnectPeers (const std::string &name)

base::ActivityInterface *	getActivity ()

T *	getActivity ()

base::AttributeBase *	getAttribute (const std::string &name) const

base::AttributeBase *	getAttribute (const std::string &name) const

virtual const std::string &	getName () const

OperationInterfacePart *	getOperation (std::string name)

OperationInterfacePart *	getOperation (std::string name)

virtual TaskContext *	getPeer (const std::string &peer_name) const

virtual TaskContext *	getPeer (const std::string &peer_name) const

virtual PeerList	getPeerList () const

virtual PeerList	getPeerList () const

base::PortInterface *	getPort (const std::string &name) const

base::PropertyBase *	getProperty (const std::string &name) const

base::PropertyBase *	getProperty (const std::string &name) const

boost::shared_ptr< ServiceType >	getProvider (const std::string &name)

boost::shared_ptr< ServiceType >	getProvider (const std::string &name)

virtual bool	hasPeer (const std::string &peer_name) const

virtual bool	hasPeer (const std::string &peer_name) const

bool	loadService (const std::string &service_name)

bool	loadService (const std::string &service_name)

OperationInterface *	operations ()

OperationInterface *	operations ()

DataFlowInterface *	ports ()

const DataFlowInterface *	ports () const

PropertyBag *	properties ()

PropertyBag *	properties ()

Service::shared_ptr	provides (const std::string &service_name)

Service::shared_ptr	provides ()

Service::shared_ptr	provides ()

Service::shared_ptr	provides (const std::string &service_name)

virtual bool	ready ()

virtual void	removePeer (const std::string &name)

virtual void	removePeer (TaskContext *peer)

virtual void	removePeer (TaskContext *peer)

virtual void	removePeer (const std::string &name)

ServiceRequester::shared_ptr	requires (const std::string &service_name)

ServiceRequester::shared_ptr	requires (const std::string &service_name)

ServiceRequester::shared_ptr	requires ()

ServiceRequester::shared_ptr	requires ()

bool	setActivity (base::ActivityInterface *new_act)

virtual bool	start ()

virtual bool	stop ()

	TaskContext (const std::string &name, TaskState initial_state=Stopped)

virtual	~TaskContext ()

Public Member Functions inherited from RTT::base::TaskCore
virtual bool	activate ()

virtual bool	activate ()

virtual bool	cleanup ()

virtual bool	cleanup ()

virtual bool	configure ()

virtual bool	configure ()

const ExecutionEngine *	engine () const

ExecutionEngine *	engine ()

virtual void	error ()

virtual void	error ()

virtual unsigned	getCpuAffinity () const

virtual unsigned	getCpuAffinity () const

unsigned int	getCycleCounter () const

unsigned int	getIOCounter () const

virtual Seconds	getPeriod () const

virtual Seconds	getPeriod () const

virtual TaskState	getTargetState () const

virtual TaskState	getTaskState () const

unsigned int	getTimeOutCounter () const

unsigned int	getTriggerCounter () const

virtual bool	inException () const

virtual bool	inException () const

virtual bool	inFatalError () const

virtual bool	inFatalError () const

virtual bool	inRunTimeError () const

virtual bool	inRunTimeError () const

virtual bool	isActive () const

virtual bool	isActive () const

virtual bool	isConfigured () const

virtual bool	isConfigured () const

virtual bool	isRunning () const

virtual bool	isRunning () const

virtual bool	recover ()

virtual bool	recover ()

virtual bool	setCpuAffinity (unsigned cpu)

virtual bool	setCpuAffinity (unsigned cpu)

virtual bool	setPeriod (Seconds s)

virtual bool	setPeriod (Seconds s)

	TaskCore (TaskState initial_state=Stopped, const std::string &name=std::string())

virtual bool	trigger ()

virtual bool	trigger ()

virtual bool	update ()

virtual bool	update ()

virtual	~TaskCore ()

Protected Member Functions
virtual void	processEvents (int n)

Protected Member Functions inherited from RTT::TaskContext
virtual void	dataOnPortCallback (base::PortInterface *port)

virtual bool	dataOnPortHook (base::PortInterface *port)

void	forceActivity (base::ActivityInterface *new_act)

Protected Member Functions inherited from RTT::base::TaskCore
virtual bool	breakUpdateHook ()

virtual void	cleanupHook ()

virtual bool	configureHook ()

virtual void	errorHook ()

virtual void	exception ()

virtual void	exceptionHook ()

virtual void	fatal ()

virtual void	updateHook ()

Protected Attributes
log4cpp::Appender *	appender
	Appender created by derived class. More...

unsigned int	countMaxPopped

OCL::logging::LoggingEvent	event

RTT::Property< std::string >	layoutName_prop
	Layout name (e.g. "simple", "basic", "pattern") More...

RTT::Property< std::string >	layoutPattern_prop
	Layout conversion pattern (for those layouts that use a pattern) More...

RTT::InputPort< OCL::logging::LoggingEvent >	log_port

Protected Attributes inherited from RTT::base::TaskCore
ExecutionEngine *	ee

unsigned int	mCycleCounter

unsigned int	mIOCounter

std::string	mName

TaskState	mTaskState

unsigned int	mTimeOutCounter

unsigned int	mTriggerCounter

bool	mTriggerOnStart

Additional Inherited Members
Public Types inherited from RTT::TaskContext
typedef std::vector< std::string >	PeerList

typedef boost::function< void(base::PortInterface *)>	SlotFunction

Public Types inherited from RTT::base::TaskCore
enum	TaskState

Public Attributes inherited from RTT::base::TaskCore
	Exception

	FatalError

	Init

	PreOperational

	Running

	RunTimeError

	Stopped

Detailed Description

Definition at line 16 of file Appender.hpp.

Constructor & Destructor Documentation

OCL::logging::Appender::Appender ( std::string name )

Definition at line 12 of file Appender.cpp.

OCL::logging::Appender::~Appender ( )

virtual

Definition at line 25 of file Appender.cpp.

Member Function Documentation

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 29 of file Appender.cpp.

void OCL::logging::Appender::drainBuffer ( )

virtual

Process all remaining events in buffer

Definition at line 99 of file Appender.cpp.

void OCL::logging::Appender::processEvents ( int n )

protectedvirtual

Process up n events

Parameters

n	if 0 ==n then process events until buffer is empty, otherwise process at most n events

Precondition: 0 <= n (otherwise acts as though n==1)

See also: event Not multi-thread safe. Not re-entrant!

Definition at line 104 of file Appender.cpp.

bool OCL::logging::Appender::startHook ( )

virtual

ensure port is connected before we start

Todo:: input ports must be connected?

Reimplemented from RTT::base::TaskCore.

Definition at line 69 of file Appender.cpp.

void OCL::logging::Appender::stopHook ( )

virtual

Drain the buffer.

Reimplemented from RTT::base::TaskCore.

Definition at line 77 of file Appender.cpp.

Member Data Documentation

log4cpp::Appender* OCL::logging::Appender::appender

protected

Appender created by derived class.

Definition at line 52 of file Appender.hpp.

unsigned int OCL::logging::Appender::countMaxPopped

protected

Definition at line 70 of file Appender.hpp.

OCL::logging::LoggingEvent OCL::logging::Appender::event

protected

Definition at line 67 of file Appender.hpp.

RTT::Property<std::string> OCL::logging::Appender::layoutName_prop

protected

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

Definition at line 56 of file 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 58 of file 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 49 of file Appender.hpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation