Parameter Struct Reference

Holds individual parameter information. More...

#include <cbicaCmdParser.h>

Public Types
enum	Type {   FILE, DIRECTORY, STRING, INTEGER,   FLOAT, BOOLEAN, NONE }

Public Member Functions
	Parameter (const std::string &in_laconic, const std::string &in_verbose, const int &in_dataType, const std::string &in_dataRange, const std::string &in_descriptionLine1, const std::string &in_descriptionLine2="", const std::string &in_descriptionLine3="", const std::string &in_descriptionLine4="", const std::string &in_descriptionLine5="")
	Constructor with five lines of description and enum_code for dataType.
	Parameter (const std::string &in_laconic, const std::string &in_verbose, const std::string &in_dataType, const std::string &in_dataRange, const std::string &in_descriptionLine1, const std::string &in_descriptionLine2="", const std::string &in_descriptionLine3="", const std::string &in_descriptionLine4="", const std::string &in_descriptionLine5="")
	Constructor with five lines of description and string for dataType.

Public Attributes
std::string	dataRange
int	dataType_enumCode
std::string	dataType_string
std::string	descriptionLine1
std::string	descriptionLine2
std::string	descriptionLine3
	defaults to blank
std::string	descriptionLine4
	defaults to blank
std::string	descriptionLine5
	defaults to blank
std::string	laconic
size_t	length
	defaults to blank
std::string	verbose

Detailed Description

Holds individual parameter information.

This is a helper struct for internal usage of different functions and classes (right now, the function ReadConfigFile() and the class CmdParser() use it). It is not meant to be used from a program directly. All variables are self-explanatory. Currently, a maxium of five lines of description are supported.

---

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

• src/classes/cbicaCmdParser.h