SFRTracer

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

#include <SFRTracer.hpp>

class SFRTracer : public SFCInvoker;

SFMTYPEDEFCLASS(SFRTracer)

継承図

協調図

解説

このクラスは SophiaFramework UNIVERSE の内部で使います。

参照

トレーサ

メンバ

コンストラクタ/デストラクタ
SFRTracer( `Void` ) SFRTracer クラスのコンストラクタです。
~SFRTracer( `Void` ) SFRTracer クラスのデストラクタです。

パブリック関数
`SFCError`	RegisterTracer( `BehaviorType` behavior , `TracerEnum` trace ) RegisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` bgnP16 , `UInt16` endP16 , `BehaviorType` behavior , `TracerEnum` trace ) RegisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` p16 , `BehaviorType` behavior , `TracerEnum` trace ) RegisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `BehaviorType` behavior , `TracerEnum` trace ) RegisterTracer( `SFCEventEnum` type , `UInt16` bgnP16 , `UInt16` endP16 , `BehaviorType` behavior , `TracerEnum` trace ) RegisterTracer( `SFCEventEnum` type , `UInt16` p16 , `BehaviorType` behavior , `TracerEnum` trace ) RegisterTracer( `SFCEventEnum` type , `BehaviorType` behavior , `TracerEnum` trace ) トレーサを登録します。
`Void`	UnregisterTracer( `Void` ) UnregisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` bgnP16 , `UInt16` endP16 ) UnregisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` p16 ) UnregisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType ) UnregisterTracer( `SFCEventEnum` type , `UInt16` bgnP16 , `UInt16` endP16 ) UnregisterTracer( `SFCEventEnum` type , `UInt16` p16 ) UnregisterTracer( `SFCEventEnum` type ) 登録されているトレーサを削除します。
`Bool`	Invoke( `SFXEventConstRef` event ) (SFCInvoker から継承) イベントを送信します。

プロテクト関数
`TracerRecConstPtr`	SearchTracer( `SFXEventConstRef` event ) 指定したイベントに一致するトレーサを検索します。

型
TracerEnum トレース順序を表します。
TracerTraceMPP コールバック関数の型です。

SFRTracer::SFRTracer

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

[ protected ]
SFRTracer(Void);

SFRTracer::~SFRTracer

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

[ protected, virtual ]
~SFRTracer(Void);

SFRTracer::RegisterTracer

トレーサを登録します。

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

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

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

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

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

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

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

引数

behavior

レスポンダのステータスのうちどのフラグを比較対象に設定するかを指定します。

BEHAVIOR_NONE を指定するとすべてのステータスフラグは比較対象に含まれません。

ステータスに関係なく通知されることになります。また、TRACER_PROVIDE を指定すると強制通知となります。

trace

TRACER_NONE, TRACER_FORWARD, TRACER_BACKWARD, TRACER_FOCUS を指定できます。

定数の参照情報 : SFRTracer::TracerEnum

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY

参照

SFRTracer::UnregisterTracer

SFRTracer::SearchTracer

指定したイベントに一致するトレーサを検索します。

[ protected, const ]
TracerRecConstPtr SearchTracer(
    SFXEventConstRef event   // 検索するイベント
);

SFRTracer::UnregisterTracer

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

[ public ]
Void UnregisterTracer(Void);

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

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

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

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

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

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

参照

SFRTracer::RegisterTracer

SFRTracer::TracerEnum

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

enum TracerEnum{
    TRACER_NONE       = 0,
    TRACER_FORWARD,
    TRACER_BACKWARD,
    TRACER_FOCUS
};

解説

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

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

参照

SFRTracer::RegisterTracer

SFRTracer::TracerRec

トレーサを表す構造体です。

SFMTYPEDEFSTRUCT(TracerRec)
        friend  struct  TracerRec;
        struct TracerRec {
            SFCEventEnum                btype;
            SFCEventEnum                etype;
            UInt16                      bp16;
            UInt16                      ep16;
            BehaviorType                behavior;
            TracerTraceMPP              mpp;
            TracerRecPtr                next;
        };

SFRTracer::TracerTraceMPP

コールバック関数の型です。

typedef Bool(SFRTracer::* SFRTracer::TracerTraceMPP)(SFXEventConstRef event, TracerRecConstPtr tracer)