Event Class Referenceabstract

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 ignition::math::Pose3d &, const bool)>, EventT< void(const std::string &, const ignition::math::Vector3d &)>, 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)>, EventT< void(sdf::ElementPtr, const std::string &, const std::string &, const uint32_t)>, EventT< void(sdf::ElementPtr, std::string)>, EventT< void(std::string)>, EventT< void(std::string, bool)>, EventT< void(std::string, ignition::math::Pose3d)>, EventT< void(std::string, std::map< std::string, ignition::math::Vector3d >)>, EventT< void(std::string, std::string)>, EventT< void(std::string, std::string, std::string, bool)>, 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) GAZEBO_DEPRECATED(8.0)=0
 Disconnect. More...
 
virtual void Disconnect (int _id)=0
 Disconnect. More...
 
bool GetSignaled () const GAZEBO_DEPRECATED(8.0)
 Get whether this event has been signaled. More...
 
void SetSignaled (const bool _sig)
 Set whether this event has been signaled. More...
 
bool Signaled () const
 Get whether this event has been signaled. More...
 

Detailed Description

Base class for all events.

Constructor & Destructor Documentation

Event ( )

Constructor.

virtual ~Event ( )
virtual

Destructor.

Member Function Documentation

bool GetSignaled ( ) const

Get whether this event has been signaled.

Returns
True if the event has been signaled.
Deprecated:
See bool Signaled() const;
void SetSignaled ( const bool  _sig)

Set whether this event has been signaled.

Parameters
[in]_sigTrue if the event has been signaled.

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

bool Signaled ( ) const

Get whether this event has been signaled.

Returns
True if the event has been signaled.

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