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

既知複製オブジェクトへの参照ハンドルです。 [詳解]

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

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

公開メンバ関数

 WKHandle ()
 このコンストラクタはアプリケーション側から呼び出さないでください。セッション作成時にシステムが自動的に作成します。
 
virtual ~WKHandle ()
 このデストラクタはアプリケーション側から呼び出さないでください。セッション終了時にシステムが自動的に破棄します。
 
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
 このハンドルが指し示す複製オブジェクトが既知オブジェクトであるかを取得します。 [詳解]
 

詳解

既知複製オブジェクトへの参照ハンドルです。

WKHandleクラスは既知複製オブジェクトへの参照です。 既知オブジェクトがDDL(データ定義言語)ファイルで宣言されるたびに、 WKHandle型のグローバル変数がDDLコンパイラによって生成されます。

このWKHandleクラスは、DOHandleクラスから派生します。

関数詳解

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

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

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

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

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

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

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

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


戻り値一覧:

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

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

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

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

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


戻り値一覧:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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