Skip to content

IValidatable

class IValidatable

Dependencies: FValidationResult

Public Interface

Public Functions:

Validate

pure-virtual bool Validate(EValidationType ValidationType=EValidationType::FAIL)=0

Validate the object.

Parameters:

  • ValidationType (EValidationType) – [in] The type of validation to perform when converting (e.g. do we warn or fail)

Returns: bool

Attributes: pure-virtual

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 130, column 14)

OnWarn

inline virtual void OnWarn(FValidationResult WarnResult)

Callback to perform when validation results in a warning.

Note: implement this function to handle validation warnings

Parameters:

  • WarnResult (FValidationResult) – [in] The result of the validation

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 137, column 14)

OnFail

inline virtual void OnFail(FValidationResult FailResult)

Callback to perform when validation results in a Failure.

Note: implement this function to handle validation failures

Parameters:

  • FailResult (FValidationResult) – [in] The result of the validation

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 144, column 14)

OnPass

inline virtual void OnPass(FValidationResult SuccessResult)

Callback to perform when validation results in a Pass.

Note: implement this function to handle validation passes

Parameters:

  • SuccessResult (FValidationResult) – [in] The result of the validation

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 150, column 14)

GenerateValidatationResult

inline EValidationResult GenerateValidatationResult(const FValidationResult Result)

Generate a validation result from a space validation result.

Returns: the converted validation result

Note: This function will call the appropriate callback based on the result

Parameters:

  • Result (const FValidationResult) – [in] The space validation result

Returns: EValidationResult

Attributes: inline

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 158, column 19)

GenerateValidatationResult

inline EValidationResult GenerateValidatationResult(const ESpaceValidationResult Result)

Generate a validation result from a space validation result, without a source object.

Returns: the converted validation result

Parameters:

  • Result (const ESpaceValidationResult) – [in] The space validation result

Returns: EValidationResult

Attributes: inline

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 189, column 19)

Source: Schola/Source/Schola/Public/Common/IValidatable.h (line 120, column 1)