AbortedUpdateEvent Class Reference

Event issued when an Updater aborts processing its update set. More...

#include <Workspace/DataExecution/Execution/updaterevents.h>

Inheritance diagram for AbortedUpdateEvent:

Public Member Functions
	AbortedUpdateEvent (Updatable &errorSource, const AbortReason &abortReason)
const AbortReason &	getAbortReason () const
Updatable &	getErrorSource () const
QStringList	getErrorTree () 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

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

Detailed Description

This event will be raised whenever the execution thread aborts updating its update set. This is usually the result of an operation, connection, input or output failing to be updated when it is requested to do so. The logs will usually contain an error message explaining why the update failed.

The Updatable object that generated the error can be obtained by calling getErrorSource(). A string representation of the workspace hierarchy can also be obtained with getErrorTree()

See also

StartedUpdateEvent, PauseUpdateEvent, FinishedUpdateEvent

Constructor & Destructor Documentation

AbortedUpdateEvent()

AbortedUpdateEvent ( Updatable &  errorSource, const AbortReason &  abortReason  )

inline

Member Function Documentation

getAbortReason()

const AbortReason & getAbortReason ( ) const

inline

getErrorSource()

Updatable & getErrorSource ( ) const

inline

Returns

The updatable object that generated the error.

getErrorTree()

QStringList getErrorTree

(

)

const

Returns

A list of the labels for the workspace hierarchy, starting at the workspace containing the error source and ending at the root workspace. Since an AbortedUpdateEvent would normally only be raised by a workspace's execution thread, the returned list should always be non-empty.