InputElementEvent< T > Class Template Reference

Base class for events related to elements of an InputArray.

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

Inheritance diagram for InputElementEvent< T >:

Public Member Functions
InputArray::size_type	getIndex () const
InputArray &	getInputArray () const
InputScalar &	getInputElement () 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

Protected Member Functions
	InputElementEvent (InputArray &inputArray, InputScalar &inputElement, InputArray::size_type index)
Protected Member Functions inherited from ObservableEventType< T >
	ObservableEventType ()=default

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

Constructor & Destructor Documentation

InputElementEvent()

InputElementEvent ( InputArray &  inputArray, InputScalar &  inputElement, InputArray::size_type  index  )

inlineprotected

Parameters

inputArray	The input array affected by the event.
inputElement	The element of the input array affected by the event.
index	The index of the input element affected by the event.

Member Function Documentation

getIndex()

InputArray::size_type getIndex ( ) const

inline

Returns

The index of the input element within the array affected by the event.

getInputArray()

InputArray & getInputArray ( ) const

inline

Returns

The input array affected by the event.

getInputElement()

InputScalar & getInputElement ( ) const

inline

Returns

The input element within the array affected by the event.