#include <WithParameter.h>

Inheritance diagram for tlp::WithParameter:

Public Member Functions
template<typename T >
void	addInOutParameter (const std::string &name, const std::string &help=std::string(), const std::string &defaultValue=std::string(), bool isMandatory=true, const std::string &valuesDescription=std::string())

template<typename T >
void	addInParameter (const std::string &name, const std::string &help, const std::string &defaultValue, bool isMandatory=true, const std::string &valuesDescription=std::string())

template<typename T >
void	addOutParameter (const std::string &name, const std::string &help=std::string(), const std::string &defaultValue=std::string(), bool isMandatory=true, const std::string &valuesDescription=std::string())

template<typename T >
void	addParameter (const std::string &name, const std::string &help=std::string(), const std::string &defaultValue=std::string(), bool isMandatory=true)

const tlp::ParameterDescriptionList &	getParameters () const

bool	inputRequired () const

Detailed Description

This class describes parameters on a plug-in.

These parameters can be of any type, and are used to generate a GUI that will be shown when the plug-in in invoked by the user. It is mainly used by algorithms to display options to the user, e.g. a clustering algorithm can let the user choose which measure to use.

Definition at line 294 of file WithParameter.h.

Member Function Documentation

◆ addInOutParameter()

template<typename T >

void tlp::WithParameter::addInOutParameter	(	const std::string &	name,
		const std::string &	help = `std::string()`,
		const std::string &	defaultValue = `std::string()`,
		bool	isMandatory = `true`,
		const std::string &	valuesDescription = `std::string()`
	)

inline

Adds an INOUT parameter to the plug-in.

Parameters

name	The name of the parameter to add.
help	A description of the parameter, that will be displayed to the user. Defaults to "".
defaultValue	The default value the parameter should take, to be the initial value in the GUI. Defaults to "".
isMandatory	Whether this parameter requires a value or not. Defaults to true.
valuesDescription	A description of the values the parameter can take (usually for detailing the content of a StringCollection). Defaults to "".

Returns: void

Definition at line 354 of file WithParameter.h.

◆ addInParameter()

template<typename T >

void tlp::WithParameter::addInParameter	(	const std::string &	name,
		const std::string &	help,
		const std::string &	defaultValue,
		bool	isMandatory = `true`,
		const std::string &	valuesDescription = `std::string()`
	)

inline

Adds an IN parameter to the plug-in.

Parameters

name	The name of the parameter to add.
help	A description of the parameter, that will be displayed to the user. Defaults to "".
defaultValue	The default value the parameter should take, to be the initial value in the GUI. Defaults to "".
isMandatory	Whether this parameter requires a value or not. Defaults to true.
valuesDescription	A description of the values the parameter can take (usually for detailing the content of a StringCollection). Defaults to "".

Returns: void

Definition at line 316 of file WithParameter.h.

◆ addOutParameter()

template<typename T >

void tlp::WithParameter::addOutParameter	(	const std::string &	name,
		const std::string &	help = `std::string()`,
		const std::string &	defaultValue = `std::string()`,
		bool	isMandatory = `true`,
		const std::string &	valuesDescription = `std::string()`
	)

inline

Adds an OUT parameter to the plug-in.

Parameters

name	The name of the parameter to add.
help	A description of the parameter, that will be displayed to the user. Defaults to "".
defaultValue	The default value the parameter should take, to be the initial value in the GUI. Defaults to "".
isMandatory	Whether this parameter requires a value or not. Defaults to true.
valuesDescription	A description of the values the parameter can take (usually for detailing the content of a StringCollection). Defaults to "".

Returns: void

Definition at line 335 of file WithParameter.h.

◆ addParameter()

template<typename T >

void tlp::WithParameter::addParameter	(	const std::string &	name,
		const std::string &	help = `std::string()`,
		const std::string &	defaultValue = `std::string()`,
		bool	isMandatory = `true`
	)

inline

Adds an IN parameter to the plug-in (deprecated)

See also: addInParameter(); addOutParameter()

Parameters

name	The name of the parameter to add.
help	A description of the parameter, that will de displayed to the user. Defaults to 0.
defaultValue	The default value the parameter should take, to be the initial value in the GUI. Defaults to 0.
isMandatory	Whether this parameter requires a value or not. Defaults to true.

Returns: void

Definition at line 375 of file WithParameter.h.

◆ getParameters()

const tlp::ParameterDescriptionList& tlp::WithParameter::getParameters ( ) const

Retrieves the parameters.

Returns: :ParameterDescriptionList the parameters of the plug-in.

◆ inputRequired()

bool tlp::WithParameter::inputRequired ( ) const

indicates whether the embedded parameters require some user input

Returns: true if an input parameter or a property output parameter exists

Public Member Functions

Detailed Description

Member Function Documentation

◆ addInOutParameter()

◆ addInParameter()

◆ addOutParameter()

◆ addParameter()

◆ getParameters()

◆ inputRequired()