クラス rcsc::ParamMap

parameter container [詳細]

#include <param_map.h>

すべてのメンバ一覧

Public メソッド

 ParamMap ()
 default constructor. create registrer
 ParamMap (const std::string &option_name)
 construct with option name string
 ~ParamMap ()
 destructor. nothing to do
const std::string & optionName () const
 get the name of parameter space
const std::vector< ParamPtr > & parameters () const
 get the container of all parameters
const std::map< std::string,
ParamPtr > & 
longNameMap () const
 get the long name parameter map
const std::map< std::string,
ParamPtr > & 
shortNameMap () const
 get the short name parameter map
ParamMapadd (ParamMap &param_map)
 copy parameter map from argument
Registrar & add ()
 get a parameter registrar
Registrar & add (ParamPtr param)
 add new parameter entry
void remove (const std::string &long_name)
 remove registered parameter pointer
ParamPtr findLongName (const std::string &long_name)
 get parameter entry that has the argument name
ParamPtr findShortName (const std::string &short_name)
 get parameter entry that has the argument name
std::ostream & printHelp (std::ostream &os, const bool with_default=true) const
 output parameter usage by command line option style
std::ostream & printValues (std::ostream &os) const
 output parameter name and value

構成

class  Registrar
 convinience class to simplify parameter registration


説明

parameter container


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

rcsc::ParamMap::ParamMap ( const std::string &  option_name  )  [inline, explicit]

construct with option name string

引数:
option_name option name string


関数

const std::string& rcsc::ParamMap::optionName (  )  const [inline]

get the name of parameter space

戻り値:
name string

const std::vector< ParamPtr >& rcsc::ParamMap::parameters (  )  const [inline]

get the container of all parameters

戻り値:
const reference to the container instance

const std::map< std::string, ParamPtr >& rcsc::ParamMap::longNameMap (  )  const [inline]

get the long name parameter map

戻り値:
const reference to the container instance

const std::map< std::string, ParamPtr >& rcsc::ParamMap::shortNameMap (  )  const [inline]

get the short name parameter map

戻り値:
const reference to the container instance

ParamMap & rcsc::ParamMap::add ( ParamMap param_map  ) 

copy parameter map from argument

引数:
param_map reference to the parameter map

Registrar& rcsc::ParamMap::add (  )  [inline]

get a parameter registrar

戻り値:
reference to the parameger registrar

ParamMap::Registrar & rcsc::ParamMap::add ( ParamPtr  param  ) 

add new parameter entry

引数:
param shared pointer of parameter entry

void rcsc::ParamMap::remove ( const std::string &  long_name  ) 

remove registered parameter pointer

引数:
long_name parameter name string

ParamPtr rcsc::ParamMap::findLongName ( const std::string &  long_name  ) 

get parameter entry that has the argument name

引数:
long_name long version parameter name string
戻り値:
parameter entry pointer. if not found, NULL is returned.

ParamPtr rcsc::ParamMap::findShortName ( const std::string &  short_name  ) 

get parameter entry that has the argument name

引数:
short_name set of the parameter name character
戻り値:
parameter entry pointer. if not found, NULL is returned.

std::ostream & rcsc::ParamMap::printHelp ( std::ostream &  os,
const bool  with_default = true 
) const

output parameter usage by command line option style

引数:
os reference to output streamf
with_default if true, default value is printed.
戻り値:
reference to output stream

std::ostream & rcsc::ParamMap::printValues ( std::ostream &  os  )  const

output parameter name and value

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


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