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

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
AddGroup ( string groupName, bool active, int updateRate, int clientHandle, int timeBias, float deadband, int lcid ) : ComDaGroup	Adds the group.
BrowseDown ( string targetName ) : void	Moves the current browse position down.
BrowseForElements ( string itemId, string continuationPoint, int maxElementsReturned, int elementTypeMask, string nameFilter, string &revisedContinuationPoint ) : IList	Browses the specified item id.
BrowseForItems ( string filter, short dataTypeFilter, int accessRightsFilter ) : IList	Browse for all items below the current branch.
BrowseForNames ( bool isBranch, string filter, short dataTypeFilter, int accessRightsFilter ) : IList	Browses the current branch.
BrowseTo ( string itemId ) : void	Moves the current browse position to the specified item.
BrowseUp ( ) : void	Moves the current browse position up.
ComDaProxy ( ) : System	Initializes a new instance of the ComDaProxy class.
GetGroupByHandle ( int serverHandle ) : ComDaGroup	Gets the group by handle.
GetGroupByName ( string groupName ) : ComDaGroup	Gets the group with the specified name.
GetGroups ( ) : Opc.Ua.Com.Server.ComDaGroup[]	Returns the current set of groups.
GetItemId ( string browseName ) : string	Gets the item id for the specified browse element.
GetItemIds ( string itemId, int propertyIds, string &itemIds ) : IList	Gets the item ids for the properties.
GetProperties ( ComDaReadPropertiesRequest requests ) : IList	Gets the properties.
GetProperties ( string itemId ) : IList	Gets the properties.
GetPropertyValues ( string itemId, int propertyIds ) : DaValue[]	Gets the property values.
Read ( string itemIds ) : DaValue[]	Reads the values for the specified item ids.
RemoveGroup ( ComDaGroup group ) : void	Removes the group.
Write ( string itemIds, DaValue values ) : int[]	Writes the values for the specified 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.
OnSessionRemoved ( ) : void	Called when a session is removed.

Private Methods

Method	Description
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.
MapWriteStatusToErrorCode ( DataValue value, StatusCode statusCode ) : int	Converts a StatusCode returned during a Write to an HRESULT.

Method Details

AddGroup() public method

Adds the group.

public AddGroup ( string groupName, bool active, int updateRate, int clientHandle, int timeBias, float deadband, int lcid ) : ComDaGroup
groupName	string	The group name.
active	bool	if set to true the group is active.
updateRate	int	The update rate.
clientHandle	int	The client handle.
timeBias	int	The time bias.
deadband	float	The deadband.
lcid	int	The lcid.
return	ComDaGroup

BrowseDown() public method

Moves the current browse position down.

public BrowseDown ( string targetName ) : void
targetName	string
return	void

BrowseForElements() public method

Browses the specified item id.

public BrowseForElements ( string itemId, string continuationPoint, int maxElementsReturned, int elementTypeMask, string nameFilter, string &revisedContinuationPoint ) : IList
itemId	string	The item id.
continuationPoint	string	The continuation point.
maxElementsReturned	int	The max elements returned.
elementTypeMask	int	The element type mask.
nameFilter	string	The name filter.
revisedContinuationPoint	string	The revised continuation point.
return	IList

BrowseForItems() public method

Browse for all items below the current branch.

public BrowseForItems ( string filter, short dataTypeFilter, int accessRightsFilter ) : IList
filter	string	The filter.
dataTypeFilter	short	The data type filter.
accessRightsFilter	int	The access rights filter.
return	IList

BrowseForNames() public method

Browses the current branch.

public BrowseForNames ( bool isBranch, string filter, short dataTypeFilter, int accessRightsFilter ) : IList
isBranch	bool	if set to true the return branches.
filter	string	The filter.
dataTypeFilter	short	The data type filter.
accessRightsFilter	int	The access rights filter.
return	IList

BrowseTo() public method

Moves the current browse position to the specified item.

public BrowseTo ( string itemId ) : void
itemId	string
return	void

BrowseUp() public method

Moves the current browse position up.

public BrowseUp ( ) : void
return	void

ComDaProxy() public method

Initializes a new instance of the ComDaProxy class.

public ComDaProxy ( ) : System
return	System

Dispose() protected method

An overrideable version of the Dispose.

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

GetGroupByHandle() public method

Gets the group by handle.

public GetGroupByHandle ( int serverHandle ) : ComDaGroup
serverHandle	int	The server handle.
return	ComDaGroup

GetGroupByName() public method

Gets the group with the specified name.

public GetGroupByName ( string groupName ) : ComDaGroup
groupName	string	Name of the group.
return	ComDaGroup

GetGroups() public method

Returns the current set of groups.

public GetGroups ( ) : Opc.Ua.Com.Server.ComDaGroup[]
return	Opc.Ua.Com.Server.ComDaGroup[]

GetItemId() public method

Gets the item id for the specified browse element.

public GetItemId ( string browseName ) : string
browseName	string	The name of the browse element.
return	string

GetItemIds() public method

Gets the item ids for the properties.

public GetItemIds ( string itemId, int propertyIds, string &itemIds ) : IList
itemId	string	The item id.
propertyIds	int	The property ids.
itemIds	string	The item ids.
return	IList

GetProperties() public method

Gets the properties.

public GetProperties ( ComDaReadPropertiesRequest requests ) : IList
requests	ComDaReadPropertiesRequest	The requests.
return	IList

GetProperties() public method

Gets the properties.

public GetProperties ( string itemId ) : IList
itemId	string	The item id.
return	IList

GetPropertyValues() public method

Gets the property values.

public GetPropertyValues ( string itemId, int propertyIds ) : DaValue[]
itemId	string	The item id.
propertyIds	int	The property ids.
return	DaValue[]

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

OnSessionRemoved() protected method

Called when a session is removed.

protected OnSessionRemoved ( ) : void
return	void

Read() public method

Reads the values for the specified item ids.

public Read ( string itemIds ) : DaValue[]
itemIds	string	The item ids.
return	DaValue[]

RemoveGroup() public method

Removes the group.

public RemoveGroup ( ComDaGroup group ) : void
group	ComDaGroup	The group.
return	void

Write() public method

Writes the values for the specified item ids.

public Write ( string itemIds, DaValue values ) : int[]
itemIds	string	The item ids.
values	DaValue	The values.
return	int[]