Parameter for indexed strings selected from a predefined list of strings. If ParamType is of type ParamsBase::IndexedTextList, then extend TypedParamBase's functionality by providing text list functionality and by overriding AddToDialogChild(). In this case, the parameter does not store the string itself, but the selected index (of type Util::TextListIndexType) of the predefined text list. More...

#include <Object.h>

Inheritance diagram for DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >:

Public Member Functions
	Param (ParamsBase &Owner, Util::TextListType &&TextList, std::string ParamName, std::string_view ParamTitle, std::string_view ParamDescription, bool NeedsResetToApplyChange=true, UnderlyingIndexedTextListParamType::UnderlyingType DefaultValue=0)
	Base constructor of any parameter to be used if a parameter should be displayed in a settings dialog (UserEditable is set to true).

	Param (ParamsBase &Owner, Util::TextListType &&TextList, std::string ParamName, UnderlyingIndexedTextListParamType::UnderlyingType DefaultValue=0)
	Base constructor of any parameter to be used if a parameter should not be displayed in a settings dialog (UserEditable is set to false).

const ParamType &	operator= (const ParamType &NewValue)
	Assigns a new value to this parameter. The operator cannot be accessed by `Object` because this function is not const.

Thread-safe getter functions
Thread-safe since const member variables are returned.
const auto &	GetTextList () const noexcept
	Returns the predefined selection options as a list of strings.

Public Member Functions inherited from DynExp::ParamsBase::TypedParamBase< ParamType >
ParamType	GetDefaultValue () const noexcept
	Returns this parameter's default value. Thread-safe since a const member variable is returned.

	operator ParamType () const noexcept
	Converts the parameter implicitly to its underlying type returning its current value.

const ParamType &	Get () const noexcept
	Returns the parameter's value.

const ParamType &	operator= (const ParamType &NewValue)
	Assigns a new value to this parameter. The operator cannot be accessed by `Object` because this function is not const.

Public Member Functions inherited from DynExp::ParamsBase::ParamBase
	ParamBase (const ParamBase &)=delete

ParamBase &	operator= (const ParamBase &)=delete

QDomElement	ToXMLNode (QDomDocument &Document) const
	Converts this parameter to a Qt dom element (describing an XML node containing this parameter's name and value).

void	FromXMLNode (const QDomElement &XMLElement)
	Restores this parameter's value from the given Qt dom element (describing an XML node)

bool	Validate ()
	Checks whether a valid value is assigned to this parameter. This function is not const since it is also intended to reset the parameter if it is invalid.

void	Reset ()
	Resets this parameter to its default value.

bool	IsUserEditable () const noexcept
	Returns ParamBase::UserEditable.

std::string_view	GetParamName () const noexcept
	Returns ParamBase::ParamName.

std::string_view	GetParamTitle () const noexcept
	Returns ParamBase::ParamTitle.

std::string_view	GetParamDescription () const noexcept
	Returns ParamBase::ParamDescription.

bool	GetNeedsResetToApplyChange () const noexcept
	Returns ParamBase::NeedsResetToApplyChange.

Private Member Functions
virtual void	AddToDialogChild (ParamsConfigDialog &Dialog) override final
	Appends this parameter to a settings dialog making it configurable by the user.

virtual bool	ValidateValue (const ParamType &Value) const override
	Called by ValidateChild(). Validates a single value. Override to validate the value which is about to be assigned to the parameter. Returns true by default.

Private Attributes
const Util::TextListType	TextList
	Predefined selection options.

Additional Inherited Members
Public Types inherited from DynExp::ParamsBase::TypedParamBase< ParamType >
using	UnderlyingType = ParamType

Public Attributes inherited from DynExp::ParamsBase::ParamBase
ParamsBaseOnlyType	ParamsBaseOnly
	Provides the class `ParamsBase` access to some private members of class `ParamBase`.

Protected Member Functions inherited from DynExp::ParamsBase::TypedParamBase< ParamType >
	TypedParamBase (ParamsBase &Owner, std::string ParamName, std::string_view ParamTitle, std::string_view ParamDescription, bool NeedsResetToApplyChange=true, ParamType DefaultValue=ParamType())
	Base constructor of any parameter to be used if a parameter should be displayed in a settings dialog (UserEditable is set to true).

	TypedParamBase (ParamsBase &Owner, std::string ParamName, ParamType DefaultValue=ParamType())
	Base constructor of any parameter to be used if a parameter should not be displayed in a settings dialog (UserEditable is set to false).

virtual void	ToXMLNodeChild (QDomDocument &Document, QDomElement &XMLElement) const override
	Converts this parameter to a Qt dom element (describing an XML node containing this parameter's name and value).

virtual void	FromXMLNodeChild (const QDomElement &XMLElement) override
	Restores this parameter's value from the given Qt dom element (describing an XML node)

Protected Member Functions inherited from DynExp::ParamsBase::ParamBase
	ParamBase (ParamsBase &Owner, std::string ParamName, std::string_view ParamTitle, std::string_view ParamDescription, bool NeedsResetToApplyChange)
	Base constructor of any parameter to be used if a parameter should be displayed in a settings dialog (UserEditable is set to true).

	ParamBase (ParamsBase &Owner, std::string ParamName)
	Base constructor of any parameter to be used if a parameter should not be displayed in a settings dialog (UserEditable is set to false).

virtual	~ParamBase ()=0

const auto &	GetOwner () const noexcept
	Returns the ParamsBase instance owning this ParamBase instance.

auto &	GetOwner () noexcept
	Returns the ParamsBase instance owning this ParamBase instance.

Detailed Description

template<typename ParamType>
class DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >

Parameter for indexed strings selected from a predefined list of strings. If ParamType is of type ParamsBase::IndexedTextList, then extend TypedParamBase's functionality by providing text list functionality and by overriding AddToDialogChild(). In this case, the parameter does not store the string itself, but the selected index (of type Util::TextListIndexType) of the predefined text list.

Template Parameters

ParamType Indexed text list type (same as or derived from ParamsBase::IndexedTextList)

Definition at line 992 of file Object.h.

Constructor & Destructor Documentation

◆ Param() [1/2]

template<typename ParamType >

DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >::Param	(	ParamsBase &	Owner,
		Util::TextListType &&	TextList,
		std::string	ParamName,
		std::string_view	ParamTitle,
		std::string_view	ParamDescription,
		bool	NeedsResetToApplyChange = `true`,
		UnderlyingIndexedTextListParamType::UnderlyingType	DefaultValue = `0`
	)

inline

Base constructor of any parameter to be used if a parameter should be displayed in a settings dialog (UserEditable is set to true).

Parameters

Owner	ParamsBase instance owning this parameter.
ParamName	Name of the parameter to be used in the XML config file. std::string to allow for auto-generated names.
ParamTitle	Title of the parameter to be displayed in settings dialogs. A static string literal with a constant address is expected.
ParamDescription	Detailed description of the parameter to be displayed in settings dialogs. A static string literal with a constant address is expected.
NeedsResetToApplyChange	Indicated whether the object this parameter belongs to needs to be reset to apply changes if this parameter's value has changed.
DefaultValue	Default value to assign to the constructed parameter
TextList	Predefined list of strings to select a string from

Definition at line 1001 of file Object.h.

◆ Param() [2/2]

template<typename ParamType >

DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >::Param	(	ParamsBase &	Owner,
		Util::TextListType &&	TextList,
		std::string	ParamName,
		UnderlyingIndexedTextListParamType::UnderlyingType	DefaultValue = `0`
	)

inline

Base constructor of any parameter to be used if a parameter should not be displayed in a settings dialog (UserEditable is set to false).

Parameters

Owner	ParamsBase instance owning this parameter.
ParamName	Name of the parameter to be used in the XML config file. std::string to allow for auto-generated names.
DefaultValue	Default value to assign to the constructed parameter
TextList	List of strings to select a string from

Definition at line 1010 of file Object.h.

Member Function Documentation

◆ AddToDialogChild()

template<typename ParamType >

virtual void DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >::AddToDialogChild ( ParamsConfigDialog & Dialog )

inlinefinaloverrideprivatevirtual

Appends this parameter to a settings dialog making it configurable by the user.

Parameters

Dialog Reference to the settings dialog to append the parameter to

Implements DynExp::ParamsBase::ParamBase.

Definition at line 1023 of file Object.h.

◆ GetTextList()

template<typename ParamType >

const auto & DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >::GetTextList ( ) const

inlinenoexcept

Returns the predefined selection options as a list of strings.

Definition at line 1019 of file Object.h.

◆ operator=()

template<typename ParamType >

const ParamType & DynExp::ParamsBase::TypedParamBase< ParamType >::operator= ( const ParamType & NewValue )

inline

Assigns a new value to this parameter. The operator cannot be accessed by Object because this function is not const.

Parameters

NewValue New value to assign

Returns: Reference to this parameter

Exceptions

Util::InvalidArgException is thrown if the value to assign to the parameter is not considered valid as determined by a call to ParamBase::Validate().

Definition at line 587 of file Object.h.

◆ ValidateValue()

template<typename ParamType >

virtual bool DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >::ValidateValue ( const ParamType & NewValue ) const

inlineoverrideprivatevirtual

Called by ValidateChild(). Validates a single value. Override to validate the value which is about to be assigned to the parameter. Returns true by default.

Parameters

NewValue Value to be validated before the assignment

Returns: Returns true if NewValue is considered valid, false otherwise.

Reimplemented from DynExp::ParamsBase::TypedParamBase< ParamType >.

Definition at line 1029 of file Object.h.

Member Data Documentation

◆ TextList

template<typename ParamType >

const Util::TextListType DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< IndexedTextList, ParamType > > >::TextList

private

Predefined selection options.

Definition at line 1031 of file Object.h.

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

Object.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Param() [1/2]

◆ Param() [2/2]

Member Function Documentation

◆ AddToDialogChild()

◆ GetTextList()

◆ operator=()

◆ ValidateValue()

Member Data Documentation

◆ TextList