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

A base class for classes that implement an OPC COM specification.

Inheritance: ComProxy

Afficher le fichier Open project: OPCFoundation/UA-.NET Class Usage Examples

Méthodes publiques

Méthode	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.

Méthodes protégées

Méthode	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

Méthode	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 méthode

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.
Résultat	ComDaGroup

BrowseDown() public méthode

Moves the current browse position down.

public BrowseDown ( string targetName ) : void
targetName	string
Résultat	void

BrowseForElements() public méthode

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.
Résultat	IList

BrowseForItems() public méthode

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.
Résultat	IList

BrowseForNames() public méthode

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.
Résultat	IList

BrowseTo() public méthode

Moves the current browse position to the specified item.

public BrowseTo ( string itemId ) : void
itemId	string
Résultat	void

BrowseUp() public méthode

Moves the current browse position up.

public BrowseUp ( ) : void
Résultat	void

ComDaProxy() public méthode

Initializes a new instance of the ComDaProxy class.

public ComDaProxy ( ) : System
Résultat	System

Dispose() protected méthode

An overrideable version of the Dispose.

protected Dispose ( bool disposing ) : void
disposing	bool
Résultat	void

GetGroupByHandle() public méthode

Gets the group by handle.

public GetGroupByHandle ( int serverHandle ) : ComDaGroup
serverHandle	int	The server handle.
Résultat	ComDaGroup

GetGroupByName() public méthode

Gets the group with the specified name.

public GetGroupByName ( string groupName ) : ComDaGroup
groupName	string	Name of the group.
Résultat	ComDaGroup

GetGroups() public méthode

Returns the current set of groups.

public GetGroups ( ) : Opc.Ua.Com.Server.ComDaGroup[]
Résultat	Opc.Ua.Com.Server.ComDaGroup[]

GetItemId() public méthode

Gets the item id for the specified browse element.

public GetItemId ( string browseName ) : string
browseName	string	The name of the browse element.
Résultat	string

GetItemIds() public méthode

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.
Résultat	IList

GetProperties() public méthode

Gets the properties.

public GetProperties ( ComDaReadPropertiesRequest requests ) : IList
requests	ComDaReadPropertiesRequest	The requests.
Résultat	IList

GetProperties() public méthode

Gets the properties.

public GetProperties ( string itemId ) : IList
itemId	string	The item id.
Résultat	IList

GetPropertyValues() public méthode

Gets the property values.

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

OnSessionCreated() protected méthode

Called when a new session is created.

protected OnSessionCreated ( ) : void
Résultat	void

OnSessionReconected() protected méthode

Called when a session is reconnected.

protected OnSessionReconected ( ) : void
Résultat	void

OnSessionRemoved() protected méthode

Called when a session is removed.

protected OnSessionRemoved ( ) : void
Résultat	void

Read() public méthode

Reads the values for the specified item ids.

public Read ( string itemIds ) : DaValue[]
itemIds	string	The item ids.
Résultat	DaValue[]

RemoveGroup() public méthode

Removes the group.

public RemoveGroup ( ComDaGroup group ) : void
group	ComDaGroup	The group.
Résultat	void

Write() public méthode

Writes the values for the specified item ids.

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