EventPacketPtr Class Reference

As with Data packets, Event packets travel along the signal paths. They are used to notify recipients of any relevant changes to the signal sending the packet. More...

Inheritance diagram for EventPacketPtr:

Collaboration diagram for EventPacketPtr:

Detailed Description

As with Data packets, Event packets travel along the signal paths. They are used to notify recipients of any relevant changes to the signal sending the packet.

Public Member Functions
daq::StringPtr	getEventId () const
	Gets the ID of the event as a string. In example "DATA_DESCRIPTOR_CHANGED". More...
daq::DictPtr< daq::IString, daq::IBaseObject >	getParameters () const
	Dictionary containing parameters as <String, BaseObject> pairs relevant to the event signalized by the Event packet. More...
Public Member Functions inherited from GenericPacketPtr< IEventPacket >
daq::PacketType	getType () const
	Gets the packet's type. More...
void	subscribeForDestructNotification (const daq::PacketDestructCallbackPtr &packetDestructCallback) const
	Subscribes for notification when the packet is destroyed. More...
daq::SizeT	getRefCount () const
	Gets the reference count of the packet. More...

Member Function Documentation

getEventId()

daq::StringPtr getEventId ( ) const

inline

Gets the ID of the event as a string. In example "DATA_DESCRIPTOR_CHANGED".

Returns

The ID of the event.

getParameters()

daq::DictPtr<daq::IString, daq::IBaseObject> getParameters ( ) const

inline

Dictionary containing parameters as <String, BaseObject> pairs relevant to the event signalized by the Event packet.

Returns

The event parameters dictionary.