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	isMandatory () const

void	setDefaultValue (const std::string &defVal)

Detailed Description

Describes a plugin's parameter.

A plugin parameter consists of the following informations:

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 66 of file WithParameter.h.

Member Function Documentation

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

inline

Definition at line 103 of file WithParameter.h.

ParameterDirection tlp::ParameterDescription::getDirection ( ) const

inline

Definition at line 121 of file WithParameter.h.

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

inline

Definition at line 97 of file WithParameter.h.

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

inline

Definition at line 85 of file WithParameter.h.

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

inline

Definition at line 91 of file WithParameter.h.

bool tlp::ParameterDescription::isMandatory ( ) const

inline

Definition at line 115 of file WithParameter.h.

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

inline

Sets the parameter's default value.

Definition at line 109 of file WithParameter.h.