クラス rcsc::CmdLineParser

command line parser [詳細]

#include <cmd_line_parser.h>

rcsc::CmdLineParserに対する継承グラフ

rcsc::ParamParser すべてのメンバ一覧

Public メソッド

 CmdLineParser (const int argc, const char *const *argv, const std::string &name_space="")
 construct with original command line arguments
 CmdLineParser (const std::list< std::string > &args, const std::string &name_space="")
 construct with original command line arguments
bool parse (ParamMap &param_map)
 analyze arguments and results are stored to parameter map
const std::list< std::string > & args () const
 get the stored arguments
bool failed () const
 check if all arguments are successfully parsed.
const std::vector< std::string > & positionalOptions () const
 get the positional arguments
std::ostream & print (std::ostream &os) const
 put the stored arguments to the output stream

説明

command line parser


コンストラクタとデストラクタ

rcsc::CmdLineParser::CmdLineParser ( const int  argc,
const char *const *  argv,
const std::string &  name_space = "" 
)

construct with original command line arguments

引数:
argc number of argument
argv const double array of char
name_space namespace string

rcsc::CmdLineParser::CmdLineParser ( const std::list< std::string > &  args,
const std::string &  name_space = "" 
)

construct with original command line arguments

引数:
args argument string container
name_space namespace string


関数

bool rcsc::CmdLineParser::parse ( ParamMap param_map  )  [virtual]

analyze arguments and results are stored to parameter map

引数:
param_map reference to the parameter container
戻り値:
true if successfully parserd

rcsc::ParamParserを実装しています。

const std::list< std::string >& rcsc::CmdLineParser::args (  )  const [inline]

get the stored arguments

戻り値:
const reference to the container

bool rcsc::CmdLineParser::failed (  )  const [inline]

check if all arguments are successfully parsed.

戻り値:
status of parsing result.

const std::vector< std::string >& rcsc::CmdLineParser::positionalOptions (  )  const [inline]

get the positional arguments

戻り値:
const reference to the container of positional argument string

std::ostream & rcsc::CmdLineParser::print ( std::ostream &  os  )  const

put the stored arguments to the output stream

引数:
os reference to the output stream
戻り値:
reference to the output stream


このクラスの説明は次のファイルから生成されました:
librcscに対してThu May 1 15:41:26 2008に生成されました。  doxygen 1.5.0