CTR NEX API Reference
nn::nex::AddToStoreOperation クラスabstract

このDOOperationは複製オブジェクトが見つかったときか、発行されたときに実行されます。 [詳解]

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

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

公開型

enum  Type {
  ChangeMasterStation,
  ChangeDupSet,
  FaultRecovery,
  AddToStore,
  RemoveFromStore,
  CallMethod,
  UpdateDataSet,
  JoinSession,
  JoinStation,
  LeaveStation
}
 システムから呼び出される操作の種類を表す列挙体です。 [詳解]
 

公開メンバ関数

qBool AddToDuplicaSelection () const
 この操作によってデュプリカストアに追加されるかどうかを返します。 [詳解]
 
qBool AddToDuplicationMasterSelection () const
 この操作によって複製マスターストアに追加されるかどうかを返します。 [詳解]
 
DuplicatedObjectGetAssociatedDO () const
 操作に関連付けられている複製オブジェクトへのポインタを取得します。 [詳解]
 
DOHandle GetAssociatedDOHandle () const
 この操作に関連付けられている複製オブジェクトハンドルを取得します。 [詳解]
 
virtual const qCharGetClassNameString () const =0
 この操作オブジェクトのクラス名称を取得します。 [詳解]
 
DOHandle GetOrigin () const
 操作オブジェクトを結果として生じるような呼び出しを行ったステーションへの複製オブジェクトハンドルを取得します。 [詳解]
 
virtual Type GetType () const =0
 この操作オブジェクトの種類を返します。 [詳解]
 
UserContext GetUserData ()
 ユーザー定義値を取得します。 [詳解]
 
void SetUserData (UserContext uUserData)
 ユーザー定義値を設定します。 [詳解]
 

静的公開メンバ関数

static SpecificOperation * DynamicCast (Operation *pOperation)
 ランタイム情報を用いた動的キャストを行います。 [詳解]
 
static void SetTraceFilter (qBool(*pfTraceFilter)(const Operation *))
 操作オブジェクトのトレース実行をどのタイミングで実行するかを指定するためのコールバック関数を設定します。 [詳解]
 

詳解

このDOOperationは複製オブジェクトが見つかったときか、発行されたときに実行されます。

それぞれのステーションは、複製オブジェクトストアと呼ばれる領域を持っており、 そこにアクティブな複製マスター(ローカルで発行済み)と、デュプリカ(ローカルで発見済み)のリストを格納しています。 複製オブジェクトがアプリケーション実行中に作成されたり削除されたりするときに、その結果として、 複製オブジェクトストアから追加されたり削除されたりします。 複製オブジェクトストアに格納されているオブジェクトのみがアクティブであるとみなされ、 ローカルステーションで更新されます。

複製マスターはローカルステーションに存在すればアクティブとなります。 つまり、複製オブジェクトを作成したあと、DuplicatedObject::Publish を呼び出して複製オブジェクトを発行してから、 DuplicatedObject::DeleteMainRef 関数を呼び出して主参照が削除されるまでがアクティブです。 複製マスターがストアに保存されるまでには以下の流れでイベントが発生します。

複製マスターがシステムに存在しているときにアクティブとなります。 デュプリカがストアに保存されるまでには以下の流れでイベントが発生します。

このAddToStoreOperationクラスは、ステーションがセッションから 離脱する処理(Station::GetState がLeavingかLeavingOnFaultになっている状態のとき)を実行中だと途中終了します。

参照
DuplicatedObject

列挙型メンバ詳解

enum nn::nex::Operation::Type
inherited

システムから呼び出される操作の種類を表す列挙体です。

参照
GetType
列挙値
ChangeMasterStation 

ChangeMasterStationOperation クラスのインスタンスであるときに、この列挙値になります。

ChangeDupSet 

ChangeDupSetOperation クラスのインスタンスであるときに、この列挙値になります。

FaultRecovery 

FaultRecoveryOperation クラスのインスタンスであるときに、この列挙値になります。

AddToStore 

AddToStoreOperation クラスのインスタンスであるときに、この列挙値になります。

RemoveFromStore 

RemoveFromStoreOperation クラスのインスタンスであるときに、この列挙値になります。

CallMethod 

CallMethodOperation クラスのインスタンスであるときに、この列挙値になります。

UpdateDataSet 

UpdateDataSetOperation クラスのインスタンスであるときに、この列挙値になります。

JoinSession 

JoinSessionOperation クラスのインスタンスであるときに、この列挙値になります。

JoinStation 

JoinStationOperation クラスのインスタンスであるときに、この列挙値になります。

LeaveStation 

LeaveStationOperation クラスのインスタンスであるときに、この列挙値になります。

関数詳解

qBool nn::nex::AddToStoreOperation::AddToDuplicationMasterSelection ( ) const

この操作によって複製マスターストアに追加されるかどうかを返します。

複製マスターストアとは、それぞれのステーションが保持する複製オブジェクトのリストの 格納先の中で、複製マスターのみを保存する領域のことを指します。


戻り値一覧:
true 複製マスターストアに格納する場合に返ります。 これは、複製オブジェクトが発行(DuplicatedObject::Publish)された結果として このクラスインスタンスが生成されたことを意味します。


戻り値一覧:
false デュプリカストアに格納する、あるいはエラーが発生したときに返ります。
参照
AddToDuplicaSelection
qBool nn::nex::AddToStoreOperation::AddToDuplicaSelection ( ) const

この操作によってデュプリカストアに追加されるかどうかを返します。

デュプリカストアとは、それぞれのステーションが保持する複製オブジェクトのリストの 格納先の中で、デュプリカのみを保存する領域のことを指します。


戻り値一覧:
true デュプリカストアに格納する場合に返ります。 複製オブジェクトをローカルで発見した結果として このクラスインスタンスが生成されたことを意味します。


戻り値一覧:
false 複製マスターストアに格納する、あるいはエラーが発生したときに返ります。
参照
AddToDuplicationMasterSelection
DOHandle nn::nex::DOOperation::GetAssociatedDOHandle ( ) const
inherited

この操作に関連付けられている複製オブジェクトハンドルを取得します。

参照
GetAssociatedDO, DOHandle, DuplicatedObject
戻り値
この操作に関連付けられている複製オブジェクトハンドル(DOHandle ) が返ります。
DOHandle nn::nex::DOOperation::GetOrigin ( ) const
inherited

操作オブジェクトを結果として生じるような呼び出しを行ったステーションへの複製オブジェクトハンドルを取得します。

たとえば、ステーションがDuplicatedObject::FetchDuplica 関数を 呼び出してChangeDupSetOperation 操作を誘発させた場合、 この関数は、DuplicatedObject::FetchDuplica 関数を呼び出した ステーションのDOHandleが返ります。

この関数の典型的な利用例は、SafetyExecutive にて、 そのステーションが操作を実際に行うための権利があるかどうかを判定するために 使用することです。

戻り値
操作オブジェクトを生じさせるような呼び出しを行ったステーションへの複製オブジェクトハンドルが返ります。
参照
SafetyExecutive
DuplicatedObject* nn::nex::DOOperation::GetAssociatedDO ( ) const
inherited

操作に関連付けられている複製オブジェクトへのポインタを取得します。

戻り値
操作に関連付けられている複製オブジェクトへのポインタ(DuplicatedObject)が返ります。
参照
GetAssociatedDOHandle, DuplicatedObject
virtual Type nn::nex::Operation::GetType ( ) const
pure virtualinherited

この操作オブジェクトの種類を返します。

戻り値
この操作オブジェクトインスタンスの種類が返ります。
UserContext nn::nex::Operation::GetUserData ( )
inherited

ユーザー定義値を取得します。

ユーザー定義データは、DataSet::OperationBegin または DuplicatedObject::OperationBegin 関数にて設定(SetUserData)し、 DataSet::OperationEnd またはDuplicatedObject::OperationEnd 関数にて この関数を通じて呼び出して使用するために用意されています。

戻り値
SetUserData でこの操作に設定されたユーザー定義値が返ります。
参照
SetUserData
void nn::nex::Operation::SetUserData ( UserContext  uUserData)
inherited

ユーザー定義値を設定します。

ユーザー定義値は、qUnsignedInt32qReal か、 何かしらのオブジェクトへのポインタです。この関数は、 DataSet::OperationBegin またはDuplicatedObject::OperationBegin 関数にて 呼び出し、ユーザー定義値をセットしたあと、 DataSet::OperationEnd またはDuplicatedObject::OperationEnd 関数にて GetUserData 関数を呼び出してユーザー定義値を取り出して利用することが出来ます。

virtual const qChar* nn::nex::Operation::GetClassNameString ( ) const
pure virtualinherited

この操作オブジェクトのクラス名称を取得します。

戻り値
クラス名称へのポインタが返ります。
static SpecificOperation* nn::nex::Operation::DynamicCast ( Operation pOperation)
staticinherited

ランタイム情報を用いた動的キャストを行います。

この関数はNetZの動的情報を用いて、C++のdynamic_castに相当する機能を提供します。 Operationクラスとその派生クラスのみに利用することが可能です。 この機能を利用するためにRTTIを有効にする必要はありません。

この関数を呼び出すには、キャストしたい対象のクラスにある静的関数を呼び出します。 たとえば、Operation型のポインタpOperationを、AddToStoreOperation 型の ポインタに動的変換するためには、AddToStoreOperation::DynamicCast 関数を利用します。

引数
[in]pOperation変換元の操作オブジェクトへのポインタを指定します。
戻り値
動的キャストされたポインタが返ります。
戻り値一覧:
NULL 指定されたpOperationがNULLである場合、 あるいは、pOperationがキャスト対象のクラスインスタンスではなかったときに返ります。
static void nn::nex::Operation::SetTraceFilter ( qBool(*)(const Operation *)  pfTraceFilter)
staticinherited

操作オブジェクトのトレース実行をどのタイミングで実行するかを指定するためのコールバック関数を設定します。

これで指定されたコールバック関数は、システム側から呼びだされ、 TraceLog でトレースすべき操作かどうかを指定します。 指定されたコールバック関数は、トレース対象となっている操作オブジェクトのポインタとともに 呼び出され、qBool値を返します。これがtrueであればトレースを行い、 falseであればトレースを行いません。

TraceLogにトレースフラグをセットしたあとで、 この関数を利用して操作ごとのフィルタコールバックを設定します。 もしなにも設定されていなければ、 CoreDO(システム側で自動的に用意される複製オブジェクト。たとえばStation, Session など。)を 除くすべての複製オブジェクト(つまり、UserDO)に対してトレースが行われるように設定されます。

引数
[in]pfTraceFilterトレースフィルタ用のコールバック関数を指定します。
参照
DuplicatedObject::IsACoreDO, DuplicatedObject::IsAUserDO