Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA Enterprise SCADA High Performance Database (HPDB) API Reference

TABLE OF CONTENTS

RealTimeBaseRecord Class Methods

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL

For a list of all members of this type, see RealTimeBaseRecord members.

Public Methods

 NameDescription
Public MethodAttachInsteadOfLockOverloaded.   
Public MethodBindRecordNumberBinds to a specific record number. If the RealTimeBaseRecord instance is bound to a table then it will check whether the given record number exists in the database or not.  
Public MethodBindTableBinds the RealTimeBaseRecord to the specified table.  
Public MethodCloneInMemoryCopy

Creates a new RealTimeBaseRecord instance based on the current one.

The newly created object will not be connected to the database but instead will be linked to an in-memory copy of the current record.

 
Public Methodstatic (Shared in Visual Basic)CreateInMemoryRecordOverloaded.   
Public MethodCreateLocal Creates the internal local memory for the object. This won't be linked with the RealTime database (RTDB).  
Public MethodDeleteOnUnLock Unlocks the record and deletes it.  
Public MethodDetachInsteadOfUnLock Detaches the internal pointer without unlocking the record.  
Public MethodDisposeOverloaded.   
Public MethodGetPointerToField Retrieves a direct pointer to a specific field.  
Public MethodGetRealTimeType Gets the table structure details.  
Public MethodLockOverloaded.   
Public MethodPublishVirtualFlagsObsolete. Gets and publishes all the virtual flag fields in a CMX record when the flag.cmsg requests for replication. Note that this method is now obsolete. Virtual fields are now automatically published using the CMXVirtualPublication class. THIS ROUTINE IS DEPRECATED. The previous design for virtual field publications required that the user call pub_virtual_flags or pub_virtual in order to manually trigger the publication of a virtual field. This design was error prone as developers often forgot the call or passed in incorrect arguments. The new design involves the use of the CMXVirtualPublication class to register a callback for a virtual field that should be called automatically whenever a triggering field(s) is committed for replication. The CMXVirtualPublication class automatically registers callbacks for all flag virtual fields.  
Public MethodReadBoolOverloaded.   
Public MethodReadByteOverloaded.   
Public MethodReadDoubleOverloaded.   
Public MethodReadFloatOverloaded.   
Public MethodReadIntOverloaded.   
Public MethodReadLongOverloaded.   
Public MethodReadShortOverloaded.   
Public MethodReadStringOverloaded.   
Public MethodReadUIntOverloaded.   
Public MethodReadULongOverloaded.   
Public MethodReadUShortOverloaded.   
Public MethodUnLock Unlocks the record.  
Public MethodWriteBoolOverloaded.   
Public MethodWriteByteOverloaded.   
Public MethodWriteDoubleOverloaded.   
Public MethodWriteFloatOverloaded.   
Public MethodWriteIntOverloaded.   
Public MethodWriteLongOverloaded.   
Public MethodWriteRecordOverloaded.   
Public MethodWriteShortOverloaded.   
Public MethodWriteStringOverloaded.   
Public MethodWriteUIntOverloaded.   
Public MethodWriteULongOverloaded.   
Public MethodWriteUShortOverloaded.   
Top

Protected Methods

 NameDescription
Protected MethodCaptureFieldChangeCaptures a change in a field value by using the OASySDNA.MoC.HPDBChangeTrackerBridge.ChangeTrackerBridge.  
Protected MethodCheckDisposed Checks if the record has been disposed.  
Protected MethodFinalizeDisposes the RealTimeBaseRecord instance.  
Protected MethodInitializeAfterEachRecordUnlock Initializes a class's fields related to a lock operation.  
Protected MethodInitializeOnConstruction Initializes this class.  
Protected MethodInitPublishAndReplicateCMXREP Notifies the Publisher and the Replication server of a data change.  
Protected MethodInitPublishOnlyCMXREP Initializes the Publisher for a data change.  
Protected MethodIsKeyChangedChecks whether the key values between this RealTimeBaseRecord instance and the given instance are the same or different.  
Protected MethodIsLockTypeValid Checks whether the given lock type is valid or not.  
Protected MethodNotifyRecordWrite Notifies PubSub and/or the Replication server of write operations into the record.  
Protected MethodPreUnLockOperation Prepares a record for an unlock operation.  
Protected MethodSetLockType Sets the lock type.  
Protected MethodValidateReadOperationSafe Ensures that a read operation is allowed for this record.  
Protected MethodValidateRecordPointerValid Validates that the pointer to the record can be accessed.  
Protected MethodValidateWriteOperationSafe Ensures that a write operation is allowed for this record.  
Protected MethodWriteSucceededTasks Performs any tasks that are required after a field has been changed.  
Top

See Also

Reference

RealTimeBaseRecord Class
OASySDNA.RealTime.HighPerformanceSetDB Namespace

In This Topic
TitleResults for “How to create a CRG?”Also Available in