Event emitted by an Updatable object when its up to date status is set to true. More...

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

Inheritance diagram for UpdateEvent:

Public Member Functions
	UpdateEvent (Updatable &notifier)

Updatable &	getNotifier () const

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

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

const EventIDSingleton< UpdateEvent > &	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< UpdateEvent >
static const EventIDSingleton< UpdateEvent > &	eventID ()

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

Detailed Description

Unless explicitly noted otherwise, this event will be raised from an Updatable object's setUpToDate() function when the up to date status is being set to true. Updatable subclasses must raise these notifications except in the case where they cannot be set up to date directly (the InputArray class is the only instance of this in the workspace code).

See also: Updatable

Constructor & Destructor Documentation

◆ UpdateEvent()

UpdateEvent ( Updatable & notifier )

inline

Parameters

notifier The Updatable object raising the notification. While this parameter is not technically necessary, by providing it along with the event, client code can be simplified by not having to track the source of update events for themselves. Clients can channel update events from multiple sources and use the getNotifier() function to determine where the event came from.

Member Function Documentation

◆ getNotifier()

Updatable & getNotifier ( ) const