icl_core::config::GetoptPositionalParameter Class Reference

#include <GetoptPositionalParameter.h>

Inheritance diagram for icl_core::config::GetoptPositionalParameter:

Public Member Functions
	GetoptPositionalParameter (const icl_core::String &name, const icl_core::String &help, const bool is_optional=false)
icl_core::String	help () const
	Get the help text. More...
bool	isOptional () const
	Get if the parameter is optional. More...
icl_core::String	name () const
	Get the option name. More...

Private Attributes
icl_core::String	m_help
bool	m_is_optional
icl_core::String	m_name

Detailed Description

Definition at line 35 of file GetoptPositionalParameter.h.

Constructor & Destructor Documentation

icl_core::config::GetoptPositionalParameter::GetoptPositionalParameter	(	const icl_core::String &	name,
		const icl_core::String &	help,
		const bool	is_optional = false
	)

Create a new positional commandline parameter.

Parameters

name	The name of the parameter.
help	A help text that will be used in the generic help.
is_optional	Iff the parameter is an optional parameter.

Definition at line 28 of file GetoptPositionalParameter.cpp.

Member Function Documentation

icl_core::String icl_core::config::GetoptPositionalParameter::help ( ) const

inline

Get the help text.

Definition at line 51 of file GetoptPositionalParameter.h.

bool icl_core::config::GetoptPositionalParameter::isOptional ( ) const

inline

Get if the parameter is optional.

Definition at line 53 of file GetoptPositionalParameter.h.

icl_core::String icl_core::config::GetoptPositionalParameter::name ( ) const

inline

Get the option name.

Definition at line 49 of file GetoptPositionalParameter.h.

Member Data Documentation

icl_core::String icl_core::config::GetoptPositionalParameter::m_help

private

Definition at line 57 of file GetoptPositionalParameter.h.

bool icl_core::config::GetoptPositionalParameter::m_is_optional

private

Definition at line 58 of file GetoptPositionalParameter.h.

icl_core::String icl_core::config::GetoptPositionalParameter::m_name

private

Definition at line 56 of file GetoptPositionalParameter.h.

---

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

• GetoptPositionalParameter.h
• GetoptPositionalParameter.cpp