paramkit::StringParam Class Reference

A parameter storing a string value. More...

#include <param.h>

Inheritance diagram for paramkit::StringParam:

Public Member Functions
	StringParam (const std::string &_argStr, bool _isRequired)
virtual std::string	valToString () const
	Returns the string representation of the parameter's value. More...
virtual std::string	type () const
	Returns the string representation of the parameter's type. 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
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

A parameter storing a string value.

Definition at line 276 of file param.h.

Constructor & Destructor Documentation

StringParam()

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

inline

Definition at line 278 of file param.h.

Member Function Documentation

copyToCStr()

size_t paramkit::StringParam::copyToCStr ( char *  buf, size_t  buf_max  ) const

inline

Copy the stored string value into an external buffer of a given length.

Definition at line 308 of file param.h.

Here is the call graph for this function:

isSet()

virtual bool paramkit::StringParam::isSet ( ) const

inlinevirtual

Returns true if the parameter is filled, false otherwise.

Implements paramkit::Param.

Definition at line 294 of file param.h.

parse()

virtual bool paramkit::StringParam::parse ( const char *  arg )

inlinevirtual

Parses the parameter from the given string.

Implements paramkit::Param.

Reimplemented in paramkit::IntListParam.

Definition at line 299 of file param.h.

type()

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

inlinevirtual

Returns the string representation of the parameter's type.

Implements paramkit::Param.

Reimplemented in paramkit::IntListParam, and paramkit::StringListParam.

Definition at line 290 of file param.h.

valToString()

virtual std::string paramkit::StringParam::valToString ( ) const

inlinevirtual

Returns the string representation of the parameter's value.

Implements paramkit::Param.

Definition at line 285 of file param.h.

Member Data Documentation

value

std::string paramkit::StringParam::value

Definition at line 313 of file param.h.

---

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

• paramkit/include/param.h