#include <param.h>

Inheritance diagram for paramkit::StringListParam:

[legend]

Public Member Functions
	StringListParam (const std::string &_argStr, bool _isRequired, char _delimiter)

	StringListParam (const std::string &_argStr, bool _isRequired, std::string _delimiter)

virtual std::string	type () const
	Returns the string representation of the parameter's type. More...

size_t	stripToElements (OUT std::set< std::string > &elements_list)

Public Member Functions inherited from paramkit::StringParam
	StringParam (const std::string &_argStr, bool _isRequired)

virtual std::string	valToString () const
	Returns the string representation of the parameter's value. More...

virtual bool	isSet () const
	Returns true if the parameter is filled, false otherwise. More...

virtual bool	parse (const char *arg)
	Parses the parameter from the given string. More...

size_t	copyToCStr (char *buf, size_t buf_max) const
	Copy the stored string value into an external buffer of a given length. More...

Public Member Functions inherited from paramkit::Param
	Param (const std::string &_argStr, bool _isRequired)
	A constructor of a parameter. More...

	Param (const std::string &_argStr, const std::string &_typeDescStr, bool _isRequired)
	A constructor of a parameter. More...

virtual bool	parse (const wchar_t *arg)
	Parses the parameter from the given wide string. More...

void	setActive (bool _active)

virtual bool	isActive () const
	Returns true if the parameter is active, false otherwise. More...

virtual std::string	info (bool isExtended) const

void	printInColor (int color)
	Prints the parameter using the given color. Appends the parameter switch to the name. More...

Public Attributes
const std::string	delimiter

Public Attributes inherited from paramkit::StringParam
std::string	value

Additional Inherited Members
Protected Member Functions inherited from paramkit::Param
void	printDesc (bool isExtended=true) const
	Prints a formatted description of the parameter, including its unique name, type, and the info. More...

virtual bool	isNameSimilar (const std::string &filter)
	Checks if the param name is similar to the given filter. More...

virtual bool	isKeywordInType (const std::string &keyword)
	Checks if the parameter type contains the keyword. More...

virtual bool	isKeywordInDescription (const std::string &keyword)
	Checks if the description contains the keyword. More...

virtual std::string	extendedInfo () const
	Extended information. More...

Protected Attributes inherited from paramkit::Param
std::string	argStr
	a unique name of the parameter More...

std::string	typeDescStr
	a description of the type of the parameter: what type of values are allowed More...

std::string	m_info
	a basic information about the the parameter's purpose More...

std::string	m_extInfo
	an extended information about the the parameter's purpose More...

bool	isRequired
	a flag indicating if this parameter is required More...

bool	requiredArg
	a flag indicating if this parameter needs to be followed by a value More...

bool	active
	a flag indicating if this parameter is available More...

Detailed Description

Definition at line 577 of file param.h.

Constructor & Destructor Documentation

◆ StringListParam() [1/2]

paramkit::StringListParam::StringListParam	(	const std::string &	_argStr,
		bool	_isRequired,
		char	_delimiter
	)

inline

Definition at line 579 of file param.h.

◆ StringListParam() [2/2]

paramkit::StringListParam::StringListParam	(	const std::string &	_argStr,
		bool	_isRequired,
		std::string	_delimiter
	)

inline

Definition at line 585 of file param.h.

Member Function Documentation

◆ stripToElements()

size_t paramkit::StringListParam::stripToElements ( OUT std::set< std::string > & elements_list )

inline

Definition at line 596 of file param.h.

Here is the call graph for this function:

◆ type()

virtual std::string paramkit::StringListParam::type ( ) const

inlinevirtual

Returns the string representation of the parameter's type.

Reimplemented from paramkit::StringParam.

Reimplemented in paramkit::IntListParam.

Definition at line 591 of file param.h.

Member Data Documentation

◆ delimiter

const std::string paramkit::StringListParam::delimiter

Definition at line 601 of file param.h.

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

paramkit/include/param.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StringListParam() [1/2]

◆ StringListParam() [2/2]

Member Function Documentation

◆ stripToElements()

◆ type()

Member Data Documentation

◆ delimiter