RTT::EventC Class Reference

A user friendly event of a TaskContext. More...

#include <rtt/EventC.hpp>

List of all members.

Public Member Functions
	EventC ()
	Default constructor.
	EventC (const EventService *gcf, const std::string &name)
	The constructor.
	EventC (const EventC &other)
	A EventC is copyable by value.
EventC &	operator= (const EventC &other)
	A EventC is assignable.
EventC &	arg (DataSourceBase::shared_ptr a)
	Add a datasource argument to the Event.
template<class ArgT >
EventC &	argC (const ArgT a)
	Add a constant argument to the Event.
template<class ArgT >
EventC &	arg (ArgT &a)
	Add an argument by reference to the Event.
void	emit ()
	emit the contained event.
bool	ready () const
	Inspect if this event was correctly initialised.

---

Detailed Description

A user friendly event of a TaskContext.

Definition at line 52 of file EventC.hpp.

---

Constructor & Destructor Documentation

RTT::EventC::EventC

(

)

Default constructor.

Use assignment/copy construction to make the default EventC meaningful.

RTT::EventC::EventC	(	const EventService *	gcf,
		const std::string &	name
	)

The constructor.

See also:

EventService

---

Member Function Documentation

template<class ArgT >

EventC& RTT::EventC::arg

(

ArgT &

a

)

[inline]

Add an argument by reference to the Event.

Parameters:

a

A value of which the reference is used and re-read each time the event is emitted. Thus if the contents of the source of a changes, the emit() will use the new contents.

Definition at line 111 of file EventC.hpp.

EventC& RTT::EventC::arg

(

DataSourceBase::shared_ptr

a

)

Add a datasource argument to the Event.

Parameters:

a

A DataSource which contents are consulted each time when emit() is called.

template<class ArgT >

EventC& RTT::EventC::argC

(

const ArgT

a

)

[inline]

Add a constant argument to the Event.

Parameters:

a

A value of which a copy is made and this value is used each time in emit().

Definition at line 99 of file EventC.hpp.

---

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

• rtt/EventC.hpp