isis::util::ParameterMap Class Reference

A Map of all current Program Parameters when reading from the commandline. More...

#include <progparameter.hpp>

Inherits std::map< std::string, ProgParameter >.

Data Structures
struct	hiddenP
struct	neededP
struct	notneededP
Public Member Functions
bool	isComplete () const
ProgParameter &	operator[] (const std::string key)
const ProgParameter	operator[] (const std::string key) const
	ParameterMap ()
bool	parse (int argc, char **argv)
	Reads and tokenizes argv, detecs the parameter names (names are preceded by a "-") and sends the values (everything between one parameter name and the other) to the corresponding ProgParameter-objects to be parsed.

---

Detailed Description

A Map of all current Program Parameters when reading from the commandline.

Handles instances of ProgParameter for every expected programm parameter and sets them by reading an argc/argv pair.

Definition at line 96 of file progparameter.hpp.

---

Constructor & Destructor Documentation

isis::util::ParameterMap::ParameterMap

(

)

Definition at line 96 of file progparameter.cpp.

---

Member Function Documentation

bool isis::util::ParameterMap::isComplete

(

)

const

Returns:

true, if ALL needed parameter were correctly parsed, false otherwise

Definition at line 163 of file progparameter.cpp.

ProgParameter & isis::util::ParameterMap::operator[]

(

const std::string

key

)

Definition at line 180 of file progparameter.cpp.

const ProgParameter isis::util::ParameterMap::operator[]

(

const std::string

key

)

const

Definition at line 169 of file progparameter.cpp.

bool isis::util::ParameterMap::parse	(	int	argc,
		char **	argv
	)

Reads and tokenizes argv, detecs the parameter names (names are preceded by a "-") and sends the values (everything between one parameter name and the other) to the corresponding ProgParameter-objects to be parsed.

Parameters:

argc	the names of the program parameters
argv	the values of the program parameters

Returns:

true if succesfully converted all parameters to correct internal types, false otherwise

Definition at line 98 of file progparameter.cpp.

---

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

• /scr/tee1/isis/lib/Core/CoreUtils/progparameter.hpp
• /scr/tee1/isis/lib/Core/CoreUtils/progparameter.cpp