SFRTracer

トレーサ管理用の内部クラスです。

#include <SFRTracer.hpp>

class SFRTracer : public SFCInvoker;

typedef SFRTracer&          SFRTracerRef;
typedef SFRTracer*          SFRTracerPtr;
typedef SFRTracer**         SFRTracerHandle;
typedef const SFRTracer     ConstSFRTracer;
typedef const SFRTracer&    ConstSFRTracerRef;
typedef const SFRTracer*    ConstSFRTracerPtr;
typedef const SFRTracer**   ConstSFRTracerHandle;

継承図

解説

このクラスは SophiaFramework の内部で使用されます。開発者は使用しないでください。

メンバ

コンストラクタ/デストラクタ
protected	SFRTracer	SFRTracer クラスのコンストラクタです。
protected	~SFRTracer	SFRTracer クラスのデストラクタです。

パブリック関数
public	Invoke (SFCInvoker から継承)	イベントを送信します。
public	RegisterTracer	トレーサを登録します。
public	UnregisterTracer	登録されているトレーサを削除します。

型
	TracerEnum	トレース順序を表します。

SFRTracer::SFRTracer

SFRTracer クラスのコンストラクタです。

[ protected ]
SFRTracer(Void);

SFRTracer::~SFRTracer

SFRTracer クラスのデストラクタです。

[ protected, virtual ]
~SFRTracer(Void);

SFRTracer::RegisterTracer

トレーサを登録します。

[ public ]
SFCError RegisterTracer(
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum type      // イベントタイプ
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum type      // イベントタイプ
    UInt16 p16             // 第一パラメータ
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum type      // イベントタイプ
    UInt16 bgnP16          // 第一パラメータの開始番号
    UInt16 endP16          // 第一パラメータの終了番号
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum bgnType   // イベントタイプ開始番号
    SFCEventEnum endType   // イベントタイプ終了番号
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum bgnType   // イベントタイプ開始番号
    SFCEventEnum endType   // イベントタイプ終了番号
    UInt16 p16             // 第一パラメータ
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum bgnType   // イベントタイプ開始番号
    SFCEventEnum endType   // イベントタイプ終了番号
    UInt16 bgnP16          // 第一パラメータ開始番号
    UInt16 endP16          // 第一パラメータ終了番号
    BehaviorType compare   // ステータス比較用フラグ
    TracerEnum trace       // トレース順序
);

引数

compare: レスポンダのステータスのうちどのフラグを比較対象に設定するかを指定します。 BEHAVIOR_NONE を指定するとすべてのステータスフラグは比較対象に含まれません。つまりステータスに関係なく通知されることになります。また、TRACER_PROVIDE を指定すると強制通知となります。
trace: TRACER_NONE, TRACER_FORWARD, TRACER_BACKWARD, TRACER_FOCUS を指定できます。これらの定数については SFRTracer::TracerEnum を参照してください。

戻り値

成功した場合 NO_ERROR が、それ以外の場合はエラー番号が返ります。

参照

SFRTracer::UnregisterTracer

SFRTracer::UnregisterTracer

登録されているトレーサを削除します。

[ public ]
Void UnregisterTracer(
    SFCEventEnum type   // イベントタイプ
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum type   // イベントタイプ
    UInt16 p16          // 第一パラメータ
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum type   // イベントタイプ
    UInt16 bgnP16       // 第一パラメータの開始番号
    UInt16 endP16       // 第一パラメータの終了番号
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum bgnType   // イベントタイプの開始番号
    SFCEventEnum endType   // イベントタイプの終了番号
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum bgnType   // イベントタイプの開始番号
    SFCEventEnum endType   // イベントタイプの終了番号
    UInt16 p16             // 第一パラメータ
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum bgnType   // イベントタイプの開始番号
    SFCEventEnum endType   // イベントタイプの終了番号
    UInt16 bgnP16          // 第一パラメータの開始番号
    UInt16 endP16          // 第一パラメータの終了番号
);

参照

SFRTracer::RegisterTracer

SFRTracer::TracerEnum

トレース順序を表します。

enum TracerEnum;

解説

イベントのトレース順序を表す定数です。以下に一覧を示します。

TRACER_FORWARD	前面から背面の順序で通知
TRACER_BACKWARD	背面から前面の順序で通知
TRACER_FOCUS	フォーカスの当たっているものに通知
TRACER_NONE	通知しない

参照

SFRTracer::RegisterTracer