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

Provides access to a COM DA server.

Inheritance: ComClient

Mostrar archivo Open project: OPCFoundation/UA-.NET Class Usage Examples

Public Methods

Method	Description
CloneClient ( ) : ComDaClient	Creates a new instance of the client with the same configuration.
ComDaClient ( ComDaClientConfiguration configuration ) : System	Initializes a new instance of the ComDaClient class.
CreateBrowser ( string itemId ) : IDaElementBrowser	Creates a browser.
CreateGroup ( int groupId, int samplingInterval, float deadband, int &groupHandle, int &revisedSamplingInterval ) : object	Creates a group.
FindElement ( string itemId ) : DaElement	Finds the branch or item.
FindElementParentId ( string itemId ) : string	Finds the item id for the parent of the element.
FindProperty ( string itemId, int propertyId ) : DaProperty	Finds the property metadata for the specified item id.
GetStatus ( ) : OPCSERVERSTATUS?	Reads the status from the server.
Read ( ReadRequestCollection requests ) : void	Reads the item and property values from the server.
ReadAvailableProperties ( string itemId, bool updateCache ) : DaProperty[]	Read the available non-built in properties from the server.
ReadPropertyValues ( List requests ) : void	Reads the property values and stores the results in the request objects.
RemoveGroup ( int groupHandle ) : void	Removes a group.
Write ( WriteRequestCollection requests ) : void	Writes the item and property values to the server.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	An overrideable version of the Dispose.
OnConnected ( ) : void	Called immediately after connecting to the server.

Private Methods

Method	Description
ChangeBrowsePosition ( OPCBROWSEDIRECTION direction, string name ) : bool	Changes the browse position.
CreateElement ( string itemId, string name, string parentId ) : DaElement	Creates a new element.
CreateEnumerator ( bool branches ) : EnumString	Creates an enumerator for the current browse position.
Da20ReadItemValues ( List requests ) : void	Reads the item values and stores the results in the request object.
Da20WriteItemValues ( List requests ) : void	Writes the item values to servers.
Da30ReadItemValues ( List requests ) : void	Reads the values using the DA3 interfaces.
Da30WriteItemValues ( List requests ) : void	Writes the values using the DA3 interfaces.
FindElement ( string itemId, string name, string parentId ) : DaElement	Finds the element and updates the name if it is not already cached.
GetItemId ( string browseName ) : string	Looks up the item id for the node relative to the current browse position.
GetPropertyItemIds ( string itemId, DaProperty properties ) : void	Gets the property item ids.
ReadPropertyValues ( string itemId ) : DaValue[]	Reads the values of the properties from the server.
SaveElementInCache ( DaElement element ) : void	Saves the element in cache.
UpdateElement ( DaElement element, string name, string parentId ) : void	Updates a element.

Method Details

CloneClient() public method

Creates a new instance of the client with the same configuration.

public CloneClient ( ) : ComDaClient
return	ComDaClient

ComDaClient() public method

Initializes a new instance of the ComDaClient class.

public ComDaClient ( ComDaClientConfiguration configuration ) : System
configuration	ComDaClientConfiguration
return	System

CreateBrowser() public method

Creates a browser.

public CreateBrowser ( string itemId ) : IDaElementBrowser
itemId	string	The item id.
return	IDaElementBrowser

CreateGroup() public method

Creates a group.

public CreateGroup ( int groupId, int samplingInterval, float deadband, int &groupHandle, int &revisedSamplingInterval ) : object
groupId	int
samplingInterval	int
deadband	float
groupHandle	int
revisedSamplingInterval	int
return	object

Dispose() protected method

An overrideable version of the Dispose.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

FindElement() public method

Finds the branch or item.

public FindElement ( string itemId ) : DaElement
itemId	string	The item id.
return	DaElement

FindElementParentId() public method

Finds the item id for the parent of the element.

public FindElementParentId ( string itemId ) : string
itemId	string	The item id.
return	string

FindProperty() public method

Finds the property metadata for the specified item id.

public FindProperty ( string itemId, int propertyId ) : DaProperty
itemId	string	The item id.
propertyId	int	The property id.
return	DaProperty

GetStatus() public method

Reads the status from the server.

public GetStatus ( ) : OPCSERVERSTATUS?
return	OPCSERVERSTATUS?

OnConnected() protected method

Called immediately after connecting to the server.

protected OnConnected ( ) : void
return	void

Read() public method

Reads the item and property values from the server.

public Read ( ReadRequestCollection requests ) : void
requests	ReadRequestCollection	The requests.
return	void

ReadAvailableProperties() public method

Read the available non-built in properties from the server.

public ReadAvailableProperties ( string itemId, bool updateCache ) : DaProperty[]
itemId	string	The item id.
updateCache	bool	if set to true the cache is updated.
return	DaProperty[]

ReadPropertyValues() public method

Reads the property values and stores the results in the request objects.

public ReadPropertyValues ( List requests ) : void
requests	List	The requests.
return	void

RemoveGroup() public method

Removes a group.

public RemoveGroup ( int groupHandle ) : void
groupHandle	int
return	void

Write() public method

Writes the item and property values to the server.

public Write ( WriteRequestCollection requests ) : void
requests	WriteRequestCollection	The requests.
return	void