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

Event class raised after a scalar input is rebuilt. More...

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

Inheritance diagram for InputRebuiltEvent:
[legend]

Public Member Functions

 InputRebuiltEvent (InputScalar &input)
 
InputScalargetInput () const
 
- Public Member Functions inherited from ObservableEventType< InputRebuiltEvent >
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::AllObservableEvents > & eventID ()
 
CSIRO_WORKSPACE_API const EventIDSingleton< CSIRO::DataExecution::ProgressEvent > & eventID ()
 
const EventIDSingleton< InputRebuiltEvent > & 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< InputRebuiltEvent >
static const EventIDSingleton< InputRebuiltEvent > & eventID ()
 
- Protected Member Functions inherited from ObservableEventType< InputRebuiltEvent >
 ObservableEventType ()=default
 

Detailed Description

Scalar inputs are rebuilt under certain circumstances, such as if the data object associated with the input changes, or if a connection to it is rebuilt. When this occurs, the InputScalar::rebuilt() function is called, which in turn raises an InputRebuiltEvent notification as the last thing it does. Changing whether or not a connection copies its source will also result in an InputRebuiltEvent for the same reasons.

Constructor & Destructor Documentation

◆ InputRebuiltEvent()

InputRebuiltEvent ( InputScalar input)
inline
Parameters
inputThe input that has been rebuilt.

Member Function Documentation

◆ getInput()

InputScalar & getInput ( ) const
inline
Returns
The input that was rebuilt.