Workspace 6.21.5
Public Member Functions | List of all members
RemoveConnectionEvent Class Reference

Event emitted by a Workspace whenever a connection is removed from it. More...

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

Inheritance diagram for RemoveConnectionEvent:
[legend]

Public Member Functions

 RemoveConnectionEvent (Connection &con)
 
- Public Member Functions inherited from ConnectionEvent< RemoveConnectionEvent >
ConnectiongetConnection () 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
 

Additional Inherited Members

- Static Public Member Functions inherited from ObservableEventType< T >
static const EventIDSingleton< T > & eventID ()
 
- Protected Member Functions inherited from ConnectionEvent< RemoveConnectionEvent >
 ConnectionEvent (Connection &con)
 
- Protected Member Functions inherited from ObservableEventType< T >
 ObservableEventType ()=default
 

Detailed Description

The event is emitted whether the connection was created by the workspace or was passed in by client code. It is ideal for allowing a view of the workspace to update itself to keep in sync with it. It is also particularly useful when client code has kept a pointer to the connection and wants to be notified if the connection is deleted.

Constructor & Destructor Documentation

◆ RemoveConnectionEvent()

RemoveConnectionEvent ( Connection con)
inline