前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFXBrewPointer
BREW インターフェース C++ ラッパークラス用のスマートポインタークラス(テンプレートクラス)です。
#include <SFXBrewPointer.h.hpp>
class SFXBrewPointer;
SFMTYPEDEFCLASS(SFXBrewPointer)

継承図

SFXBrewPointer クラスの継承図

協調図

SFXBrewPointer クラスの協調図

解説

SFXBrewPointer クラスは、 参照カウントオブジェクトクラスに対して、参照カウントを自動管理する機能を提供します。

参照

BREW ラッパークラス

メンバ

コンストラクタ/デストラクタ
SFXBrewPointer( Void )
SFXBrewPointer クラスのコンストラクタです。
SFXBrewPointer( SFXBrewPointer< M > const & param )
SFXBrewPointer クラスのコンストラクタです。
SFXBrewPointer( SFXBrewPointer< T > const & param )
SFXBrewPointer クラスのコンストラクタです。
SFXBrewPointer( T * pointer , Bool increment = true )
SFXBrewPointer クラスのコンストラクタです。
パブリック関数
Void Attach( T * pointer )
インスタンスの解放責任を受けます。
T * Detach( Void )
SFXBrewPointer クラスが管理するインスタンスの解放責任を譲ります。
static
SFXBrewPointer< T > const &
EmptyInstance( Void )
null を表す SFXBrewPointer インスタンスを取得します。
T * Get( Void )
保持しているインスタンスのポインタを取得します。
Void Release( Void )
SFXBrewPointer を解放します。
Void Set( SFXBrewPointer< M > const & param )
インスタンスを設定します。
Void Set( SFXBrewPointer< T > const & param )
インスタンスを設定します。
Void Set( T * pointer , Bool increment = true )
インスタンスを設定します。
T * operator->( Void )
保持しているインスタンスのメンバにアクセスします。
SFXBrewPointer< T > & operator=( SFXBrewPointer< M > const & param )
インスタンスを代入します。
SFXBrewPointer< T > & operator=( SFXBrewPointer< T > const & param )
インスタンスを代入します。
Bool operator==( SFXBrewPointer< T > const & left , SFXBrewPointer< M > const & right )
== の関係を判定します。
Bool operator==( SFXBrewPointer< T > const & left , SFBBaseConstPtr right )
== の関係を判定します。
Bool operator==( SFBBaseConstPtr left , SFXBrewPointer< T > const & right )
== の関係を判定します。
Bool operator!=( SFXBrewPointer< T > const & left , SFXBrewPointer< M > const & right )
!= の関係を判定します。
Bool operator!=( SFXBrewPointer< T > const & left , SFBBaseConstPtr right )
!= の関係を判定します。
Bool operator!=( SFBBaseConstPtr left , SFXBrewPointer< T > const & right )
!= の関係を判定します。
グローバル関数
SFXBrewPointer< T > const_pointer_cast( SFXBrewPointer< M > const & param )
SFXBrewPointer 同士で const_cast を行います。
SFXBrewPointer< T > reinterpret_pointer_cast( SFXBrewPointer< M > const & param )
SFXBrewPointer 同士で reinterpret_cast を行います。
SFXBrewPointer< T > static_pointer_cast( SFXBrewPointer< M > const & param )
SFXBrewPointer 同士で static_cast を行います。
Bool operator==( SFXBrewPointer< T > const & left , SFXBrewPointer< M > const & right )
== の関係を判定します。
Bool operator==( SFXBrewPointer< T > const & left , SFBBaseConstPtr right )
== の関係を判定します。
Bool operator==( SFBBaseConstPtr left , SFXBrewPointer< T > const & right )
== の関係を判定します。
T & operator*( Void )
保持しているインスタンスを取得します。
Bool operator!=( SFXBrewPointer< T > const & left , SFXBrewPointer< M > const & right )
!= の関係を判定します。
Bool operator!=( SFXBrewPointer< T > const & left , SFBBaseConstPtr right )
!= の関係を判定します。
Bool operator!=( SFBBaseConstPtr left , SFXBrewPointer< T > const & right )
!= の関係を判定します。

SFXBrewPointer::SFXBrewPointer
SFXBrewPointer クラスのコンストラクタです。
[ public, explicit ]
SFXBrewPointer(Void);
[ public ]
SFXBrewPointer(
    SFXBrewPointer< M > const & param   // コピーする SFXBrewPointer のリファレンス
);
[ public ]
SFXBrewPointer(
    SFXBrewPointer< T > const & param   // コピーする SFXBrewPointer のリファレンス
);
[ public, explicit ]
SFXBrewPointer(
    T * pointer             // 格納するインスタンスのポインタ
    Bool increment = true   // 参照カウンタを増加させるかどうかを指定する
);

解説

このコンストラクタは、 指定されたインスタンスを設定します。

[Note] 注意

引数が SFXBrewPointer インスタンスの場合は、コピーされます。

デフォルトでは、 設定するインスタンスの参照カウンタはインクリメントされます。

参照

SFXBrewPointer::Set


SFXBrewPointer::Attach
インスタンスの解放責任を受けます。
[ public ]
Void Attach(
    T * pointer   // 解放責任を譲るインスタンスのポインタ
);

解説

この関数は、指定されたインスタンスの解放責任を受けます。

[Note] 注意

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

Attach 関数は

    SFXBrewPointer::Set(address, false);

を実行するのと同じです。

参照

SFXBrewPointer::Detach


SFXBrewPointer::Detach
SFXBrewPointer クラスが管理するインスタンスの解放責任を譲ります。
[ public ]
T * Detach(Void);

戻り値

SFXBrewPointer クラスが内部に保持しているインスタンス。

解説

この関数は、 SFXBrewPointer クラスが内部に保持しているインスタンスの解放責任を譲ります。

[Note] 注意

SFXBrewPointer クラスは内部で保持していたインスタンスを管理しなくなり、 参照カウントの自動管理が行われなくなります。

参照

SFXBrewPointer::Attach


SFXBrewPointer::EmptyInstance
null を表す SFXBrewPointer インスタンスを取得します。
[ public, static ]
SFXBrewPointer< T > const & EmptyInstance(Void);

戻り値

null を表す SFXBrewPointer インスタンスのリファレンス。

解説

この関数は、 null を表す SFXBrewPointer インスタンスを取得します。

[Note] 注意

この関数を利用すれば、 null を表す SFXBrewPointer インスタンスの const 参照を返すことができます。

内部実装

この関数の内部実装は以下の通りです。

template <typename T>
/*public static */inline SFXBrewPointer<T> const& SFXBrewPointer<T>::EmptyInstance(Void)
{
    return static_cast<SFXBrewPointer<T> const&>(SFABrewPointer::EmptyInstance());
}// SFXBrewPointer<T>::EmptyInstance //

/*protected static */SFABrewPointerConstRef SFABrewPointer::EmptyInstance(Void)
{
    static UInt64Const                          result[cluster64of(SFABrewPointer)] = {
        0
    };

    return *reinterpret_cast<SFABrewPointerConstPtr>(result);
}// SFABrewPointer::EmptyInstance //
[Note] cluster64of マクロ

cluster64of マクロは、 8 バイト境界にアラインしたときに 8 バイトのクラスターがいくつ必要になるかを計算するマクロです。


SFXBrewPointer::Get
保持しているインスタンスのポインタを取得します。
[ public, const ]
T * Get(Void);

戻り値

保持しているインスタンスのポインタ。

解説

この関数は、 保持しているインスタンスのポインタを取得します。

参照

SFXBrewPointer::Set


SFXBrewPointer::Release
SFXBrewPointer を解放します。
[ public ]
Void Release(Void);

解説

この関数は、 内部に保持しているインスタンスを解放します。

[Note] 注意

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

参照

SFXBrewPointer::Set


SFXBrewPointer::Set
インスタンスを設定します。
[ public ]
Void Set(
    SFXBrewPointer< M > const & param   // 設定する SFXBrewPointer のリファレンス
);
[ public ]
Void Set(
    SFXBrewPointer< T > const & param   // 設定する SFXBrewPointer のリファレンス
);
[ public ]
Void Set(
    T * pointer             // 格納するインスタンスのポインタ
    Bool increment = true   // 参照カウンタを増加させるかどうか
);

解説

この関数は、 指定されたインスタンスを設定します。

[Note] 注意

旧いインスタンスの参照カウンタをデクリメントしてから、 新しいインスタンスのポインタを設定します。

デフォルトでは、 新しいインスタンスの参照カウンタはインクリメントされます。

参照

SFXBrewPointer::Get | SFXBrewPointer::SFXBrewPointer | SFXBrewPointer::operator=


const_pointer_cast
SFXBrewPointer 同士で const_cast を行います。
SFXBrewPointer< T > const_pointer_cast(
    SFXBrewPointer< M > const & param   // キャストするポインタ
);

解説

この関数は、 SFXBrewPointer 同士で const_cast を行います。

[Note] 注意

SFXBrewPointer 同士の const_cast は、 const_pointer_cast 関数を使用して行います。

参照

static_pointer_cast | reinterpret_pointer_cast | SFXBrewPointer


reinterpret_pointer_cast
SFXBrewPointer 同士で reinterpret_cast を行います。
SFXBrewPointer< T > reinterpret_pointer_cast(
    SFXBrewPointer< M > const & param   // キャストするポインタ
);

解説

この関数は、 SFXBrewPointer 同士で reinterpret_cast を行います。

[Note] 注意

SFXBrewPointer 同士の reinterpret_cast は、 reinterpret_pointer_cast 関数を使用して行います。

参照

static_pointer_cast | const_pointer_cast | SFXBrewPointer


static_pointer_cast
SFXBrewPointer 同士で static_cast を行います。
SFXBrewPointer< T > static_pointer_cast(
    SFXBrewPointer< M > const & param   // キャストするポインタ
);

解説

この関数は、 SFXBrewPointer 同士で static_cast を行います。

[Note] 注意

SFXBrewPointer 同士の static_cast は、 static_pointer_cast 関数を使用して行います。

参照

const_pointer_cast | reinterpret_pointer_cast | SFXBrewPointer


SFXBrewPointer::operator->
保持しているインスタンスのメンバにアクセスします。
[ public, const ]
T * operator->(Void);

戻り値

保持しているインスタンスのポインタ。

解説

このオペレータは、 保持しているインスタンスのメンバにアクセスします。

[Note] -> オペレータのオーバーロード

オーバーロードされた -> オペレータでは、 戻り値に対して事前定義された -> オペレータが更に作用されます。

SFXBrewPointer::Get 関数は保持しているインスタンスのポインタを返すだけですが、 SFXBrewPointer::operator-> オペレータは保持しているインスタンスのポインタを取得し、 更に事前定義された -> オペレータを呼び出し、 保持しているインスタンスのメンバにアクセスします。

参照

operator* | SFXBrewPointer::Get


SFXBrewPointer::operator=
インスタンスを代入します。
[ public ]
SFXBrewPointer< T > & operator=(
    SFXBrewPointer< M > const & param   // 代入する SFXBrewPointer のリファレンス
);
[ public ]
SFXBrewPointer< T > & operator=(
    SFXBrewPointer< T > const & param   // 代入する SFXBrewPointer のリファレンス
);

解説

このオペレータは、 インスタンスのポインタを代入します。

[Note] 注意

このオペレータは、 内部で SFXBrewPointer::Set 関数を呼び出します。

参照

SFXBrewPointer::Set


operator==
== の関係を判定します。
[ public, friend ]
Bool operator==(
    SFXBrewPointer< T > const & left    // 比較する SFXBrewPointer のリファレンス
    SFXBrewPointer< M > const & right   // 比較する SFXBrewPointer のリファレンス
);
[ public, friend ]
Bool operator==(
    SFXBrewPointer< T > const & left   // 比較する SFXBrewPointer のリファレンス
    SFBBaseConstPtr right              // 比較する SFBBase のポインタ
);
[ public, friend ]
Bool operator==(
    SFBBaseConstPtr left                // 比較する SFBBase のポインタ
    SFXBrewPointer< T > const & right   // 比較する SFXBrewPointer のリファレンス
);

戻り値

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

解説

このオペレータは、 == の関係を判定します。

参照

operator!=


operator*
保持しているインスタンスを取得します。
[ const ]
T & operator*(Void);

戻り値

保持しているインスタンス。

解説

このオペレータは、 保持しているインスタンスを取得します。

参照

SFXBrewPointer::operator->


operator!=
!= の関係を判定します。
[ public, friend ]
Bool operator!=(
    SFXBrewPointer< T > const & left    // 比較する SFXBrewPointer のリファレンス
    SFXBrewPointer< M > const & right   // 比較する SFXBrewPointer のリファレンス
);
[ public, friend ]
Bool operator!=(
    SFXBrewPointer< T > const & left   // 比較する SFXBrewPointer のリファレンス
    SFBBaseConstPtr right              // 比較する SFBBase のポインタ
);
[ public, friend ]
Bool operator!=(
    SFBBaseConstPtr left                // 比較する SFBBase のポインタ
    SFXBrewPointer< T > const & right   // 比較する SFXBrewPointer のリファレンス
);

戻り値

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

解説

このオペレータは、 == の関係を判定します。

参照

operator==