class DuplicatedObject
Base class for all duplicated objects.
When a duplicated object class is defined in the Data Definition Language (DDL) file, a corresponding class is automatically generated by the DDL compiler. All such classes are derived from this DuplicatedObject
class. This DuplicatedObject
class includes various general-purpose duplicated object functions that can also be used on user-defined duplicated objects.
This class also defines system callbacks. There are several virtual functions, which are meant to be overridden from user-defined duplicated object classes. These overridden functions are then called at the appropriate times.
Ref
|
Typedef that safely references a duplicated object. | |
---|---|---|
SelectionIterator
|
Iterator typedef for enumerating duplicated objects. |
S |
DEFAULT_CREATE_TIMEOUT
|
The default timeout value specified by the DuplicatedObject::Create function. The unit is milliseconds. |
---|---|---|
S |
DEFAULT_PUBLISH_TIMEOUT
|
The default timeout value specified by the DuplicatedObject::Publish function. The unit is milliseconds. |
DuplicatedObject | Do not call this constructor from applications. | |
---|---|---|
V |
~DuplicatedObject
|
Do not call this destructor from applications. |
GetHandle
|
Gets the duplicated object handle of this duplicated object. | |
GetHandleValue
|
Gets a qUnsignedInt32 -type value that represents an instance of this duplicated object. |
|
IsGlobal
|
Gets whether this instance is a global duplicated object. | |
GetClassNameString
|
Gets the class name string of a duplicated object. | |
GetDatasetNameString
|
Gets the name of a dataset associated with this duplicated object. | |
GetDOClassID
|
Gets the class ID of this duplicated object. | |
IsA
|
Checks whether this duplicated object instance is of the specified duplicated object class. | |
IsAKindOf
|
Checks whether this duplicated object instance is of the specified duplicated object class or one of its derived classes. | |
Update | Notifies duplicas in the session that the content of all datasets has been updated. | |
Refresh
|
Transfers duplica dataset information from the buffer. | |
V |
ApproveFaultRecovery
|
Returns whether to use fault recovery for duplicated objects. |
V |
ApproveEmigration
|
Returns whether the duplicated object migrates. |
V |
InitDO
|
This function is called by the system when a duplicated object has been initialized. |
V |
ComputeDistance
|
Calculates the distance used to calculate a distance-based extrapolation error for dead reckoning. |
V |
OperationBegin
|
Called every time a duplicated object system operation is started. |
V |
OperationEnd
|
Called every time a duplicated object system operation ends. |
V |
Trace
|
Traces the state of this duplicated object. (Used in debugging.) |
CreateDuplica
|
Creates a duplica of this duplicated object. | |
Emigrate
|
Causes this duplicated object to emigrate to the specified station. | |
MigrationInProgress
|
Gets whether this duplicated object is currently migrating. | |
AttemptEmigration
|
Causes this duplicated object to emigrate to the specified station. | |
GetMasterStation
|
Gets the duplicated object handle of the Station object serving as the duplication master of this duplicated object. |
|
GetMasterID
|
Gets the StationID for this duplicated object master station. |
|
IsADuplica
|
Gets whether this duplicated object is a duplica. | |
IsADuplicationMaster
|
Gets whether this duplicated object is a duplication master. | |
HasAuthority
|
Gets whether this duplicated object has authority. | |
IsAWellKnownDO
|
Gets whether this duplicated object is an instance of a well-known object class. | |
V |
IsACoreDO
|
Gets whether this duplicated object is a CoreDO . |
IsAUserDO
|
Gets whether this duplicated object is a UserDO . |
|
DeleteMainRef
|
Instructs the system to delete the main reference to the duplicated object. | |
MainRefIsDeleted
|
Gets whether the DeleteMainRef function has been called on this object. |
|
Publish
|
Publishes an instance of this duplicated object to the stations in the session. | |
IsPublished
|
Gets whether this object has been published. | |
S |
GetCurrentOperation
|
Gets a pointer to the operation object currently executing on this duplicated object. |
S |
FetchDuplica
|
Fetches a duplica of a duplicated object. |
S |
GetOperationManager
|
Gets a pointer to an OperationManager object. |
S |
Create
|
Creates a local instance of a duplicated object. |
S |
CreateWellKnown
|
Creates the specified well-known object. |
S |
DynamicCast
|
Dynamically casts a pointer to a duplicated object. |
CONFIDENTIAL