メインページ   名前空間一覧   クラス階層   アルファベット順一覧   構成   ファイル一覧   名前空間メンバ   構成メンバ   ファイルメンバ  

クラス KSCL::CReceiveString の解説

文字列を受け取るためだけのクラスです。. より詳しく...

すべてのメンバ一覧

公開メンバ

 CReceiveString (const int p_iSize)
 ・コンストラクタ。. より詳しく...

 ~CReceiveString ()
 ・デストラクタ。. より詳しく...

void ReSize (const int p_iSize)
 ・中に持っている文字配列のサイズを変更して再確保します。. より詳しく...

int GetSize () const
 ・現在の文字配列のサイズを返します。. より詳しく...

bool Copy (const std::string &p_rcSourceStr)
 ・文字列をコピーします。. より詳しく...

char * GetReceivePointer ()
 ・文字配列への非 const ポインタを返します。. より詳しく...

const char * GetPointer () const
 ・文字配列への const ポインタを返します。. より詳しく...

bool IsRemained (const char *p_pchData) const
 ・外に出した文字列ポインタをまだ持っているか調べます。. より詳しく...


非公開属性

int m_iSize
 文字配列のサイズ。実際にはこの +1 確保されます。. より詳しく...

char * m_pchData
 文字配列を指すポインタ。このポインタに new [] / delete [] します。. より詳しく...


解説

文字列を受け取るためだけのクラスです。.

 指定したサイズの文字配列を作成してそこに文字列を受け取ります。
 std::string がそういった用途に向いてないためです。


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

KSCL::CReceiveString::CReceiveString const int    p_iSize
 

・コンストラクタ。.

 文字配列を確保します。

引数:
p_iSize  確保するサイズ。実際には +1 分のサイズを確保します。

KSCL::CReceiveString::~CReceiveString  
 

・デストラクタ。.

 文字配列を解放します。


メンバ関数の解説

void KSCL::CReceiveString::ReSize const int    p_iSize
 

・中に持っている文字配列のサイズを変更して再確保します。.

 中に持っている文字配列のサイズを変更します。
 すでに持っている文字列は破棄されるので、この関数を呼び出す前に取っておいてください。

引数:
p_iSize  新しいサイズ。例によって +1 分のサイズを確保します。

int KSCL::CReceiveString::GetSize   const
 

・現在の文字配列のサイズを返します。.

 コンストラクタ及び ReSize() で渡したサイズをそのまま返します。
 つまり、持っている文字配列のサイズの -1 を返します。

戻り値:
文字配列のサイズ。実際のサイズの -1 。

bool KSCL::CReceiveString::Copy const std::string &    p_rcSourceStr
 

・文字列をコピーします。.

 外にある文字列を中にコピーします。
 関数の中には in と out の両用として使うものがあったりするので……。
 コピー時にリサイズは行いません。サイズに余裕があっても詰めたりはしませんし、足りなかったら false を返します。

戻り値:
true  コピーしました。
false  コピーに失敗しました。サイズが足りません。
引数:
p_rcSourceStr  コピー元文字列。

char * KSCL::CReceiveString::GetReceivePointer  
 

・文字配列への非 const ポインタを返します。.

 文字列を受け取るためのポインタを返します。
 このクラスはこのポインタを使うためだけに存在します。

戻り値:
文字配列への非 const なポインタ。このポインタで文字列を受け取ってください。

const char * KSCL::CReceiveString::GetPointer   const
 

・文字配列への const ポインタを返します。.

 リードオンリーな文字列を返します。
 GetReceivePointer() で受け取ったら、この GetPointer() で取りだして std::string なりに入れておいてください。

戻り値:
文字配列への const ポインタ。

bool KSCL::CReceiveString::IsRemained const char *    p_pchData const
 

・外に出した文字列ポインタをまだ持っているか調べます。.

 GetReceivePointer() や GetPointer() で取りだしたポインタは、 ReSize() で使えなくなってしまいます。
 それがまだ使える状態かどうか、今持っているポインタと比較して調べます。

戻り値:
true  まだ持っているので使えます。
false  もう持っていないので使えません。
引数:
p_pchData  持ってるかどうか確認するポインタ。


メンバの解説

int KSCL::CReceiveString::m_iSize [private]
 

文字配列のサイズ。実際にはこの +1 確保されます。.

char* KSCL::CReceiveString::m_pchData [private]
 

文字配列を指すポインタ。このポインタに new [] / delete [] します。.


KSCL(KAB-studioClassLibrary)に対してThu Jun 12 09:55:41 2003に生成されました。 doxygen1.2.15