dw::framework::ParameterDescriptor Class Reference

Detailed Description

The description of a parameter.

Definition at line 48 of file ParameterCollectionDescriptor.hpp.

Inheritance diagram for dw::framework::ParameterDescriptor:

Public Member Functions
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

ParameterDescriptor() [1/3]

dw::framework::ParameterDescriptor::ParameterDescriptor ( dw::core::StringView const &  name, dw::core::StringView const &  typeName, const bool  isIndex, size_t const  arraySize  )

noexcept

Constructor.

~ParameterDescriptor()

virtual dw::framework::ParameterDescriptor::~ParameterDescriptor ( )

virtualdefault

Destructor.

ParameterDescriptor() [2/3]

dw::framework::ParameterDescriptor::ParameterDescriptor ( ParameterDescriptor const &  )

delete

Copy constructor.

ParameterDescriptor() [3/3]

dw::framework::ParameterDescriptor::ParameterDescriptor ( ParameterDescriptor &&  )

delete

Move constructor.

Member Function Documentation

addDefault()

virtual void dw::framework::ParameterDescriptor::addDefault ( nlohmann::ordered_json &  object ) const

virtualnoexcept

Add the default value to the passed JSON object (only used by ParameterDescriptorWithDefault()).

Reimplemented in dw::framework::ParameterDescriptorWithDefault< DefaultType >.

getArraySize()

size_t dw::framework::ParameterDescriptor::getArraySize ( ) const

noexcept

Get the array size, 0 for non-array parameters.

getName()

dw::core::StringView const & dw::framework::ParameterDescriptor::getName ( ) const

noexcept

Get the parameter name, can be empty for unnamed parameters.

getTypeName()

dw::core::StringView const & dw::framework::ParameterDescriptor::getTypeName ( ) const

noexcept

Get the C++ type name of the parameter.

isIndex()

bool dw::framework::ParameterDescriptor::isIndex ( ) const

noexcept

Check if parameter is an index.

operator=() [1/2]

ParameterDescriptor & dw::framework::ParameterDescriptor::operator= ( ParameterDescriptor &&  ) &

delete

Move assignment operator.

operator=() [2/2]

ParameterDescriptor & dw::framework::ParameterDescriptor::operator= ( ParameterDescriptor const &  ) &

delete

Copy assignment operator.

---

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

• src/dwcgf/parameter/ParameterCollectionDescriptor.hpp