Parameter for strings selected from a predefined list of strings. If ParamType is of type ParamsBase::TextList, then extend TypedParamBase's functionality by providing text list functionality and by overriding AddToDialogChild(). More...

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

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

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

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. More...

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. More...

Not thread-safe
Not (!) thread-safe, but these functions are intended to be called through ParamsBase::ConfigureParamsImpl() which takes care of synchronizing if an existing parameter object is to be edited by the user and not newly created.
void	SetTextList (Util::TextListType &&NewTextList)
	Resets the predefined list of strings to select a string from. More...

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. More...

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

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

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. More...

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). More...

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

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. More...

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

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

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

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

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

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

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

Private Attributes
Util::TextListType	TextList
	Predefined selection options. Not constant because this should be changeable dynamically (e.g. to enumerate connected devices just before displaying a settings dialog where a connected device can be chosen). Since the underlying type is just a string, there is no constraint on the allowed values - in contrast to e.g. an indexed text list. More...

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`. More...

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). More...

	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). More...

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). More...

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

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). More...

	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). More...

virtual	~ParamBase ()=0

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

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

Detailed Description

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

Parameter for strings selected from a predefined list of strings. If ParamType is of type ParamsBase::TextList, then extend TypedParamBase's functionality by providing text list functionality and by overriding AddToDialogChild().

Template Parameters

ParamType Text list type (same as or derived from ParamsBase::TextList)

Definition at line 925 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< TextList, ParamType > > >::Param	(	ParamsBase &	Owner,
		Util::TextListType &&	TextList,
		std::string	ParamName,
		std::string_view	ParamTitle,
		std::string_view	ParamDescription,
		bool	NeedsResetToApplyChange = `true`,
		UnderlyingTextListParamType::UnderlyingType	DefaultValue = `""`
	)

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 934 of file Object.h.

◆ Param() [2/2]

template<typename ParamType >

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

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 943 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< TextList, 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 968 of file Object.h.

◆ GetTextList()

template<typename ParamType >

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

inlinenoexcept

Returns the predefined selection options as a list of strings.

Definition at line 952 of file Object.h.

◆ operator=()

template<typename ParamType >

const ParamType& DynExp::ParamsBase::TypedParamBase< ParamType >::operator=

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.

◆ SetTextList()

template<typename ParamType >

void DynExp::ParamsBase::Param< ParamType, std::enable_if_t< std::is_base_of_v< TextList, ParamType > > >::SetTextList ( Util::TextListType && NewTextList )

inline

Resets the predefined list of strings to select a string from.

Parameters

NewTextList New predefined selection options as a list of strings

Definition at line 964 of file Object.h.

Member Data Documentation

◆ TextList

template<typename ParamType >

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

private

Predefined selection options. Not constant because this should be changeable dynamically (e.g. to enumerate connected devices just before displaying a settings dialog where a connected device can be chosen). Since the underlying type is just a string, there is no constraint on the allowed values - in contrast to e.g. an indexed text list.

Definition at line 980 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

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

Constructor & Destructor Documentation

◆ Param() [1/2]

◆ Param() [2/2]

Member Function Documentation

◆ AddToDialogChild()

◆ GetTextList()

◆ operator=()

◆ SetTextList()

Member Data Documentation

◆ TextList

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