SFXResponderPointer

レスポンダ用のスマートポインタテンプレートです。

#include <SFXResponderPointer.h.hpp>

class SFXResponderPointer;

SFMTYPEDEFCLASS(SFXResponderPointer)

継承図

協調図

解説

SFXResponderPointer クラスはレスポンダクラスに対して、参照カウントを自動管理する機能を提供します。

参照

レスポンダクラス

メンバ

コンストラクタ/デストラクタ
SFXResponderPointer( `Void` ) SFXResponderPointer クラスのコンストラクタです。
SFXResponderPointer( `SFXResponderPointer< M > const &` param ) SFXResponderPointer クラスのコンストラクタです。
SFXResponderPointer( `SFXResponderPointer< T > const &` param ) SFXResponderPointer クラスのコンストラクタです。
SFXResponderPointer( `T *` pointer , `Bool` increment = true ) SFXResponderPointer クラスのコンストラクタです。

パブリック関数
`Void`	Attach( `T *` pointer ) インスタンスの解放責任を受けます。
`T *`	Detach( `Void` ) SFXResponderPointer クラスが管理するインスタンスの解放責任を譲ります。
static `SFXResponderPointer< T > const &`	EmptyInstance( `Void` ) 無効なインスタンスを持った SFXResponderPointer を取得します。
`T *`	Get( `Void` ) 保持しているインスタンスのポインタを取得します。
`Void`	Release( `Void` ) SFXResponderPointer を解放します。
`Void`	Set( `SFXResponderPointer< M > const &` param ) Set( `T *` pointer , `Bool` increment = true ) Set( `SFXResponderPointer< T > const &` param ) インスタンスを設定します。
`T *`	operator->( `Void` ) 保持しているインスタンスを呼び出します。
`SFXResponderPointer< T > &`	operator=( `SFXResponderPointer< M > const &` param ) operator=( `SFXResponderPointer< T > const &` param ) インスタンスを代入します。
`Bool`	operator==( `SFXResponderPointer< T > const &` left , `SFXResponderPointer< M > const &` right ) operator==( `SFYResponderConstPtr` left , `SFXResponderPointer< T > const &` right ) operator==( `SFXResponderPointer< T > const &` left , `SFYResponderConstPtr` right ) == の関係を判定します。
`Bool`	operator!=( `SFXResponderPointer< T > const &` left , `SFXResponderPointer< M > const &` right ) operator!=( `SFYResponderConstPtr` left , `SFXResponderPointer< T > const &` right ) operator!=( `SFXResponderPointer< T > const &` left , `SFYResponderConstPtr` right ) != の関係を判定します。

グローバル関数
`SFXResponderPointer< T >`	const_pointer_cast( `SFXResponderPointer< M > const &` param ) SFXResponderPointer 同士で const_cast を行います。
`SFXResponderPointer< T >`	dynamic_pointer_cast( `SFXResponderPointer< M > const &` param ) SFXResponderPointer 同士で dynamic_cast を行います。
`SFXResponderPointer< T >`	reinterpret_pointer_cast( `SFXResponderPointer< M > const &` param ) SFXResponderPointer 同士で reinterpret_cast を行います。
`SFXResponderPointer< T >`	static_pointer_cast( `SFXResponderPointer< M > const &` param ) SFXResponderPointer 同士で static_cast を行います。
`Bool`	operator==( `SFXResponderPointer< T > const &` left , `SFXResponderPointer< M > const &` right ) operator==( `SFYResponderConstPtr` left , `SFXResponderPointer< T > const &` right ) operator==( `SFXResponderPointer< T > const &` left , `SFYResponderConstPtr` right ) == の関係を判定します。
`T &`	operator*( `Void` ) 保持しているインスタンスを取得します。
`Bool`	operator!=( `SFXResponderPointer< T > const &` left , `SFXResponderPointer< M > const &` right ) operator!=( `SFYResponderConstPtr` left , `SFXResponderPointer< T > const &` right ) operator!=( `SFXResponderPointer< T > const &` left , `SFYResponderConstPtr` right ) != の関係を判定します。

SFXResponderPointer::SFXResponderPointer

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

[ public, explicit ]
SFXResponderPointer(Void);

[ public ]
SFXResponderPointer(
    SFXResponderPointer< M > const & param   // コピーする SFXResponderPointer のリファレンス
);

[ public ]
SFXResponderPointer(
    SFXResponderPointer< T > const & param   // コピーする SFXResponderPointer のリファレンス
);

[ public, explicit ]
SFXResponderPointer(
    T * pointer             // 格納するインスタンスのポインタ
    Bool increment = true   // 参照カウンタを増加させるかどうかを指定する
);

SFXResponderPointer::Attach

インスタンスの解放責任を受けます。

[ public ]
Void Attach(
    T * pointer   // 解放責任を譲るインスタンスのポインタ
);

解説

SFXResponderPointer が解放責任を受けると SFXResponderPointer がインスタンスを管理するようになり、参照カウントの自動管理が行われます。

Attach 関数は SFXResponderPointer::Set(address, false); を実行するのと同じです。

参照

SFXResponderPointer::Detach

SFXResponderPointer::Detach

SFXResponderPointer クラスが管理するインスタンスの解放責任を譲ります。

[ public ]
T * Detach(Void);

戻り値

SFXResponderPointer が持っていたインスタンスを返します。

解説

Detach 関数を呼び出すと SFXResponderPointer はインスタンスを管理しなくなり、参照カウントの自動管理が行われなくなります。

SFXResponderPointer::EmptyInstance

無効なインスタンスを持った SFXResponderPointer を取得します。

[ public, static ]
SFXResponderPointer< T > const & EmptyInstance(Void);

戻り値

無効なインスタンスを持った SFXResponderPointer のリファレンスを取得します。

解説

null のリファレンスは作成できないので、無効なインスタンスであることを示すために EmptyInstance 関数が用意されています。

SFXResponderPointer::Get

保持しているインスタンスのポインタを取得します。

[ public, const ]
T * Get(Void);

参照

SFXResponderPointer::Set

SFXResponderPointer::Release

SFXResponderPointer を解放します。

[ public ]
Void Release(Void);

解説

SFXResponderPointer の内部に保持しているインスタンスの参照カウンタをデクリメントし、インスタンスの管理をしなくなります。

SFXResponderPointer::Set

インスタンスを設定します。

[ public ]
Void Set(
    SFXResponderPointer< M > const & param   // 設定する SFXResponderPointer のリファレンス
);

[ public ]
Void Set(
    SFXResponderPointer< T > const & param   // 設定する SFXResponderPointer のリファレンス
);

[ public ]
Void Set(
    T * pointer             // 格納するインスタンスのポインタ
    Bool increment = true   // 参照カウンタを増加させるかどうか
);

解説

前に持っていたインスタンスの参照カウンタをデクリメントしてから、インスタンスが設定されます。

参照

SFXResponderPointer::Get | SFXResponderPointer::operator=

const_pointer_cast

SFXResponderPointer 同士で const_cast を行います。

SFXResponderPointer< T > const_pointer_cast(
    SFXResponderPointer< M > const & param   // キャストするポインタ
);

解説

SFXResponderPointer 同士の const_cast は、const_pointer_cast 関数を使って行います。

参照

static_pointer_cast | dynamic_pointer_cast | reinterpret_pointer_cast

dynamic_pointer_cast

SFXResponderPointer 同士で dynamic_cast を行います。

SFXResponderPointer< T > dynamic_pointer_cast(
    SFXResponderPointer< M > const & param   // キャストするポインタ
);

解説

SFXResponderPointer 同士の dynamic_cast は、dynamic_pointer_cast 関数を使って行います。

参照

static_pointer_cast | const_pointer_cast | reinterpret_pointer_cast

reinterpret_pointer_cast

SFXResponderPointer 同士で reinterpret_cast を行います。

SFXResponderPointer< T > reinterpret_pointer_cast(
    SFXResponderPointer< M > const & param   // キャストするポインタ
);

解説

SFXResponderPointer 同士の reinterpret_cast は、reinterpret_pointer_cast 関数を使って行います。

参照

static_pointer_cast | const_pointer_cast | dynamic_pointer_cast

static_pointer_cast

SFXResponderPointer 同士で static_cast を行います。

SFXResponderPointer< T > static_pointer_cast(
    SFXResponderPointer< M > const & param   // キャストするポインタ
);

解説

SFXResponderPointer 同士の static_cast は、static_pointer_cast 関数を使って行います。

参照

const_pointer_cast | dynamic_pointer_cast | reinterpret_pointer_cast

SFXResponderPointer::operator->

保持しているインスタンスを呼び出します。

[ public, const ]
T * operator->(Void);

SFXResponderPointer::operator=

インスタンスを代入します。

[ public ]
SFXResponderPointer< T > & operator=(
    SFXResponderPointer< M > const & param   // 代入する SFXResponderPointer のリファレンス
);

[ public ]
SFXResponderPointer< T > & operator=(
    SFXResponderPointer< T > const & param   // 代入する SFXResponderPointer のリファレンス
);

解説

SFXResponderPointer::operator= 演算子は内部で SFXResponderPointer::Set(SFXResponderPointer< M > const &)、または SFXResponderPointer::Set(SFXResponderPointer< T > const &) 関数を呼び出しています。

参照

SFXResponderPointer::Set

operator==

== の関係を判定します。

[ public, friend ]
Bool operator==(
    SFXResponderPointer< T > const & left    // 比較する SFXResponderPointer のリファレンス
    SFXResponderPointer< M > const & right   // 比較する SFXResponderPointer のリファレンス
);

[ public, friend ]
Bool operator==(
    SFXResponderPointer< T > const & left   // 比較する SFXResponderPointer のリファレンス
    SFYResponderConstPtr right              // 比較する SFYResponder のポインタ
);

[ public, friend ]
Bool operator==(
    SFYResponderConstPtr left                // 比較する SFYResponder のポインタ
    SFXResponderPointer< T > const & right   // 比較する SFXResponderPointer のリファレンス
);

戻り値

等しいとき : true
異なるとき : false

operator*

保持しているインスタンスを取得します。

[ const ]
T & operator*(Void);

operator!=

!= の関係を判定します。

[ public, friend ]
Bool operator!=(
    SFXResponderPointer< T > const & left    // 比較する SFXResponderPointer のリファレンス
    SFXResponderPointer< M > const & right   // 比較する SFXResponderPointer のリファレンス
);

[ public, friend ]
Bool operator!=(
    SFXResponderPointer< T > const & left   // 比較する SFXResponderPointer のリファレンス
    SFYResponderConstPtr right              // 比較する SFYResponder のポインタ
);

[ public, friend ]
Bool operator!=(
    SFYResponderConstPtr left                // 比較する SFYResponder のポインタ
    SFXResponderPointer< T > const & right   // 比較する SFXResponderPointer のリファレンス
);

戻り値

異なるとき : true
等しいとき : false