gatb.core-API-1.4.2
EventInfo Class Reference

Piece of information linked to a notification. More...

#include <IObserver.hpp>

Inheritance diagram for EventInfo:
Inheritance graph

Public Member Functions

InterfaceId getInterface () const
 
- Public Member Functions inherited from SmartPointer
void use ()
 
void forget ()
 
- Public Member Functions inherited from ISmartPointer
virtual ~ISmartPointer ()
 

Protected Member Functions

 EventInfo (const InterfaceId &interface)
 
virtual ~EventInfo ()
 
- Protected Member Functions inherited from SmartPointer
 SmartPointer ()
 
virtual ~SmartPointer ()
 

Protected Attributes

InterfaceId _interface
 

Detailed Description

Piece of information linked to a notification.

The EventInfo class is intended to be received by clients during a notification. Subclasses are meant to provide specific information related to specific notifications.

Defined as a SmartPointer for easing the EventInfo instances life cycle management.

Constructor & Destructor Documentation

EventInfo ( const InterfaceId &  interface)
inlineprotected

Constructor.

Parameters
[in]interface: identifier of the interface this EventInfo instance belongs to.
virtual ~EventInfo ( )
inlineprotectedvirtual

Destructor.

Member Function Documentation

InterfaceId getInterface ( ) const
inline

Returns the identifier of the group the EventInfo belongs to.

Returns
the identifier

Member Data Documentation

InterfaceId _interface
protected

Id of the group the EventInfo is related. This allows to group several EventInfo subclasses with a common identifier.


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