Workspace 6.21.5
Public Member Functions | Protected Member Functions | List of all members
OperationEvent< T > Class Template Reference

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

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

Inheritance diagram for OperationEvent< T >:
[legend]

Public Member Functions

OperationgetOperation () 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 EventIDgetEventID () const =0
 

Protected Member Functions

 OperationEvent (Operation &op)
 
- 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::OperationEvent< T >

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

Constructor & Destructor Documentation

◆ OperationEvent()

OperationEvent ( Operation op)
inlineprotected
Parameters
opThe operation the event is being raised on. This will be made available to the event receiver via the getOperation() function.

Member Function Documentation

◆ getOperation()

Operation & getOperation ( ) const
inline
Returns
The Operation this event was raised on.