rtc::Functor Class Reference

#include <rtcFunctor.h>

Inheritance diagram for rtc::Functor:

[legend]

List of all members.

Classes
class	Parameters
Public Types
typedef std::string	StatusMessage
typedef std::vector < StatusMessage >	StatusMessages
Public Member Functions
void	addStatusMessage (const StatusMessage msg)
virtual Functor *	clone () const =0
Functor &	copy (const Functor &other)
	Functor (const Functor &other)
	Functor ()
const Parameters &	getParameters () const
const StatusMessages &	getStatusMessages () const
virtual bool	read (InputHandler &ih)
virtual bool	setParameters (const Parameters &theParam)
virtual bool	write (OutputHandler &oh) const
virtual	~Functor ()
Private Member Functions
Functor &	operator= (const Functor &other)
Private Attributes
StatusMessages	m_messages
Parameters *	params

---

Detailed Description

Base class for all functors.

Every functor must have at least the member apply(), which "applies" the functor's functionality on the data given through the arguments of the apply method.

The operation of the functor can be controled with some parameters, which will can be set with the "setParameters" member-function.

Definition at line 40 of file rtcFunctor.h.

---

Member Typedef Documentation

typedef std::string rtc::Functor::StatusMessage

A status message is just a string

Definition at line 45 of file rtcFunctor.h.

typedef std::vector<StatusMessage> rtc::Functor::StatusMessages

A list of strings as status messages

Definition at line 50 of file rtcFunctor.h.

---

Constructor & Destructor Documentation

rtc::Functor::Functor

(

)

default constructor

Definition at line 77 of file rtcFunctor.cpp.

rtc::Functor::Functor

(

const Functor &

other

)

copy constructor

Definition at line 83 of file rtcFunctor.cpp.

rtc::Functor::~Functor

(

)

[virtual]

destructor

Definition at line 90 of file rtcFunctor.cpp.

---

Member Function Documentation

void rtc::Functor::addStatusMessage

(

const StatusMessage

msg

)

Adds a status message to the messages

Definition at line 130 of file rtcFunctor.cpp.

virtual Functor* rtc::Functor::clone

(

)

const [pure virtual]

clone member

Functor & rtc::Functor::copy

(

const Functor &

other

)

copy data of "other" Functor. Please note that the status string will _NOT_ be copied!

Definition at line 116 of file rtcFunctor.cpp.

const Functor::Parameters & rtc::Functor::getParameters

(

)

const

returns current Parameters.

Definition at line 110 of file rtcFunctor.cpp.

const Functor::StatusMessages & rtc::Functor::getStatusMessages

(

)

const

Returns the list of all status messages

Definition at line 137 of file rtcFunctor.cpp.

Functor & rtc::Functor::operator=

(

const Functor &

other

)

[private]

This is private to avoid default implementation.

Definition at line 123 of file rtcFunctor.cpp.

bool rtc::Functor::read

(

InputHandler &

ih

)

[virtual]

read the functor parameters

Implements rtc::IOObject.

Definition at line 144 of file rtcFunctor.cpp.

bool rtc::Functor::setParameters

(

const Parameters &

theParam

)

[virtual]

Set Functor's Parameters.

Definition at line 99 of file rtcFunctor.cpp.

bool rtc::Functor::write

(

OutputHandler &

oh

)

const [virtual]

read the functor parameters

Implements rtc::IOObject.

Definition at line 157 of file rtcFunctor.cpp.

---

Member Data Documentation

StatusMessages rtc::Functor::m_messages [private]

current Parameters.

Definition at line 172 of file rtcFunctor.h.

Parameters* rtc::Functor::params [private]

current Parameters.

Definition at line 167 of file rtcFunctor.h.

---

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

• rtcFunctor.h
• rtcFunctor.cpp