Struct FTrainingStateUpdate

Defined in File TrainingUpdate.h

struct FTrainingStateUpdate

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

Dependencies: FTrainingReset, FTrainingStep

A Struct representing an update to the overall training state.

Public Functions

Symbol	Details
`FTrainingStateUpdate`	Construct a new empty training state update.
`GetStep`	Get the step data from this update.
`GetReset`	Get the reset data from this update.
`IsStep`	Check if this is a step update.
`IsReset`	Check if this is a reset update.
`IsError`	Check if the connector has encountered an error.
`IsClosed`	Check if the connector has been closed.

FTrainingStateUpdate

inline FTrainingStateUpdate()

Construct a new empty training state update.

Attributes: inline

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

GetStep

inline const FTrainingStep &GetStep() const

Get the step data from this update.

Returns:

Reference to the step data.

Attributes: inline, const

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

GetReset

inline const FTrainingReset &GetReset() const

Get the reset data from this update.

Returns:

Reference to the reset data.

Attributes: inline, const

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

IsStep

inline const bool IsStep() const

Check if this is a step update.

Returns:

True if this update contains a step.

Attributes: inline, const

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

IsReset

inline const bool IsReset() const

Check if this is a reset update.

Returns:

True if this update contains a reset.

Attributes: inline, const

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

IsError

inline const bool IsError() const

Check if the connector has encountered an error.

Returns:

True if the status indicates an error.

Attributes: inline, const

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

IsClosed

inline const bool IsClosed() const

Check if the connector has been closed.

Returns:

True if the status indicates closure.

Attributes: inline, const

Source: Source/Schola/Training/Public/TrainingDataTypes/TrainingUpdate.h

Public Members

Symbol	Details
`UpdateType`	The type of update.
`StepData`	Training step data (valid when UpdateType == STEP)
`ResetData`	Training reset data (valid when UpdateType == RESET)
`Status`	The status of the connector.

`UpdateType`

ETrainingUpdateType UpdateType = ETrainingUpdateType::NONE

The type of update.

`StepData`

FTrainingStep StepData

Training step data (valid when UpdateType == STEP)

`ResetData`

FTrainingReset ResetData

Training reset data (valid when UpdateType == RESET)

`Status`

EConnectorStatusUpdate Status = EConnectorStatusUpdate::NONE

The status of the connector.