gazebo::event::Event Class Reference

Base class for all events. More...

#include <common/common.hh>

Inheritance diagram for gazebo::event::Event:

Collaboration diagram for gazebo::event::Event:

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

gazebo::event::Event::Event

(

)

Constructor.

virtual gazebo::event::Event::~Event ( )

virtual

Destructor.

gazebo::event::Event::Event ( EventPrivate &  _d )

protected

Allow subclasses to initialize their own data pointer.

Parameters

[in]

_d

Reference to data pointer.

Member Function Documentation

virtual void gazebo::event::Event::Disconnect ( ConnectionPtr  _c )

pure virtual

Disconnect.

Parameters

[in]

_c

A pointer to a connection

Implemented in gazebo::event::EventT< T >, gazebo::event::EventT< void(double)>, gazebo::event::EventT< void(msgs::SonarStamped)>, gazebo::event::EventT< void(std::string)>, gazebo::event::EventT< void(const unsigned char *, unsigned int, unsigned int, unsigned int, const std::string &)>, gazebo::event::EventT< void(msgs::WrenchStamped)>, gazebo::event::EventT< void(int)>, gazebo::event::EventT< void(const msgs::Light &)>, gazebo::event::EventT< void(const float *_frame, unsigned int _width, unsigned int _height, unsigned int _depth, const std::string &_format)>, gazebo::event::EventT< void(const std::string &)>, gazebo::event::EventT< void(std::map< std::string, std::string >)>, gazebo::event::EventT< void()>, gazebo::event::EventT< void(const common::UpdateInfo &)>, gazebo::event::EventT< void(const msgs::Model &)>, gazebo::event::EventT< void(const float *, unsigned int, unsigned int, unsigned int, const std::string &)>, gazebo::event::EventT< void(int, std::string)>, gazebo::event::EventT< void(std::string, std::string)>, and gazebo::event::EventT< void(bool)>.

virtual void gazebo::event::Event::Disconnect ( int  _id )

pure virtual

Disconnect.

Parameters

[in]

_id

Integer ID of a connection

Implemented in gazebo::event::EventT< T >, gazebo::event::EventT< void(double)>, gazebo::event::EventT< void(msgs::SonarStamped)>, gazebo::event::EventT< void(std::string)>, gazebo::event::EventT< void(const unsigned char *, unsigned int, unsigned int, unsigned int, const std::string &)>, gazebo::event::EventT< void(msgs::WrenchStamped)>, gazebo::event::EventT< void(int)>, gazebo::event::EventT< void(const msgs::Light &)>, gazebo::event::EventT< void(const float *_frame, unsigned int _width, unsigned int _height, unsigned int _depth, const std::string &_format)>, gazebo::event::EventT< void(const std::string &)>, gazebo::event::EventT< void(std::map< std::string, std::string >)>, gazebo::event::EventT< void()>, gazebo::event::EventT< void(const common::UpdateInfo &)>, gazebo::event::EventT< void(const msgs::Model &)>, gazebo::event::EventT< void(const float *, unsigned int, unsigned int, unsigned int, const std::string &)>, gazebo::event::EventT< void(int, std::string)>, gazebo::event::EventT< void(std::string, std::string)>, and gazebo::event::EventT< void(bool)>.

bool gazebo::event::Event::GetSignaled

(

)

const

Get whether this event has been signaled.

Returns

True if the event has been signaled.

Member Data Documentation

EventPrivate* gazebo::event::Event::dataPtr

protected

Data pointer.

Referenced by gazebo::event::EventT< T >::EventT().

---

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

• Event.hh