クラス rcsc::ParamSwitch

switch type parameter [詳細]

#include <param_map.h>

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

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

Public メソッド

 ParamSwitch (const std::string &long_name, const std::string &short_name, bool *value_ptr, const char *description="")
 constructor
virtual bool isSwitch () const
 (virtual) check if this parameter is switch type or not.
bool analyze (const std::string &value_str)
 analyze value string and substitute it to variable.
std::ostream & printValue (std::ostream &os) const
 print value to stream

説明

switch type parameter


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

rcsc::ParamSwitch::ParamSwitch ( const std::string &  long_name,
const std::string &  short_name,
bool *  value_ptr,
const char *  description = "" 
) [inline]

constructor

引数:
long_name parameter's long name string
short_name parameter's short name string(ommitable)
value_ptr pointer to variable instance
description description message(ommitable)


関数

virtual bool rcsc::ParamSwitch::isSwitch (  )  const [inline, virtual]

(virtual) check if this parameter is switch type or not.

戻り値:
always true.

rcsc::ParamEntityを再定義しています。

bool rcsc::ParamSwitch::analyze ( const std::string &  value_str  )  [virtual]

analyze value string and substitute it to variable.

引数:
value_str string that contains value
戻り値:
boolean status of analysis result

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

std::ostream & rcsc::ParamSwitch::printValue ( std::ostream &  os  )  const [virtual]

print value to stream

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

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


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