C# Class Opc.Ua.Com.Server.ComHdaProxy

A base class for classes that implement an OPC COM specification.
Inheritance: ComProxy
Mostrar archivo Open project: OPCFoundation/UA-.NET Class Usage Examples

Public Methods

Method Description
Cancel ( int cancelId ) : int

Cancels the asynchronous operation.

ComHdaProxy ( ) : System

Initializes a new instance of the ComDaProxy class.

CreateBrowser ( ) : ComHdaBrowser

Creates a new browser.

DeleteAtTime ( System.DateTime timestamps, int serverHandles ) : int[]

Deletes the data at the specified times.

DeleteAtTime ( int transactionId, System.DateTime timestamps, int serverHandles, int &cancelId ) : int[]

Deletes the data at the specified times.

DeleteRaw ( System.DateTime startTime, System.DateTime endTime, int serverHandles ) : int[]

Deletes the raw data.

DeleteRaw ( int transactionId, System.DateTime startTime, System.DateTime endTime, int serverHandles, int &cancelId ) : int[]

Deletes the raw data.

GetItemHandles ( string itemIds, int clientHandles ) : Opc.Ua.Com.Server.HdaItemHandle[]

Creates handles for the items.

GetSupportedAggregates ( ) : List

Gets the supported aggregates.

InsertAnnotations ( int serverHandles, System.DateTime timestamps, Annotation annotations ) : int[]

Inserts the annotations.

InsertAnnotations ( int transactionId, int serverHandles, System.DateTime timestamps, Annotation annotations, int &cancelId ) : int[]

Inserts the annotations.

IsSupportedAttribute ( uint attributeId ) : bool

Determines whether the server supports the specified HDA attribute.

ReadAnnotations ( System.DateTime startTime, System.DateTime endTime, int serverHandles ) : List

Reads the annotations.

ReadAnnotations ( int transactionId, System.DateTime startTime, System.DateTime endTime, int serverHandles, int &cancelId ) : int[]

Reads the annotations.

ReadAtTime ( System.DateTime timestamps, int serverHandles ) : List

Reads the data at the specified times.

ReadAtTime ( int transactionId, System.DateTime timestamps, int serverHandles, int &cancelId ) : int[]

Reads the data at the specified times.

ReadAttributes ( System.DateTime startTime, System.DateTime endTime, int serverHandle, uint attributeIds ) : List

Reads the attributes.

ReadAttributes ( int transactionId, System.DateTime startTime, System.DateTime endTime, int serverHandle, uint attributeIds, int &cancelId ) : int[]

Reads the attributes.

ReadModified ( System.DateTime startTime, System.DateTime endTime, uint numValues, int serverHandles ) : List

Reads the modified data.

ReadModified ( int transactionId, System.DateTime startTime, System.DateTime endTime, uint numValues, int serverHandles, int &cancelId ) : int[]

Reads the modified data.

ReadProcessed ( System.DateTime startTime, System.DateTime endTime, long resampleInterval, int serverHandles, uint aggregateIds ) : List

Reads the processed data.

ReadProcessed ( int transactionId, System.DateTime startTime, System.DateTime endTime, long resampleInterval, int serverHandles, uint aggregateIds, int &cancelId ) : int[]

Reads the processed data.

ReadRaw ( System.DateTime startTime, System.DateTime endTime, uint numValues, bool returnBounds, int serverHandles ) : List

Reads the raw data.

ReadRaw ( int transactionId, System.DateTime startTime, System.DateTime endTime, uint numValues, bool returnBounds, int serverHandles, int &cancelId ) : int[]

Reads the raw data.

ReleaseItemHandles ( int serverHandles ) : int[]

Releases the item handles.

SetCallback ( IComHdaDataCallback callback ) : void

Sets the callback.

UpdateRaw ( PerformUpdateType updateType, int serverHandles, DaValue values ) : int[]

Updates the history.

UpdateRaw ( int transactionId, PerformUpdateType updateType, int serverHandles, DaValue values, int &cancelId ) : int[]

Updates the history.

ValidateItemIds ( string itemIds ) : int[]

Validates the item ids.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

An overrideable version of the Dispose.

OnSessionCreated ( ) : void

Called when a new session is created.

OnSessionReconected ( ) : void

Called when a session is reconnected.

Private Methods

Method Description
CreateReadRequests ( Session session, System.DateTime startTime, System.DateTime endTime, double resampleInterval, int serverHandles, uint aggregateIds, ReadProcessedDetails details ) : List

Creates the read requests.

CreateReadRequests ( Session session, System.DateTime startTime, System.DateTime endTime, int serverHandles, ReadRawModifiedDetails details ) : List

Creates the read requests.

CreateReadRequests ( Session session, System.DateTime startTime, System.DateTime endTime, int serverHandle, uint attributeIds, ReadRawModifiedDetails details ) : List

Creates the read requests.

CreateReadRequests ( Session session, System.DateTime startTime, System.DateTime endTime, uint numValues, bool returnBounds, int serverHandles, ReadRawModifiedDetails details ) : List

Creates the read requests.

CreateReadRequests ( Session session, System.DateTime timestamps, int serverHandles, ReadAtTimeDetails details ) : List

Creates the read requests.

CreateTransaction ( TransationType transationType, int transactionId, ExtensionObject details, List requests, bool asyncReportErrors, int &cancelId ) : int[]

Creates and queues a new transaction.

CreateTransaction ( TransationType transationType, int transactionId, List requests, int &cancelId ) : int[]

Creates and queues a new transaction.

CreateUpdateRequests ( Session session, System.DateTime startTime, System.DateTime endTime, int serverHandles ) : List

Creates the update requests.

CreateUpdateRequests ( Session session, System.DateTime timestamps, int serverHandles ) : List

Creates the update requests.

CreateUpdateRequests ( Session session, PerformUpdateType updateType, int serverHandles, DaValue values ) : List

Creates the update requests.

CreateUpdateRequests ( Session session, int serverHandles, System.DateTime timestamps, Annotation annotations ) : List

Creates the update requests.

DoCancel ( object state ) : void

Executes an asynchronous cancel operation.

DoRead ( object state ) : void

Executes an asynchronous read operation.

DoUpdate ( object state ) : void

Executes an asynchronous update operation.

GetAggregateFunctions ( Session session, NodeId objectId ) : List

Gets the aggregate functions object id.

GetAggregateFunctionsObjectId ( Session session ) : NodeId

Gets the aggregate functions object id.

GetAttributeValue ( Session session, ComNamespaceMapper mapper, uint attributeId, DataValue value ) : DaValue

Converts a UA value to an HDA attribute value.

MapPropertyReadStatusToErrorCode ( StatusCode statusCode ) : int

Converts a StatusCode returned during a Read to an HRESULT.

MapReadStatusToErrorCode ( StatusCode statusCode ) : int

Converts a StatusCode returned during a Read to an HRESULT.

MapUpdateStatusToErrorCode ( StatusCode statusCode ) : int

Converts a StatusCode returned during a HistoryUpdate to an HRESULT.

ProcessReadResults ( Session session, HistoryReadResult result, uint attributeId, List values, List modificationInfos ) : int

Processes the results of a history read operation.

ReadAttributes ( Session session, ExtensionObject extension, List requests, bool releaseContinuationPoints ) : bool

Reads the historical or current value for attributes.

ReadNext ( Session session, ExtensionObject details, List requests, bool releaseContinuationPoints ) : bool

Reads the next batch of values from the server.

SendCallback ( int transactionId, TransationType transactionType, List requests ) : bool

Sends the callback for a read request.

SendCallback ( int transactionId, TransationType transactionType, List requests ) : bool

Sends the callback for a read request.

UpdateAggregateDescriptions ( Session session, List aggregates ) : void

Updates the aggregate descriptions.

UpdateAggregateMappings ( Session session ) : void

Updates the aggregate mappings.

UpdateHistory ( Session session, List requests, bool checkOperationError ) : int[]

Calls the server and updates the history.

Method Details

Cancel() public method

Cancels the asynchronous operation.
public Cancel ( int cancelId ) : int
cancelId int
return int

ComHdaProxy() public method

Initializes a new instance of the ComDaProxy class.
public ComHdaProxy ( ) : System
return System

CreateBrowser() public method

Creates a new browser.
public CreateBrowser ( ) : ComHdaBrowser
return ComHdaBrowser

DeleteAtTime() public method

Deletes the data at the specified times.
public DeleteAtTime ( System.DateTime timestamps, int serverHandles ) : int[]
timestamps System.DateTime
serverHandles int
return int[]

DeleteAtTime() public method

Deletes the data at the specified times.
public DeleteAtTime ( int transactionId, System.DateTime timestamps, int serverHandles, int &cancelId ) : int[]
transactionId int
timestamps System.DateTime
serverHandles int
cancelId int
return int[]

DeleteRaw() public method

Deletes the raw data.
public DeleteRaw ( System.DateTime startTime, System.DateTime endTime, int serverHandles ) : int[]
startTime System.DateTime
endTime System.DateTime
serverHandles int
return int[]

DeleteRaw() public method

Deletes the raw data.
public DeleteRaw ( int transactionId, System.DateTime startTime, System.DateTime endTime, int serverHandles, int &cancelId ) : int[]
transactionId int
startTime System.DateTime
endTime System.DateTime
serverHandles int
cancelId int
return int[]

Dispose() protected method

An overrideable version of the Dispose.
protected Dispose ( bool disposing ) : void
disposing bool
return void

GetItemHandles() public method

Creates handles for the items.
public GetItemHandles ( string itemIds, int clientHandles ) : Opc.Ua.Com.Server.HdaItemHandle[]
itemIds string The item ids.
clientHandles int The client handles.
return Opc.Ua.Com.Server.HdaItemHandle[]

GetSupportedAggregates() public method

Gets the supported aggregates.
public GetSupportedAggregates ( ) : List
return List

InsertAnnotations() public method

Inserts the annotations.
public InsertAnnotations ( int serverHandles, System.DateTime timestamps, Annotation annotations ) : int[]
serverHandles int
timestamps System.DateTime
annotations Annotation
return int[]

InsertAnnotations() public method

Inserts the annotations.
public InsertAnnotations ( int transactionId, int serverHandles, System.DateTime timestamps, Annotation annotations, int &cancelId ) : int[]
transactionId int
serverHandles int
timestamps System.DateTime
annotations Annotation
cancelId int
return int[]

IsSupportedAttribute() public method

Determines whether the server supports the specified HDA attribute.
public IsSupportedAttribute ( uint attributeId ) : bool
attributeId uint The attribute id.
return bool

OnSessionCreated() protected method

Called when a new session is created.
protected OnSessionCreated ( ) : void
return void

OnSessionReconected() protected method

Called when a session is reconnected.
protected OnSessionReconected ( ) : void
return void

ReadAnnotations() public method

Reads the annotations.
public ReadAnnotations ( System.DateTime startTime, System.DateTime endTime, int serverHandles ) : List
startTime System.DateTime
endTime System.DateTime
serverHandles int
return List

ReadAnnotations() public method

Reads the annotations.
public ReadAnnotations ( int transactionId, System.DateTime startTime, System.DateTime endTime, int serverHandles, int &cancelId ) : int[]
transactionId int
startTime System.DateTime
endTime System.DateTime
serverHandles int
cancelId int
return int[]

ReadAtTime() public method

Reads the data at the specified times.
public ReadAtTime ( System.DateTime timestamps, int serverHandles ) : List
timestamps System.DateTime
serverHandles int
return List

ReadAtTime() public method

Reads the data at the specified times.
public ReadAtTime ( int transactionId, System.DateTime timestamps, int serverHandles, int &cancelId ) : int[]
transactionId int
timestamps System.DateTime
serverHandles int
cancelId int
return int[]

ReadAttributes() public method

Reads the attributes.
public ReadAttributes ( System.DateTime startTime, System.DateTime endTime, int serverHandle, uint attributeIds ) : List
startTime System.DateTime
endTime System.DateTime
serverHandle int
attributeIds uint
return List

ReadAttributes() public method

Reads the attributes.
public ReadAttributes ( int transactionId, System.DateTime startTime, System.DateTime endTime, int serverHandle, uint attributeIds, int &cancelId ) : int[]
transactionId int
startTime System.DateTime
endTime System.DateTime
serverHandle int
attributeIds uint
cancelId int
return int[]

ReadModified() public method

Reads the modified data.
public ReadModified ( System.DateTime startTime, System.DateTime endTime, uint numValues, int serverHandles ) : List
startTime System.DateTime
endTime System.DateTime
numValues uint
serverHandles int
return List

ReadModified() public method

Reads the modified data.
public ReadModified ( int transactionId, System.DateTime startTime, System.DateTime endTime, uint numValues, int serverHandles, int &cancelId ) : int[]
transactionId int
startTime System.DateTime
endTime System.DateTime
numValues uint
serverHandles int
cancelId int
return int[]

ReadProcessed() public method

Reads the processed data.
public ReadProcessed ( System.DateTime startTime, System.DateTime endTime, long resampleInterval, int serverHandles, uint aggregateIds ) : List
startTime System.DateTime
endTime System.DateTime
resampleInterval long
serverHandles int
aggregateIds uint
return List

ReadProcessed() public method

Reads the processed data.
public ReadProcessed ( int transactionId, System.DateTime startTime, System.DateTime endTime, long resampleInterval, int serverHandles, uint aggregateIds, int &cancelId ) : int[]
transactionId int
startTime System.DateTime
endTime System.DateTime
resampleInterval long
serverHandles int
aggregateIds uint
cancelId int
return int[]

ReadRaw() public method

Reads the raw data.
public ReadRaw ( System.DateTime startTime, System.DateTime endTime, uint numValues, bool returnBounds, int serverHandles ) : List
startTime System.DateTime The start time.
endTime System.DateTime The end time.
numValues uint The num values.
returnBounds bool if set to true the bounds should be returned.
serverHandles int The server handles.
return List

ReadRaw() public method

Reads the raw data.
public ReadRaw ( int transactionId, System.DateTime startTime, System.DateTime endTime, uint numValues, bool returnBounds, int serverHandles, int &cancelId ) : int[]
transactionId int
startTime System.DateTime
endTime System.DateTime
numValues uint
returnBounds bool
serverHandles int
cancelId int
return int[]

ReleaseItemHandles() public method

Releases the item handles.
public ReleaseItemHandles ( int serverHandles ) : int[]
serverHandles int The server handles.
return int[]

SetCallback() public method

Sets the callback.
public SetCallback ( IComHdaDataCallback callback ) : void
callback IComHdaDataCallback The callback.
return void

UpdateRaw() public method

Updates the history.
public UpdateRaw ( PerformUpdateType updateType, int serverHandles, DaValue values ) : int[]
updateType PerformUpdateType
serverHandles int
values DaValue
return int[]

UpdateRaw() public method

Updates the history.
public UpdateRaw ( int transactionId, PerformUpdateType updateType, int serverHandles, DaValue values, int &cancelId ) : int[]
transactionId int
updateType PerformUpdateType
serverHandles int
values DaValue
cancelId int
return int[]

ValidateItemIds() public method

Validates the item ids.
public ValidateItemIds ( string itemIds ) : int[]
itemIds string The item ids.
return int[]