CTR NEX API Reference
nn::nex::DOHandle クラス

複製オブジェクトのローカルインスタンスを参照する、複製オブジェクトハンドルです。 [詳解]

#include <NetZ/src/Core/DOCore/DOHandle.h>

+ nn::nex::DOHandle の継承関係図

公開メンバ関数

 DOHandle (qUnsignedInt32 uiValue=INVALID_DOHANDLE_VALUE)
 コンストラクタ。複製オブジェクトハンドルを作成します。 [詳解]
 
 DOHandle (const DOHandle &dohOther)
 コンストラクタ。複製オブジェクトハンドルを作成します。 [詳解]
 
const qCharGetClassNameString () const
 このハンドルが示す複製オブジェクトのクラス名を文字列として取得します。 [詳解]
 
const qCharGetDatasetNameString (qByte byDatasetIndex) const
 このハンドルが示す複製オブジェクトの、 指定された番号に対応するデータセットの名称を文字列として取得します。 [詳解]
 
qUnsignedInt32 GetDOClassID () const
 この複製オブジェクトハンドルの複製オブジェクトクラスIDを取得します。 [詳解]
 
DOID GetDOID () const
 この複製オブジェクトハンドルの複製オブジェクトIDを取得します。 [詳解]
 
qUnsignedInt32 GetValue () const
 複製オブジェクトハンドルをqUnsignedInt32 型として取得します。 [詳解]
 
qBool IsA (DOClassID idDOCID)
 指定された複製オブジェクトクラスIDのクラスに、 このハンドルが示す複製オブジェクトのインスタンスが属するかどうかを調べます。 [詳解]
 
qBool IsACoreDO ()
 このハンドルが指し示す複製オブジェクトがCoreDOであるかどうかを取得します。 [詳解]
 
qBool IsAKindOf (DOClassID idDOCID)
 指定された複製オブジェクトクラスIDのクラスあるいはその派生関係にあるクラスに、 このハンドルが示す複製オブジェクトのインスタンスが属するかどうかを調べます。 [詳解]
 
qBool IsAUserDO ()
 このハンドルが指し示す複製オブジェクトがユーザー定義複製オブジェクトであるかどうかを取得します。 [詳解]
 
qBool IsAWKHandle () const
 このハンドルが指し示す複製オブジェクトが既知オブジェクトであるかを取得します。 [詳解]
 

詳解

複製オブジェクトのローカルインスタンスを参照する、複製オブジェクトハンドルです。

複製オブジェクトハンドルは32bitの値で、ひとつのオブジェクトに対して、セッションに参加するすべての ステーションの間において唯一であることを保証する値となります。複製オブジェクトハンドルは、 複製オブジェクトクラスID (DOClassID)と複製オブジェクトID(DOID)によって構成されています。

参照
DuplicatedObject::GetHandle

構築子と解体子

nn::nex::DOHandle::DOHandle ( qUnsignedInt32  uiValue = INVALID_DOHANDLE_VALUE)

コンストラクタ。複製オブジェクトハンドルを作成します。

指定された値で複製オブジェクトハンドルのインスタンスを初期化します。 もしコンストラクタになにも引数が渡されなければ、 複製オブジェクトハンドルのインスタンスは値をINVALID_DOHANDLE_VALUEとして初期化します。

引数
uiValue[in] 生成される複製オブジェクトハンドルの初期値を指定します(デフォルトはINVALID_DOHANDLE_VALUE)。
nn::nex::DOHandle::DOHandle ( const DOHandle dohOther)

コンストラクタ。複製オブジェクトハンドルを作成します。

指定されたdohOtherが指し示す複製オブジェクト(DuplicatedObject)と 同一の複製オブジェクトインスタンスを指し示す値として 複製オブジェクトハンドルを初期化します。

引数
dohOther[in] すでに存在している複製オブジェクトハンドルを指定します。

関数詳解

qUnsignedInt32 nn::nex::DOHandle::GetValue ( ) const

複製オブジェクトハンドルをqUnsignedInt32 型として取得します。

戻り値
複製オブジェクトハンドルをqUnsignedInt32 型としたものが返ります。
qBool nn::nex::DOHandle::IsAWKHandle ( ) const

このハンドルが指し示す複製オブジェクトが既知オブジェクトであるかを取得します。

既知オブジェクトについての詳細はNEXプログラミングマニュアルを 参照してください。

戻り値
true ハンドルが示す複製オブジェクトは既知オブジェクトです。
false ハンドルが示す複製オブジェクトは既知オブジェクトではないか、エラーが発生しました。
参照
WKHandle
IsAUserDO
IsACoreDO
qBool nn::nex::DOHandle::IsACoreDO ( )

このハンドルが指し示す複製オブジェクトがCoreDOであるかどうかを取得します。

Net-Zによって自動的に作成される複製オブジェクトのことをCoreDOと呼びます。 詳しくはNEXプログラミングマニュアルも参照してください。


戻り値一覧:

true このハンドルがNet-Zによって作られたことを示します。

false このハンドルがNet-Zによって作られていないことを示します。

参照
IsAUserDO
IsAWKHandle
qBool nn::nex::DOHandle::IsAUserDO ( )

このハンドルが指し示す複製オブジェクトがユーザー定義複製オブジェクトであるかどうかを取得します。

ユーザー定義複製オブジェクトとは、ユーザーがDDL(データ定義言語)よって宣言した 複製オブジェクトのことを指します。


戻り値一覧:

true ユーザー定義複製オブジェクトであるときに返ります。

false ユーザー定義複製オブジェクトでないときに返ります。

DOID nn::nex::DOHandle::GetDOID ( ) const

この複製オブジェクトハンドルの複製オブジェクトIDを取得します。

複製オブジェクトハンドルは、複製オブジェクトクラスID(DOClassID)と 複製オブジェクトID(DOID)から成り立っています。

複製オブジェクトクラスIDの値はDOCLASSIDマクロを利用することで取得できます。

戻り値
この複製オブジェクトハンドルの複製オブジェクトIDが返ります。
参照
GetDOClassID
qUnsignedInt32 nn::nex::DOHandle::GetDOClassID ( ) const

この複製オブジェクトハンドルの複製オブジェクトクラスIDを取得します。

複製オブジェクトハンドルは、複製オブジェクトクラスID(DOClassID)と 複製オブジェクトID(DOID)から成り立っています。

複製オブジェクトクラスIDの値はDOCLASSIDマクロを利用することで取得できます。

戻り値
この複製オブジェクトハンドルの複製オブジェクトクラスIDが返ります。
参照
GetDOID
qBool nn::nex::DOHandle::IsA ( DOClassID  idDOCID)

指定された複製オブジェクトクラスIDのクラスに、 このハンドルが示す複製オブジェクトのインスタンスが属するかどうかを調べます。

複製オブジェクトクラスIDの値はDOCLASSIDマクロを利用することで取得できます。

引数
idDOCID[in] 調べる対象の複製オブジェクトクラスIDを指定します。
参照
IsAKindOf
DuplicatedObject::IsA
qBool nn::nex::DOHandle::IsAKindOf ( DOClassID  idDOCID)

指定された複製オブジェクトクラスIDのクラスあるいはその派生関係にあるクラスに、 このハンドルが示す複製オブジェクトのインスタンスが属するかどうかを調べます。

複製オブジェクトクラスIDの値はDOCLASSIDマクロを利用することで取得できます。

引数
idDOCID[in] 調べる対象の複製オブジェクトクラスIDを指定します。
参照
IsA
DuplicatedObject::IsAKindOf
const qChar* nn::nex::DOHandle::GetClassNameString ( ) const

このハンドルが示す複製オブジェクトのクラス名を文字列として取得します。

戻り値
複製オブジェクトのクラス名を示す文字列へのポインタが返ります。
参照
DuplicatedObject::GetClassNameString
const qChar* nn::nex::DOHandle::GetDatasetNameString ( qByte  byDatasetIndex) const

このハンドルが示す複製オブジェクトの、 指定された番号に対応するデータセットの名称を文字列として取得します。

引数
byDatasetIndex[in] データセットのインデックス番号を指定します。
戻り値
データセットの名称の文字列へのポインタが返ります。
参照
DuplicatedObject::GetdatasetNameString