クラス ICmd_Base

命令クラスのインターフェースです。 [詳細]

#include <Command.h>

すべてのメンバ一覧

Public メソッド
virtual void	Initialize ()
	初期化を行います。
virtual void	Suicide ()=0
	自クラスの解体を行います。
virtual void	Run ()=0
	命令を実行します。
virtual void	SetParent (INovelEngine *Parent)
	親エンジンを設定します。
virtual void	SetParam (const CmdParam &Parameter)
	パラメータを設定します。
virtual int	GetID () const =0
	クラスＩＤを取得します。
virtual void	Print (const ITextStream *Output) const =0
	命令の内容をテキスト出力します。
virtual void	Save (IIOStream *IOStream)
	命令の内容をスクリプトファイルに書き込みます。
virtual void	Load (IIOStream *IOStream)
	命令の内容をスクリプトファイルから読み込みます。
Protected 変数
INovelEngine *	Outer
	命令の親となるノベルエンジンクラスへのポインタです。

---

説明

命令クラスのインターフェースです。

本クラスのデストラクタは呼び出されません。 よって、デストラクタで記述するべき内容はSuicideメソッド内に記述してください。

---

関数

virtual void Initialize

(

)

[inline, virtual]

初期化を行います。

初期化を行うように実装してください。
ただし、命令のパラメータは初期化しないでください。
（本クラス内の状態変数などのみを初期化してください）

virtual void Suicide

(

)

[pure virtual]

自クラスの解体を行います。

自クラスの解体を行うように実装してください。
基本的にdelete(this);で実装は問題ありません。
デストラクタを兼ねてますので、デストラクタに記述するべき内容は本メソッド内に記述してください。

virtual void Run

(

)

[pure virtual]

命令を実行します。

命令を実行するように実装してください。

virtual void SetParent

(

INovelEngine *

Parent

)

[inline, virtual]

親エンジンを設定します。

本クラスの親となるノベルエンジンクラスを設定します。
オーバーライドする必要はありません。

引数:

Parent

[in]本クラスの親となるノベルエンジンクラスを指定します。

virtual void SetParam

(

const CmdParam &

Parameter

)

[inline, virtual]

パラメータを設定します。

パラメータを設定するように実装してください。

引数:

Parameter

[in]パラメータを指定します。

virtual int GetID

(

)

const [pure virtual]

クラスＩＤを取得します。

クラスＩＤを取得するように実装してください。
命令を新規作成した際に用意した0以上の一意な値を返せばＯＫです。

戻り値:

本クラスのクラスＩＤを返します。
クラスの種類毎に0以上の一意な値を返してください。
命令を新規作成した際に用意した0以上の一意な値を返せばＯＫです。

virtual void Print

(

const ITextStream *

Output

)

const [pure virtual]

命令の内容をテキスト出力します。

命令の内容をテキスト出力するように実装してください。

引数:

Output

[in]テキスト出力ストリームを指定します。

virtual void Save

(

IIOStream *

IOStream

)

[inline, virtual]

命令の内容をスクリプトファイルに書き込みます。

命令の内容をスクリプトファイルに書き込むように実装してください。

引数:

IOStream

[in]データ入出力クラスを指定します。

virtual void Load

(

IIOStream *

IOStream

)

[inline, virtual]

命令の内容をスクリプトファイルから読み込みます。

命令の内容をスクリプトファイルから読み込むように実装してください。

引数:

IOStream

[in]データ入出力クラスを指定します。

---

変数

INovelEngine* Outer [protected]

命令の親となるノベルエンジンクラスへのポインタです。

本メンバ変数を介して様々な操作を行うことが可能です。

---

このクラスの説明は次のファイルから生成されました:

• AbyssLibSrc/AbyssLib/AbyssLib/Command/Command.h