CTR NEX API Reference
NEX で定義されるマクロ

NEX で定義されるマクロ [詳解]

マクロ定義

#define DATASET(C)   _DS_##C
 ベースのデータセットクラスを参照するときに用いるマクロです。 [詳解]
 
#define DATASET_ISVALID(VAR)   _ds_isValid_ ## VAR()
 データセットの値が、データが生成されたDDLのリビジョン番号で有効な値か判定するマクロです。 [詳解]
 
#define DATASET_VALID_REVISION(VAR)   _ds_validRevision_ ## VAR
 データセットの値が、どのDDLのリビジョン番号で有効か取得するマクロです。 [詳解]
 
#define DOCLASS(C)   _DO_##C
 ベースのデータセットクラスを参照するときに用いるマクロです。 [詳解]
 
#define INVALID_DOHANDLE   NAMESPACE_NEX DOHandle(INVALID_DOHANDLE_VALUE)
 複製オブジェクトのローカルインスタンスを参照していない場合のDOHandle定義です。 [詳解]
 
#define INVALID_DOHANDLE_VALUE   0
 DOHandleで複製オブジェクトのローカルインスタンスを参照していない場合の定義値です。 [詳解]
 
#define LOOPBACKMODEL(DATASET, VAR)   (DATASET).GetLoopbackModel()->VAR
 DOマスターのdataset推定値にアクセスするマクロです。 [詳解]
 
#define MODEL(DATASET, VAR)   (DATASET).GetPHBDRModel()->VAR
 デュプリカのdataset推定値にアクセスするマクロです。 [詳解]
 
#define QERROR(FACILITY, RETURNCODE)   (NAMESPACE_NEX qInt32)(QRESULT_ERROR_BIT | NAMESPACE_NEX qResultFacility::FACILITY<<16 | NAMESPACE_NEX FACILITY##ErrorCode::RETURNCODE)
 ファシリティとエラー列挙子からリターンコードを生成します [詳解]
 
#define QFAILED(RETURNCODE)    ((RETURNCODE & QRESULT_ERROR_BIT) != 0)
 リターンコードが失敗を示すものかどうかを返します。 [詳解]
 
#define QRESULT_ERROR(FACILITY, RETURNCODE)   NAMESPACE_NEX qResult(QERROR(FACILITY,RETURNCODE))
 ファシリティとエラー列挙子からqResultを生成します [詳解]
 
#define QRESULT_SUCCESS(FACILITY, RETURNCODE)   NAMESPACE_NEX qResult(QSUCCESS(FACILITY,RETURNCODE))
 ファシリティと成功列挙子からqResultを生成します [詳解]
 
#define QSUCCEEDED(RETURNCODE)   ((RETURNCODE & QRESULT_ERROR_BIT) == 0)
 リターンコードが成功を示すものかどうかを返します。 [詳解]
 
#define QSUCCESS(FACILITY, RETURNCODE)   (NAMESPACE_NEX qInt32)(NAMESPACE_NEX qResultFacility::FACILITY<<16 | NAMESPACE_NEX FACILITY##SuccessCode::RETURNCODE)
 ファシリティと成功列挙子からリターンコードを生成します [詳解]
 

詳解

NEX で定義されるマクロ

マクロ定義詳解

#define QSUCCEEDED (   RETURNCODE)    ((RETURNCODE & QRESULT_ERROR_BIT) == 0)

リターンコードが成功を示すものかどうかを返します。

引数
[in]RETURNCODEqResult::GetReturnCode() で取得できるリターンコード
#define QFAILED (   RETURNCODE)    ((RETURNCODE & QRESULT_ERROR_BIT) != 0)

リターンコードが失敗を示すものかどうかを返します。

引数
[in]RETURNCODEqResult::GetReturnCode() で取得できるリターンコード
#define QERROR (   FACILITY,
  RETURNCODE 
)    (NAMESPACE_NEX qInt32)(QRESULT_ERROR_BIT | NAMESPACE_NEX qResultFacility::FACILITY<<16 | NAMESPACE_NEX FACILITY##ErrorCode::RETURNCODE)

ファシリティとエラー列挙子からリターンコードを生成します

引数
[in]FACILITYqResultFacilityに定義されている列挙子。
[in]RETURNCODEファシリティ名+ErrorCode に定義されている列挙子。
#define QSUCCESS (   FACILITY,
  RETURNCODE 
)    (NAMESPACE_NEX qInt32)(NAMESPACE_NEX qResultFacility::FACILITY<<16 | NAMESPACE_NEX FACILITY##SuccessCode::RETURNCODE)

ファシリティと成功列挙子からリターンコードを生成します

引数
[in]FACILITYqResultFacilityに定義されている列挙子。
[in]RETURNCODEファシリティ名+SuccessCode に定義されている列挙子。
#define QRESULT_ERROR (   FACILITY,
  RETURNCODE 
)    NAMESPACE_NEX qResult(QERROR(FACILITY,RETURNCODE))

ファシリティとエラー列挙子からqResultを生成します

引数
[in]FACILITYqResultFacilityに定義されている列挙子。
[in]RETURNCODEファシリティ名+ErrorCode に定義されている列挙子。
#define QRESULT_SUCCESS (   FACILITY,
  RETURNCODE 
)    NAMESPACE_NEX qResult(QSUCCESS(FACILITY,RETURNCODE))

ファシリティと成功列挙子からqResultを生成します

引数
[in]FACILITYqResultFacilityに定義されている列挙子。
[in]RETURNCODEファシリティ名+SuccessCode に定義されている列挙子。
#define DATASET (   C)    _DS_##C

ベースのデータセットクラスを参照するときに用いるマクロです。

DDLが以下のように定義されているときに、
dataset Position {
real x;
real y;
real z;
};
アプリケーションでは、Positionクラスを以下のように定義します。

class Position : public DATASET(Position) {
void Set( qReal x, qReal y, qReal z );
};

引数
Cクラス名
#define DATASET_ISVALID (   VAR)    _ds_isValid_ ## VAR()

データセットの値が、データが生成されたDDLのリビジョン番号で有効な値か判定するマクロです。

戻り値として、生成されたリビジョン番号で有効な値か否かをqBoolで返します。

引数
[in]VAR取得する値の名前を指定します。
#define DATASET_VALID_REVISION (   VAR)    _ds_validRevision_ ## VAR

データセットの値が、どのDDLのリビジョン番号で有効か取得するマクロです。

戻り値として、リビジョン番号をqByteで返します。

引数
[in]VAR取得する値の名前を指定します。
#define MODEL (   DATASET,
  VAR 
)    (DATASET).GetPHBDRModel()->VAR

デュプリカのdataset推定値にアクセスするマクロです。

引数
[in]DATASETデータセット名を指定します。
[in]VAR取得する値の名前尾を指定します。
#define LOOPBACKMODEL (   DATASET,
  VAR 
)    (DATASET).GetLoopbackModel()->VAR

DOマスターのdataset推定値にアクセスするマクロです。

引数
[in]DATASETデータセット名を指定します。
[in]VAR取得する値の名前尾を指定します。
#define INVALID_DOHANDLE_VALUE   0

DOHandleで複製オブジェクトのローカルインスタンスを参照していない場合の定義値です。

#define INVALID_DOHANDLE   NAMESPACE_NEX DOHandle(INVALID_DOHANDLE_VALUE)

複製オブジェクトのローカルインスタンスを参照していない場合のDOHandle定義です。

#define DOCLASS (   C)    _DO_##C

ベースのデータセットクラスを参照するときに用いるマクロです。

DDLが以下のように定義されているときに、
doclass GameObject {
};
アプリケーションでは、GameObjectクラスを以下のように定義します。

class GameObject : public DOCLASS(GameObject) {
};

引数
Cクラス名