Event class raised when an input/output is being deleted. More...

#include <Workspace/DataExecution/InputOutput/iobaseevents.h>

Inheritance diagram for DeletingIOBaseEvent:

Public Member Functions
	DeletingIOBaseEvent (IOBase &iobase)

IOBase &	getIOBase () const

Public Member Functions inherited from ObservableEventType< DeletingIOBaseEvent >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > &	eventID ()

CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > &	eventID ()

const EventIDSingleton< DeletingIOBaseEvent > &	getEventID () const override

Public Member Functions inherited from ObservableEvent
virtual	~ObservableEvent ()=default

virtual const EventID &	getEventID () const =0

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

Protected Member Functions inherited from ObservableEventType< DeletingIOBaseEvent >
	ObservableEventType ()=default

Detailed Description

This event notification will be raised before the input/output is removed from its operation, but after any connections to it have been removed. Hence, a DeletingIOBase event will always be raised before any InputRemovalEvent, InputElementRemovalEvent or OutputRemovalEvent notification on the associated operation holding the input/output. In the case of InputArray, the event is raised after child inputs have been deleted but before the input array is removed from the operation. This is so that event notifications reflect the order in which inputs are actually fully deleted rather than the order in which the deletion functions are called.

The result of getIOBase() will still be a valid object at the time it is called, but this value should not be stored or used beyond the duration of this event notification.

Constructor & Destructor Documentation

◆ DeletingIOBaseEvent()

DeletingIOBaseEvent ( IOBase & iobase )

inline

Member Function Documentation

◆ getIOBase()

IOBase & getIOBase ( ) const