クラス KSCL::COneParameterInfoBase の解説

KSCL::COneParameterInfoBaseのコラボレーション図

解説

　パラメーターの位置情報等を持っているクラスです。
　コマンドラインが

C:\\test.exe -log A.txt B.txt Last.txt

　の場合に、 -log A.txt B.txt がひとかたまりのスイッチだとすると、
C:\\test.exe : 0 , E_EXSIST_MUST
-log : E_POS_REGARDLESS , E_EXSIST_REGARDLESS
A.txt : 0 , E_EXSIST_MUST
B.txt : 1 , E_EXSIST_MUST
Last.txt : E_POS_LAST , E_EXSIST_MUST
　って感じになります。

メンバ列挙型の解説

enum KSCL::COneParameterInfoBase::E_PARAMETER_EXPECT_POS

パラメーターとしての位置。. 列挙型値: E_POS_FIRST  　一番最初です。 E_POS_LAST  　一番最後です。 E_POS_REGARDLESS  　位置は問いません。

enum KSCL::COneParameterInfoBase::E_PARAMETER_EXPECT_EXSIST

パラメーターの存在有無. 列挙型値: E_EXSIST_MUST  　必ず存在する必要あり。 E_EXSIST_REGARDLESS  　存在してもいなくても構いません。

enum KSCL::COneParameterInfoBase::E_ERROR_CODE

エラーコード。. 列挙型値: E_NOT_EXSIST  　そのパラメーターはコマンドライン上に存在しません。

コンストラクタとデストラクタの解説

KSCL::COneParameterInfoBase::COneParameterInfoBase (  const int    p_iExpectIndexPos, const E_PARAMETER_EXPECT_EXSIST    p_iExpectExsist, const COneParameterInfoBase *const    p_pcParentOneParameterBase = 0 )

・コンストラクタ。. 　メンバ変数を初期化します。 引数: p_iExpectIndexPos  あるべき位置。整数値または E_PARAMETER_EXPECT_POS 。 p_iExpectExsist  存在すべきかどうか。 E_PARAMETER_EXPECT_EXSIST 。 p_pcParentOneParameterBase  親パラメーター。存在しなければ 0 。

KSCL::COneParameterInfoBase::~COneParameterInfoBase (    )  [virtual]

デストラクタ。. 　特に何もしません。

メンバ関数の解説

int KSCL::COneParameterInfoBase::GetExpectIndexPos (    )  const

・希望する位置を返します。. 　パラメーターとして「存在すべき位置」を返します。スイッチ内の場合にはスイッチ内での位置を返します。 戻り値: 存在すべき位置（ 0 ベース）。整数値か E_PARAMETER_EXPECT_POS 。

COneParameterInfoBase::E_PARAMETER_EXPECT_EXSIST KSCL::COneParameterInfoBase::GetExpectExsist (    )  const

・存在すべきかどうかを返します。. 　パラメーターが存在すべきか（つまり省略可能か）どうかを返します。 戻り値: E_PARAMETER_EXPECT_EXSIST の値。 戻り値: E_EXSIST_MUST  省略できません。 E_EXSIST_REGARDLESS  あってもなくてもいいです。省略も可能。

const COneParameterInfoBase * KSCL::COneParameterInfoBase::GetParentOneParameterBase (    )  const

・親パラメーターを返します。. 　親のパラメーターへのポインタを返します。親パラメーターは通常スイッチです。 戻り値: 親パラメーターへのポインタ。親パラメーターがない場合は NULL です。

std::string KSCL::COneParameterInfoBase::GetDataString (    )  const

・このパラメーターが持つ文字列を返します。. 戻り値: このパラメーターが持つ文字列。該当しなければ空文字列が返ります。

void KSCL::COneParameterInfoBase::SetDataString (  const std::string &    p_rcNewDataStr )

・このパラメーターが持つ文字列をセットします。. 引数: p_rcNewDataStr  新しくセットする、このパラメーターの文字列。

int KSCL::COneParameterInfoBase::GetIndexPos (    )  const

このパラメーターの実際の位置を返します。. 戻り値: このパラメーターの実際の位置。

void KSCL::COneParameterInfoBase::SetIndexPos (  const int    p_iNewIndexPos )

このパラメーターの実際の位置をセットします。. 引数: p_iNewIndexPos  新しくセットする、このパラメーターの位置。

メンバの解説

const int KSCL::COneParameterInfoBase::m_iExpectIndexPos [private]

あるべきパラメーターとしての位置。.

const E_PARAMETER_EXPECT_EXSIST KSCL::COneParameterInfoBase::m_iExpectExsist [private]

パラメーターが存在すべきかどうか。.

const COneParameterInfoBase* const KSCL::COneParameterInfoBase::m_pcParentOneParameterBase [private]

自分の親パラメーター。.

std::string KSCL::COneParameterInfoBase::m_cDataString [private]

このパラメーターが実際に持つデータ。.

int KSCL::COneParameterInfoBase::m_iIndexPos [private]

このパラメーターの実際の位置。.

KSCL(KAB-studioClassLibrary)に対してThu Jun 12 09:54:48 2003に生成されました。 1.2.15