C# Class Opc.Ua.Com.Client.ComHdaClient

Provides access to a COM DA server.

Inheritance: ComClient

ファイルを表示 Open project: OPCFoundation/UA-.NET Class Usage Examples

Public Methods

Method	Description
ComHdaClient ( Opc.Ua.Com.Client.ComHdaClientConfiguration configuration ) : System	Initializes a new instance of the ComHdaClient class.
CreateBrowser ( ) : IOPCHDA_Browser	Creates the browser.
DeleteAtTime ( string itemId, DeleteAtTimeDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode	Updates the history of an item.
DeleteRaw ( string itemId, DeleteRawModifiedDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode	Updates the history of an item.
FindAggregate ( uint aggregateId, ushort namespaceIndex ) : BaseObjectState	Finds the specified aggregate.
FindItemAnnotations ( string itemId, ushort namespaceIndex ) : PropertyState	Finds the item annotations.
FindItemAttribute ( string itemId, uint attributeId, ushort namespaceIndex ) : PropertyState	Finds the UA defined component of the item.
GetHistoryAccessLevel ( ) : byte	Gets the history access level for the HDA server.
GetItems ( ) : Opc.Ua.Com.Client.HdaItem[]	Get handles for the specified items.
GetServerCapabilities ( uint propertyId, object defaultValue ) : object	Gets the server capabilities.
GetStatus ( ) : ServerStatus?	Reads the status from the server.
GetSupportedAggregates ( ushort namespaceIndex ) : Opc.Ua.BaseObjectState[]	Gets the supported aggregates.
GetSupportedAttributes ( ) : Opc.Ua.Com.Client.HdaAttribute[]	Gets the supported attributes.
InsertAnnotations ( string itemId, UpdateDataDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode	Inserts annotations for item.
Read ( HdaReadRequestCollection requests, bool useExistingHandles ) : void	Reads the specified requests.
ReadAnnotationHistory ( HdaHistoryReadAnnotationRequest request ) : Opc.Ua.StatusCode	Reads the raw data history.
ReadAttributeHistory ( HdaHistoryReadAttributeRequest request ) : Opc.Ua.StatusCode	Reads the raw data history.
ReadAttributeValues ( int serverHandle ) : Opc.Ua.Com.Client.HdaAttributeValue[]	Updates the attributes for the items.
ReadAvailableAttributes ( HdaItem item ) : Opc.Ua.Com.Client.HdaAttributeValue[]	Reads the values for all available attributes.
ReadHistory ( HdaHistoryReadAtTimeRequest request ) : Opc.Ua.StatusCode	Reads the data history at specified times.
ReadHistory ( HdaHistoryReadProcessedRequest request ) : Opc.Ua.StatusCode	Reads the processed data history.
ReadHistory ( HdaHistoryReadRawModifiedRequest request ) : Opc.Ua.StatusCode	Reads the raw data history.
ReleaseItemHandles ( ) : int[]	Releases the handles for the items.
ReleaseItemHandles ( HdaItem items ) : void	Releases the handles for the items.
UpdateData ( string itemId, UpdateDataDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode	Updates the history of an item.
UpdateServerMetadata ( ) : void	Updates the server metadata.
ValidateItemIds ( ) : bool[]	Validates the item ids.

Private Methods

Method	Description
ConvertTime ( System.DateTime time ) : OPCHDA_TIME	Converts the DateTime to an OPCHDA_TIME.
DeleteAtTime ( HdaItem item, DateTimeCollection timestamps ) : int[]	Deletes the raw data for an item.
DeleteRaw ( HdaItem item, System.DateTime startTime, System.DateTime endTime ) : Opc.Ua.StatusCode	Deletes the raw data for an item.
GetAnnotationAccessLevel ( ) : byte	Gets the access level for annotations provided by the server.
GetUpdateCapabilities ( ) : OPCHDA_UPDATECAPABILITIES	Gets the update capabilities for the server.
InsertAnnotations ( HdaItem item, DataValueCollection values, int &errors ) : Opc.Ua.StatusCode	Insert annotations.
MapErrorCodeToUpdateStatus ( int error ) : Opc.Ua.StatusCode	Converts a HRESULT returned during a HistoryUpdate to an StatusCode.
ReadAnnotations ( HdaHistoryReadAnnotationRequest request ) : Opc.Ua.StatusCode	Reads the annotation data for an item.
ReadAtTime ( HdaHistoryReadAtTimeRequest request ) : Opc.Ua.StatusCode	Reads the data for an item at the specified times.
ReadAttributes ( HdaHistoryReadAttributeRequest request ) : Opc.Ua.StatusCode	Reads the raw modified data for an item.
ReadModified ( HdaHistoryReadRawModifiedRequest request ) : Opc.Ua.StatusCode	Reads the raw modified data for an item.
ReadProcessed ( HdaHistoryReadProcessedRequest request ) : Opc.Ua.StatusCode	Reads the raw data for an item.
ReadRaw ( HdaHistoryReadRawModifiedRequest request ) : Opc.Ua.StatusCode	Reads the raw data for an item.
UpdateData ( HdaItem item, PerformUpdateType updateType, DataValueCollection values, int &errors ) : Opc.Ua.StatusCode	Update data

Method Details

ComHdaClient() public method

Initializes a new instance of the ComHdaClient class.

public ComHdaClient ( Opc.Ua.Com.Client.ComHdaClientConfiguration configuration ) : System
configuration	Opc.Ua.Com.Client.ComHdaClientConfiguration
return	System

CreateBrowser() public method

Creates the browser.

public CreateBrowser ( ) : IOPCHDA_Browser
return	IOPCHDA_Browser

DeleteAtTime() public method

Updates the history of an item.

public DeleteAtTime ( string itemId, DeleteAtTimeDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode
itemId	string
details	DeleteAtTimeDetails
result	HistoryUpdateResult
return	Opc.Ua.StatusCode

DeleteRaw() public method

Updates the history of an item.

public DeleteRaw ( string itemId, DeleteRawModifiedDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode
itemId	string
details	DeleteRawModifiedDetails
result	HistoryUpdateResult
return	Opc.Ua.StatusCode

FindAggregate() public method

Finds the specified aggregate.

public FindAggregate ( uint aggregateId, ushort namespaceIndex ) : BaseObjectState
aggregateId	uint
namespaceIndex	ushort
return	Opc.Ua.BaseObjectState

FindItemAnnotations() public method

Finds the item annotations.

public FindItemAnnotations ( string itemId, ushort namespaceIndex ) : PropertyState
itemId	string	The item id.
namespaceIndex	ushort	Index of the namespace.
return	PropertyState

FindItemAttribute() public method

Finds the UA defined component of the item.

public FindItemAttribute ( string itemId, uint attributeId, ushort namespaceIndex ) : PropertyState
itemId	string	The item id.
attributeId	uint	The attribute id.
namespaceIndex	ushort	Index of the namespace.
return	PropertyState

GetHistoryAccessLevel() public method

Gets the history access level for the HDA server.

public GetHistoryAccessLevel ( ) : byte
return	byte

GetItems() public method

Get handles for the specified items.

public GetItems ( ) : Opc.Ua.Com.Client.HdaItem[]
return	Opc.Ua.Com.Client.HdaItem[]

GetServerCapabilities() public method

Gets the server capabilities.

public GetServerCapabilities ( uint propertyId, object defaultValue ) : object
propertyId	uint	The property id.
defaultValue	object	The default value.
return	object

GetStatus() public method

Reads the status from the server.

public GetStatus ( ) : ServerStatus?
return	ServerStatus?

GetSupportedAggregates() public method

Gets the supported aggregates.

public GetSupportedAggregates ( ushort namespaceIndex ) : Opc.Ua.BaseObjectState[]
namespaceIndex	ushort
return	Opc.Ua.BaseObjectState[]

GetSupportedAttributes() public method

Gets the supported attributes.

public GetSupportedAttributes ( ) : Opc.Ua.Com.Client.HdaAttribute[]
return	Opc.Ua.Com.Client.HdaAttribute[]

InsertAnnotations() public method

Inserts annotations for item.

public InsertAnnotations ( string itemId, UpdateDataDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode
itemId	string	The item id.
details	UpdateDataDetails	The details.
result	HistoryUpdateResult	The result.
return	Opc.Ua.StatusCode

Read() public method

Reads the specified requests.

public Read ( HdaReadRequestCollection requests, bool useExistingHandles ) : void
requests	HdaReadRequestCollection	The requests.
useExistingHandles	bool	if set to true use the handles specified in the request objects.
return	void

ReadAnnotationHistory() public method

Reads the raw data history.

public ReadAnnotationHistory ( HdaHistoryReadAnnotationRequest request ) : Opc.Ua.StatusCode
request	HdaHistoryReadAnnotationRequest	The request.
return	Opc.Ua.StatusCode

ReadAttributeHistory() public method

Reads the raw data history.

public ReadAttributeHistory ( HdaHistoryReadAttributeRequest request ) : Opc.Ua.StatusCode
request	HdaHistoryReadAttributeRequest	The request.
return	Opc.Ua.StatusCode

ReadAttributeValues() public method

Updates the attributes for the items.

public ReadAttributeValues ( int serverHandle ) : Opc.Ua.Com.Client.HdaAttributeValue[]
serverHandle	int
return	Opc.Ua.Com.Client.HdaAttributeValue[]

ReadAvailableAttributes() public method

Reads the values for all available attributes.

public ReadAvailableAttributes ( HdaItem item ) : Opc.Ua.Com.Client.HdaAttributeValue[]
item	HdaItem	The item.
return	Opc.Ua.Com.Client.HdaAttributeValue[]

ReadHistory() public method

Reads the data history at specified times.

public ReadHistory ( HdaHistoryReadAtTimeRequest request ) : Opc.Ua.StatusCode
request	HdaHistoryReadAtTimeRequest
return	Opc.Ua.StatusCode

ReadHistory() public method

Reads the processed data history.

public ReadHistory ( HdaHistoryReadProcessedRequest request ) : Opc.Ua.StatusCode
request	HdaHistoryReadProcessedRequest
return	Opc.Ua.StatusCode

ReadHistory() public method

Reads the raw data history.

public ReadHistory ( HdaHistoryReadRawModifiedRequest request ) : Opc.Ua.StatusCode
request	HdaHistoryReadRawModifiedRequest	The request.
return	Opc.Ua.StatusCode

ReleaseItemHandles() public method

Releases the handles for the items.

public ReleaseItemHandles ( ) : int[]
return	int[]

ReleaseItemHandles() public method

Releases the handles for the items.

public ReleaseItemHandles ( HdaItem items ) : void
items	HdaItem
return	void

UpdateData() public method

Updates the history of an item.

public UpdateData ( string itemId, UpdateDataDetails details, HistoryUpdateResult result ) : Opc.Ua.StatusCode
itemId	string
details	UpdateDataDetails
result	HistoryUpdateResult
return	Opc.Ua.StatusCode

UpdateServerMetadata() public method

Updates the server metadata.

public UpdateServerMetadata ( ) : void
return	void

ValidateItemIds() public method

Validates the item ids.

public ValidateItemIds ( ) : bool[]
return	bool[]