Event Class Reference

Base class for all events. More...

#include <common/common.hh>

Inherited by EventT< bool()>, EventT< void()>, EventT< void(bool)>, EventT< void(bool, bool)>, EventT< void(const common::UpdateInfo &)>, EventT< void(const int32_t)>, EventT< void(const msgs::Light &)>, EventT< void(const msgs::Model &)>, EventT< void(const std::string &)>, EventT< void(const std::string &, const math::Vector3 &)>, EventT< void(const unsigned char *, unsigned int, unsigned int, unsigned int, const std::string &)>, EventT< void(double)>, EventT< void(int)>, EventT< void(int, std::string)>, EventT< void(QColor)>, EventT< void(QString)>, EventT< void(sdf::ElementPtr, const std::string &, const std::string &, const uint32_t)>, EventT< void(std::string)>, EventT< void(std::string, bool)>, EventT< void(std::string, std::string)>, EventT< void(std::string, std::string, std::string)>, EventT< void(std::string, std::string, std::string, bool, bool)>, EventT< void(std::string, std::string, std::string, std::string, std::string)>, and EventT< T >.

Public Member Functions
	Event ()
	Constructor. More...
virtual	~Event ()
	Destructor. More...
virtual void	Disconnect (ConnectionPtr _c)=0
	Disconnect. More...
virtual void	Disconnect (int _id)=0
	Disconnect. More...
bool	GetSignaled () const
	Get whether this event has been signaled. More...

Protected Member Functions
	Event (EventPrivate &_d)
	Allow subclasses to initialize their own data pointer. More...

Protected Attributes
EventPrivate *	dataPtr
	Data pointer. More...

Detailed Description

Base class for all events.

Constructor & Destructor Documentation

Event() [1/2]

Event

(

)

Constructor.

~Event()

virtual ~Event ( )

virtual

Destructor.

Event() [2/2]

Event ( EventPrivate &  _d )

protected

Allow subclasses to initialize their own data pointer.

Parameters

[in]

_d

Reference to data pointer.

Member Function Documentation

Disconnect() [1/2]

virtual void Disconnect ( ConnectionPtr  _c )

pure virtual

Disconnect.

Parameters

[in]

_c

A pointer to a connection

Implemented in EventT< T >, EventT< void(double)>, EventT< void(const unsigned char *, unsigned int, unsigned int, unsigned int, const std::string &)>, EventT< void(std::string)>, EventT< bool()>, EventT< void(int)>, EventT< void(const msgs::Light &)>, EventT< void(std::string, std::string, std::string, std::string, std::string)>, EventT< void(QString)>, EventT< void(QColor)>, EventT< void(const std::string &)>, EventT< void(const std::string &, const math::Vector3 &)>, EventT< void()>, EventT< void(std::string, std::string, std::string, bool, bool)>, EventT< void(std::string, bool)>, EventT< void(bool, bool)>, EventT< void(const common::UpdateInfo &)>, EventT< void(const msgs::Model &)>, EventT< void(sdf::ElementPtr, const std::string &, const std::string &, const uint32_t)>, EventT< void(const int32_t)>, EventT< void(std::string, std::string, std::string)>, EventT< void(int, std::string)>, EventT< void(std::string, std::string)>, and EventT< void(bool)>.

Disconnect() [2/2]

virtual void Disconnect ( int  _id )

pure virtual

Disconnect.

Parameters

[in]

_id

Integer ID of a connection

Implemented in EventT< T >, EventT< void(double)>, EventT< void(const unsigned char *, unsigned int, unsigned int, unsigned int, const std::string &)>, EventT< void(std::string)>, EventT< bool()>, EventT< void(int)>, EventT< void(const msgs::Light &)>, EventT< void(std::string, std::string, std::string, std::string, std::string)>, EventT< void(QString)>, EventT< void(QColor)>, EventT< void(const std::string &)>, EventT< void(const std::string &, const math::Vector3 &)>, EventT< void()>, EventT< void(std::string, std::string, std::string, bool, bool)>, EventT< void(std::string, bool)>, EventT< void(bool, bool)>, EventT< void(const common::UpdateInfo &)>, EventT< void(const msgs::Model &)>, EventT< void(sdf::ElementPtr, const std::string &, const std::string &, const uint32_t)>, EventT< void(const int32_t)>, EventT< void(std::string, std::string, std::string)>, EventT< void(int, std::string)>, EventT< void(std::string, std::string)>, and EventT< void(bool)>.

GetSignaled()

bool GetSignaled

(

)

const

Get whether this event has been signaled.

Returns

True if the event has been signaled.

Member Data Documentation

dataPtr

EventPrivate* dataPtr

protected

Data pointer.

Referenced by EventT< void(bool)>::Disconnect().

---

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

• Event.hh