IT++ 4.3.1
|
Argument Parser Class. More...
#include <itpp/base/parser.h>
Public Member Functions | |
Parser () | |
Default Constructor. | |
Parser (const std::string &filename) | |
Constructor. Sets input file name. | |
Parser (int argc, char *argv[]) | |
Constructor. Uses argc and argv (command line arguments) | |
Parser (const std::string &filename, int argc, char *argv[]) | |
Constructor. Sets input file name and uses argc and argv (command line arguments) | |
Parser (const Array< std::string > &setup) | |
Constructor. Sets and Array of strings. | |
void | init (const std::string &filename) |
Initialization function. Sets input file name. | |
void | init (int argc, char *argv[]) |
Initialization function. Uses argc and argv (command line arguments) | |
void | init (const std::string &filename, int argc, char *argv[]) |
Initialization function. Sets input file name and uses argc and argv (command line arguments) | |
void | init (const Array< std::string > &setup) |
Initialization function. Sets and Array of strings. | |
void | set_silentmode (bool v=true) |
Sets silent mode if true, or verbose mode if false. | |
bool | exist (const std::string &name) |
Check is name exists in the file. Returns true if the name is found and false otherwise. | |
template<class T> | |
bool | get (T &var, const std::string &name, int num=-1) |
Get variable value if name can be found (and return true), otherwise keep old value (and return false) | |
bool | get_bool (const std::string &name, int num=-1) |
Interpret variable name as a bool. | |
int | get_int (const std::string &name, int num=-1) |
Interpret variable name as an integer. | |
double | get_double (const std::string &name, int num=-1) |
Interpret variable name as a double. | |
std::string | get_string (const std::string &name, int num=-1) |
Interpret variable name as a string. | |
vec | get_vec (const std::string &name, int num=-1) |
Interpret variable name as a vec. | |
ivec | get_ivec (const std::string &name, int num=-1) |
Interpret variable name as a ivec. | |
svec | get_svec (const std::string &name, int num=-1) |
Interpret variable name as a svec. | |
bvec | get_bvec (const std::string &name, int num=-1) |
Interpret variable name as a bvec. | |
mat | get_mat (const std::string &name, int num=-1) |
Interpret variable name as a mat. | |
imat | get_imat (const std::string &name, int num=-1) |
Interpret variable name as a imat. | |
smat | get_smat (const std::string &name, int num=-1) |
Interpret variable name as a smat. | |
bmat | get_bmat (const std::string &name, int num=-1) |
Interpret variable name as a bmat. | |
template<> | |
bool | get (std::string &var, const std::string &name, int num) |
template<> | |
bool | get (int &var, const std::string &name, int num) |
template<> | |
bool | get (bool &var, const std::string &name, int num) |
template<> | |
ITPP_EXPORT bool | get (std::string &var, const std::string &name, int num) |
Specialization or get() for std::string. | |
template<> | |
ITPP_EXPORT bool | get (int &var, const std::string &name, int num) |
Specialization of get() for int. | |
template<> | |
ITPP_EXPORT bool | get (bool &var, const std::string &name, int num) |
Specialization of get() for bool. | |
Argument Parser Class.
This class parses strings to variables. The syntax is compatible with Matlab and Octave. It can be used in several different ways. See the Detailed Description in the Argument Parser module.
itpp::Parser::Parser | ( | ) |
Default Constructor.
Definition at line 42 of file parser.cpp.
itpp::Parser::Parser | ( | const std::string & | filename | ) |
itpp::Parser::Parser | ( | int | argc, |
char * | argv[] ) |
Constructor. Uses argc and argv (command line arguments)
Definition at line 53 of file parser.cpp.
References init().
itpp::Parser::Parser | ( | const std::string & | filename, |
int | argc, | ||
char * | argv[] ) |
Constructor. Sets input file name and uses argc and argv (command line arguments)
Definition at line 59 of file parser.cpp.
References init().
itpp::Parser::Parser | ( | const Array< std::string > & | setup | ) |
Constructor. Sets and Array of strings.
Definition at line 65 of file parser.cpp.
References init().
void itpp::Parser::init | ( | const std::string & | filename | ) |
void itpp::Parser::init | ( | int | argc, |
char * | argv[] ) |
Initialization function. Uses argc and argv (command line arguments)
Definition at line 289 of file parser.cpp.
void itpp::Parser::init | ( | const std::string & | filename, |
int | argc, | ||
char * | argv[] ) |
Initialization function. Sets input file name and uses argc and argv (command line arguments)
Definition at line 300 of file parser.cpp.
References it_assert.
void itpp::Parser::init | ( | const Array< std::string > & | setup | ) |
Initialization function. Sets and Array of strings.
Definition at line 324 of file parser.cpp.
void itpp::Parser::set_silentmode | ( | bool | v = true | ) |
Sets silent mode if true, or verbose mode if false.
Definition at line 330 of file parser.cpp.
bool itpp::Parser::exist | ( | const std::string & | name | ) |
Check is name exists in the file. Returns true
if the name is found and false
otherwise.
Definition at line 335 of file parser.cpp.
bool itpp::Parser::get | ( | T & | var, |
const std::string & | name, | ||
int | num = -1 ) |
bool itpp::Parser::get_bool | ( | const std::string & | name, |
int | num = -1 ) |
Interpret variable name as a bool.
Definition at line 425 of file parser.cpp.
int itpp::Parser::get_int | ( | const std::string & | name, |
int | num = -1 ) |
Interpret variable name as an integer.
Definition at line 445 of file parser.cpp.
References it_assert.
double itpp::Parser::get_double | ( | const std::string & | name, |
int | num = -1 ) |
Interpret variable name as a double.
Definition at line 459 of file parser.cpp.
References it_error.
std::string itpp::Parser::get_string | ( | const std::string & | name, |
int | num = -1 ) |
Interpret variable name as a string.
Definition at line 470 of file parser.cpp.
References it_error.
vec itpp::Parser::get_vec | ( | const std::string & | name, |
int | num = -1 ) |
ivec itpp::Parser::get_ivec | ( | const std::string & | name, |
int | num = -1 ) |
svec itpp::Parser::get_svec | ( | const std::string & | name, |
int | num = -1 ) |
bvec itpp::Parser::get_bvec | ( | const std::string & | name, |
int | num = -1 ) |
mat itpp::Parser::get_mat | ( | const std::string & | name, |
int | num = -1 ) |
imat itpp::Parser::get_imat | ( | const std::string & | name, |
int | num = -1 ) |
smat itpp::Parser::get_smat | ( | const std::string & | name, |
int | num = -1 ) |
bmat itpp::Parser::get_bmat | ( | const std::string & | name, |
int | num = -1 ) |
bool itpp::Parser::get | ( | std::string & | var, |
const std::string & | name, | ||
int | num ) |
Definition at line 348 of file parser.cpp.
bool itpp::Parser::get | ( | int & | var, |
const std::string & | name, | ||
int | num ) |
Definition at line 370 of file parser.cpp.
bool itpp::Parser::get | ( | bool & | var, |
const std::string & | name, | ||
int | num ) |
Definition at line 395 of file parser.cpp.