tlp::ParameterDescription Class Reference

#include <WithParameter.h>

Public Member Functions
	ParameterDescription (const std::string &name, const std::string &type, const std::string &help, const std::string &defaultValue, bool mandatory, ParameterDirection direction)
const std::string &	getDefaultValue () const
ParameterDirection	getDirection () const
const std::string &	getHelp () const
const std::string &	getName () const
const std::string &	getTypeName () const
bool	isEditable () const
bool	isMandatory () const
void	setDefaultValue (const std::string &defVal)
void	setDirection (ParameterDirection dir)

Detailed Description

Describes a plugin's parameter.

A plugin parameter consists of the following information:

• A name (std::string) which can be used to retrieve the value of the parameter when running the plugin.
• A type (std::string) which is the C++ typename of the parameter.
• A help string (std::string) which gives additional information about the parameter and its possible values.
• A default value which is mapped on the parameter if no value has been entered by the user.
• The mandatory flag (bool) which tells if the parameter is optional or not.
• A ParameterDirection (enum).

See also

tlp::ParameterDirection

tlp::ParameterDescriptionList

tlp::WithParameter

Definition at line 68 of file WithParameter.h.

Member Function Documentation

getDefaultValue()

const std::string& tlp::ParameterDescription::getDefaultValue ( ) const

inline

Returns

The parameter's default value.

Definition at line 106 of file WithParameter.h.

getDirection()

ParameterDirection tlp::ParameterDescription::getDirection ( ) const

inline

Returns

The parameter's direction

Definition at line 124 of file WithParameter.h.

getHelp()

const std::string& tlp::ParameterDescription::getHelp ( ) const

inline

Returns

The parameter's help string

Definition at line 100 of file WithParameter.h.

getName()

const std::string& tlp::ParameterDescription::getName ( ) const

inline

Returns

The parameter's name

Definition at line 88 of file WithParameter.h.

getTypeName()

const std::string& tlp::ParameterDescription::getTypeName ( ) const

inline

Returns

The parameter's C++ type name

Definition at line 94 of file WithParameter.h.

isEditable()

bool tlp::ParameterDescription::isEditable ( ) const

inline

Returns

Whether the parameter is editable or not.

Definition at line 136 of file WithParameter.h.

isMandatory()

bool tlp::ParameterDescription::isMandatory ( ) const

inline

Returns

Whether the parameter is mandatory or not.

Definition at line 118 of file WithParameter.h.

setDefaultValue()

void tlp::ParameterDescription::setDefaultValue ( const std::string &  defVal )

inline

Set the parameter's default value.

Definition at line 112 of file WithParameter.h.

setDirection()

void tlp::ParameterDescription::setDirection ( ParameterDirection  dir )

inline

Returns

Set the parameter's direction

Definition at line 130 of file WithParameter.h.