クラス rcsc::ParamEntity

abstract parameter [詳細]

#include <param_map.h>

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

rcsc::ParamGeneric< ValueType > rcsc::ParamGeneric< bool > rcsc::ParamSwitch すべてのメンバ一覧

Public メソッド

virtual ~ParamEntity ()
 destructor as virtual method
const std::string & longName () const
 get long name of parameter
const std::string & shortName () const
 get long name of parameter
const std::string & description () const
 get description message
virtual bool isString () const
 (virtual) check if this parameter is string type or not.
virtual bool isSwitch () const
 (virtual) check if this parameter is switch type or not.
virtual bool analyze (const std::string &value_str)=0
 pure virtual method. analyze value string.
virtual std::ostream & printValue (std::ostream &os) const=0
 pure virtual method. print value to stream

Protected メソッド

 ParamEntity (const std::string &long_name, const std::string &short_name, const char *description="")
 construct with all arguments

説明

abstract parameter


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

rcsc::ParamEntity::ParamEntity ( const std::string &  long_name,
const std::string &  short_name,
const char *  description = "" 
) [inline, protected]

construct with all arguments

引数:
long_name long parameter name
short_name short parameter name
description description message about this parameter


関数

const std::string& rcsc::ParamEntity::longName (  )  const [inline]

get long name of parameter

戻り値:
const reference to the name string

const std::string& rcsc::ParamEntity::shortName (  )  const [inline]

get long name of parameter

戻り値:
const reference to the short string

const std::string& rcsc::ParamEntity::description (  )  const [inline]

get description message

戻り値:
const reference to the descriptin message

virtual bool rcsc::ParamEntity::isString (  )  const [inline, virtual]

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

戻り値:
true if this parameter is string type..

rcsc::ParamGeneric< ValueType >で再定義されています。

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

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

戻り値:
true if this parameter is switch type..

rcsc::ParamSwitchで再定義されています。

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

pure virtual method. analyze value string.

戻り値:
boolean status of analysis result

rcsc::ParamGeneric< ValueType >rcsc::ParamGeneric< bool >rcsc::ParamSwitchで実装されています。

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

pure virtual method. print value to stream

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

rcsc::ParamGeneric< ValueType >rcsc::ParamGeneric< bool >rcsc::ParamSwitchで実装されています。


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