ConnectionEvent< T > Class Template Reference

Base class for Connection-related events. More...

#include <Workspace/DataExecution/Operations/workspaceevents.h>

Inheritance diagram for ConnectionEvent< T >:

Public Member Functions
Connection &	getConnection () const
Public Member Functions inherited from ObservableEventType< T >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > &	eventID ()
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > &	eventID ()
const EventIDSingleton< T > &	getEventID () const override
Public Member Functions inherited from ObservableEvent
virtual	~ObservableEvent ()=default
virtual const EventID &	getEventID () const =0

Protected Member Functions
	ConnectionEvent (Connection &con)
Protected Member Functions inherited from ObservableEventType< T >
	ObservableEventType ()=default

Additional Inherited Members
Static Public Member Functions inherited from ObservableEventType< T >
static const EventIDSingleton< T > &	eventID ()

Detailed Description

template<typename T>
class CSIRO::DataExecution::ConnectionEvent< T >

Only those events that provide a reference to the Connection on which the event is being raised are derived from this class. Other Connection events may derive from ObservableEventType directly if they don't want to provide a reference to the Connection through the event object.

Constructor & Destructor Documentation

ConnectionEvent()

ConnectionEvent ( Connection &  con )

inlineprotected

Parameters

con	The Connection the event is being raised on. This will be made available to the event receiver via the getConnection() function.

Member Function Documentation

getConnection()

Connection & getConnection ( ) const

inline

Returns

The Connection this event was raised on.