Abstractions for a SDL value type that can be empty. More...

#include <TSdlOptionalValue.h>

Inheritance diagram for ph::TSdlOptionalValue< T, Owner >:

Public Member Functions
	TSdlOptionalValue (std::string typeName, std::string valueName, std::optional< T > Owner::*valuePtr)

	TSdlOptionalValue (std::string typeName, std::string valueName, std::string typeSignature, std::optional< T > Owner::*valuePtr)

std::string	valueAsString (const T &value) const override=0
	Human-readable representation of the value.

SdlNativeData	ownedNativeData (Owner &owner) const override=0
	Direct access to the field memory of an owner. Short-lived owner objects such as function parameter structs must be kept alive during during this call and any further usages of the returned native data.

void	setValue (Owner &owner, T value) const override
	Store a value.

T *	getValue (Owner &owner) const override
	Get a pointer to the stored value.

const T *	getConstValue (const Owner &owner) const override
	Get a pointer to the stored value.

void	ownedValueToDefault (Owner &owner) const override
	Set the value of the field to a default one. Since the field class is templatized by `Owner` type, we are able to define default value on a per owner type basis.

TSdlOptionalValue &	description (std::string descriptionStr)

Public Member Functions inherited from ph::TSdlAbstractValue< T, Owner >
	TSdlAbstractValue (std::string typeName, std::string valueName)

	TSdlAbstractValue (std::string typeName, std::string valueName, std::string typeSignature)

std::string	valueToString (const Owner &owner) const override
	Convert the value of the field to human-readable string.

void	ownedResources (const Owner &owner, std::vector< const ISdlResource * > &out_resources) const override
	Get all SDL resources associated by `owner`.

Public Member Functions inherited from ph::TSdlOwnedField< Owner >
	TSdlOwnedField (std::string typeName, std::string valueName)

	TSdlOwnedField (std::string typeName, std::string valueName, std::string typeSignature)

SdlNativeData	nativeData (SdlNonConstInstance instance) const override
	Direct access to the field memory of a SDL instance. Note that this field may not necessarily be bound to a SDL resource type (e.g., may bound to any function parameter structs). Empty native data info will be returned in cases where this field is not owned by (or being part of) the input instance. Obtaining native data requires the input instance be valid during this call and any further usages of the returned native data.

void	fromSdl (Owner &owner, const SdlInputClause &clause, const SdlInputContext &ctx) const
	Acquire value and store in the owner's field. The loading process will follow a series of preset policy. In addition, failed loading attempt may be recovered if needed.

void	toSdl (const Owner &owner, SdlOutputClause &out_clause, const SdlOutputContext &ctx) const

Public Member Functions inherited from ph::SdlField
	SdlField (std::string typeName, std::string fieldName)

	SdlField (std::string typeName, std::string fieldName, std::string typeSignature)

virtual	~SdlField ()

std::string	genPrettyName () const

std::string_view	getTypeName () const

std::string_view	getFieldName () const

std::string_view	getDescription () const

std::string_view	getTypeSignature () const

EFieldImportance	getImportance () const

bool	isFallbackEnabled () const
	Whether the field want to use built-in mechanism to handle I/O problems. An example of this is default field value. With fallback enabled, the field may set itself to the default value supplied (if available) on error. By default, fallback is enabled.

Protected Member Functions
void	loadFromSdl (Owner &owner, const SdlInputClause &clause, const SdlInputContext &ctx) const override=0
	Load SDL value to actual value and store it in the owner's field. Implementations are highly encouraged to throw SdlLoadError if the loading process is not successful. This will allow things such as automatic fallback to work according to field policies.

void	saveToSdl (const Owner &owner, SdlOutputClause &out_clause, const SdlOutputContext &ctx) const override=0
	Convert actual value back to SDL value. Saving a loaded value as SDL value should rarely fail–as loaded value has been properly handled by the loading process already. In case of failure, throw SdlSaveError and provide detailed reason describing the event.

std::optional< T > &	valueRef (Owner &owner) const

Protected Member Functions inherited from ph::SdlField
SdlField &	setDescription (std::string descriptionStr)

SdlField &	setImportance (EFieldImportance importance)
	Sets the importance of the field. Different importance affect the underlying policy used during the import and export of the field, e.g., whether warnings are emitted.

SdlField &	setEnableFallback (bool isFallbackEnabled)

Detailed Description

template<typename T, typename Owner>
class ph::TSdlOptionalValue< T, Owner >

Abstractions for a SDL value type that can be empty.

An optional SDL value defaults to empty (no value) and has optional importance (EFieldImportance::Optional) always. While no default value can be provided for the optional field, it allows the detection of uninitialized value during runtime. If the above properties are undesired, consider using TSdlValue.

Constructor & Destructor Documentation

◆ TSdlOptionalValue() [1/2]

template<typename T , typename Owner >

ph::TSdlOptionalValue< T, Owner >::TSdlOptionalValue	(	std::string	typeName,
		std::string	valueName,
		std::optional< T > Owner::*	valuePtr )

inline

◆ TSdlOptionalValue() [2/2]

template<typename T , typename Owner >

ph::TSdlOptionalValue< T, Owner >::TSdlOptionalValue	(	std::string	typeName,
		std::string	valueName,
		std::string	typeSignature,
		std::optional< T > Owner::*	valuePtr )

inline

Member Function Documentation

◆ description()

template<typename T , typename Owner >

auto ph::TSdlOptionalValue< T, Owner >::description ( std::string descriptionStr )

inline

◆ getConstValue()

template<typename T , typename Owner >

const T * ph::TSdlOptionalValue< T, Owner >::getConstValue ( const Owner & owner ) const

inlineoverridevirtual

Get a pointer to the stored value.

Returns: Pointer to the stored value. nullptr if no value is stored.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ getValue()

template<typename T , typename Owner >

T * ph::TSdlOptionalValue< T, Owner >::getValue ( Owner & owner ) const

inlineoverridevirtual

Get a pointer to the stored value.

Returns: Pointer to the stored value. nullptr if no value is stored.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ loadFromSdl()

template<typename T , typename Owner >

void ph::TSdlOptionalValue< T, Owner >::loadFromSdl	(	Owner &	owner,
		const SdlInputClause &	clause,
		const SdlInputContext &	ctx ) const

overrideprotectedpure virtual

Load SDL value to actual value and store it in the owner's field. Implementations are highly encouraged to throw SdlLoadError if the loading process is not successful. This will allow things such as automatic fallback to work according to field policies.

Parameters

owner	Instance that owns the field.
clause	The SDL representation to be loaded into actual value.
ctx	The context for loading.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ ownedNativeData()

template<typename T , typename Owner >

SdlNativeData ph::TSdlOptionalValue< T, Owner >::ownedNativeData ( Owner & owner ) const

overridepure virtual

Direct access to the field memory of an owner. Short-lived owner objects such as function parameter structs must be kept alive during during this call and any further usages of the returned native data.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ ownedValueToDefault()

template<typename T , typename Owner >

void ph::TSdlOptionalValue< T, Owner >::ownedValueToDefault ( Owner & owner ) const

inlineoverridevirtual

Set the value of the field to a default one. Since the field class is templatized by Owner type, we are able to define default value on a per owner type basis.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ saveToSdl()

template<typename T , typename Owner >

void ph::TSdlOptionalValue< T, Owner >::saveToSdl	(	const Owner &	owner,
		SdlOutputClause &	out_clause,
		const SdlOutputContext &	ctx ) const

overrideprotectedpure virtual

Convert actual value back to SDL value. Saving a loaded value as SDL value should rarely fail–as loaded value has been properly handled by the loading process already. In case of failure, throw SdlSaveError and provide detailed reason describing the event.

Parameters

owner	Instance that owns the field.
out_clause	The SDL representation for the actual value.
ctx	The context for saving.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ setValue()

template<typename T , typename Owner >

void ph::TSdlOptionalValue< T, Owner >::setValue	(	Owner &	owner,
		T	value ) const

inlineoverridevirtual

Store a value.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ valueAsString()

template<typename T , typename Owner >

std::string ph::TSdlOptionalValue< T, Owner >::valueAsString ( const T & value ) const

overridepure virtual

Human-readable representation of the value.

Implements ph::TSdlAbstractValue< T, Owner >.

◆ valueRef()

template<typename T , typename Owner >

std::optional< T > & ph::TSdlOptionalValue< T, Owner >::valueRef ( Owner & owner ) const

inlineprotected

The documentation for this class was generated from the following files:

Source/SDL/Introspect/TSdlOptionalValue.h
Source/SDL/Introspect/TSdlOptionalValue.ipp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TSdlOptionalValue() [1/2]

◆ TSdlOptionalValue() [2/2]

Member Function Documentation

◆ description()

◆ getConstValue()

◆ getValue()

◆ loadFromSdl()

◆ ownedNativeData()

◆ ownedValueToDefault()

◆ saveToSdl()

◆ setValue()

◆ valueAsString()

◆ valueRef()