dw::framework::ParameterDescriptorWithDefault< DefaultType > Class Template Reference

Detailed Description

template<typename DefaultType>
class dw::framework::ParameterDescriptorWithDefault< DefaultType >

The description of a parameter with a default value.

Definition at line 142 of file ParameterCollectionDescriptor.hpp.

Inheritance diagram for dw::framework::ParameterDescriptorWithDefault< DefaultType >:

Collaboration diagram for dw::framework::ParameterDescriptorWithDefault< DefaultType >:

Public Member Functions
void	addDefault (nlohmann::ordered_json &object) const noexcept override
	Add the default value to the passed JSON object. More...
auto	operator= (ParameterDescriptorWithDefault &&) -> ParameterDescriptorWithDefault &=delete
	Move assignment operator. More...
auto	operator= (ParameterDescriptorWithDefault const &) -> ParameterDescriptorWithDefault &=delete
	Copy assignment operator. More...
	ParameterDescriptorWithDefault (dw::core::StringView name, dw::core::StringView typeName, bool isIndex, size_t arraySize, DefaultType defaultValue)
	Constructor. More...
	ParameterDescriptorWithDefault (ParameterDescriptorWithDefault &&)=delete
	Move constructor. More...
	ParameterDescriptorWithDefault (ParameterDescriptorWithDefault const &)=delete
	Copy constructor. More...
	~ParameterDescriptorWithDefault () override=default
	Destructor. More...
Public Member Functions inherited from dw::framework::ParameterDescriptor
virtual void	addDefault (nlohmann::ordered_json &object) const noexcept
	Add the default value to the passed JSON object (only used by ParameterDescriptorWithDefault()). More...
size_t	getArraySize () const noexcept
	Get the array size, 0 for non-array parameters. More...
dw::core::StringView const &	getName () const noexcept
	Get the parameter name, can be empty for unnamed parameters. More...
dw::core::StringView const &	getTypeName () const noexcept
	Get the C++ type name of the parameter. More...
bool	isIndex () const noexcept
	Check if parameter is an index. More...
ParameterDescriptor &	operator= (ParameterDescriptor &&) &=delete
	Move assignment operator. More...
ParameterDescriptor &	operator= (ParameterDescriptor const &) &=delete
	Copy assignment operator. More...
	ParameterDescriptor (dw::core::StringView const &name, dw::core::StringView const &typeName, const bool isIndex, size_t const arraySize) noexcept
	Constructor. More...
	ParameterDescriptor (ParameterDescriptor &&)=delete
	Move constructor. More...
	ParameterDescriptor (ParameterDescriptor const &)=delete
	Copy constructor. More...
virtual	~ParameterDescriptor ()=default
	Destructor. More...

Constructor & Destructor Documentation

ParameterDescriptorWithDefault() [1/3]

template<typename DefaultType >

dw::framework::ParameterDescriptorWithDefault< DefaultType >::ParameterDescriptorWithDefault ( dw::core::StringView  name, dw::core::StringView  typeName, bool  isIndex, size_t  arraySize, DefaultType  defaultValue  )

inline

Constructor.

Definition at line 147 of file ParameterCollectionDescriptor.hpp.

~ParameterDescriptorWithDefault()

template<typename DefaultType >

dw::framework::ParameterDescriptorWithDefault< DefaultType >::~ParameterDescriptorWithDefault ( )

overridedefault

Destructor.

ParameterDescriptorWithDefault() [2/3]

template<typename DefaultType >

dw::framework::ParameterDescriptorWithDefault< DefaultType >::ParameterDescriptorWithDefault ( ParameterDescriptorWithDefault< DefaultType > const &  )

delete

Copy constructor.

ParameterDescriptorWithDefault() [3/3]

template<typename DefaultType >

dw::framework::ParameterDescriptorWithDefault< DefaultType >::ParameterDescriptorWithDefault ( ParameterDescriptorWithDefault< DefaultType > &&  )

delete

Move constructor.

Member Function Documentation

addDefault()

template<typename DefaultType >

void dw::framework::ParameterDescriptorWithDefault< DefaultType >::addDefault ( nlohmann::ordered_json &  object ) const

inlineoverridevirtualnoexcept

Add the default value to the passed JSON object.

Reimplemented from dw::framework::ParameterDescriptor.

Definition at line 168 of file ParameterCollectionDescriptor.hpp.

operator=() [1/2]

template<typename DefaultType >

auto dw::framework::ParameterDescriptorWithDefault< DefaultType >::operator= ( ParameterDescriptorWithDefault< DefaultType > &&  ) -> ParameterDescriptorWithDefault &=delete

delete

Move assignment operator.

operator=() [2/2]

template<typename DefaultType >

auto dw::framework::ParameterDescriptorWithDefault< DefaultType >::operator= ( ParameterDescriptorWithDefault< DefaultType > const &  ) -> ParameterDescriptorWithDefault &=delete

delete

Copy assignment operator.

---

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

• src/dwcgf/parameter/ParameterCollectionDescriptor.hpp