Gazebo Common

API Reference

3.17.0
Event Class Referenceabstract

Base class for all events. More...

#include <ignition/common/Event.hh>

Public Member Functions

 Event ()
 Constructor. More...
 
virtual ~Event ()
 Destructor. More...
 
virtual void Disconnect (int _id)=0
 Disconnect. 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()

Event ( )

Constructor.

◆ ~Event()

virtual ~Event ( )
virtual

Destructor.

Member Function Documentation

◆ Disconnect()

virtual void Disconnect ( int  _id)
pure virtual

Disconnect.

Parameters
[in]_idInteger ID of a connection

Implemented in EventT< T, N >.

◆ SetSignaled()

void SetSignaled ( const bool  _sig)

Set whether this event has been signaled.

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

Referenced by EventT< T, N >::Signal().

◆ Signaled()

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: