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

A class that manages the COM DA groups.

Inheritance: IDisposable

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.
ComDaGroupManager ( ComNamespaceMapper mapper, ComDaBrowseManager browser ) : System	Initializes a new instance of the ComDaGroupManager class.
Dispose ( ) : void	Frees any unmanaged resources.
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.
OnSessionRemoved ( ) : void	Called when a session is removed.
OnSessionReplaced ( ) : void	Called when a session is replaced.
Read ( ReadValueIdCollection valuesToRead ) : DaValue[]	Reads the attribute values from the server.
RecoverSessionContext ( ComDaGroup group ) : void	Recovers the session context.
RemoveGroup ( ComDaGroup group ) : void	Removes the group.
SetGroupName ( ComDaGroup group, string groupName ) : void	Sets the name.
SetLastUpdateTime ( ) : void	Sets the last update time to the current time.
UpdateItemEuInfo ( ComDaGroup group, IList items ) : void	Updates the EUInfo for the items.
ValidateItems ( ComDaGroup group, ComDaCreateItemRequest requests ) : Opc.Ua.Com.Server.ComDaGroupItem[]	Validates the items.
Write ( WriteValueCollection valuesToWrite ) : int[]	Reads the attribute values from the server.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	An overrideable version of the Dispose.

Private Methods

Method	Description
TraceState ( string context ) : void	Dumps the current state of the browser.
ValidateItems ( Session session, ComDaGroup group, ComDaCreateItemRequest requests, Opc.Ua.Com.Server.ComDaGroupItem items, int start, int count ) : void	Validates the items by reading the attributes required to add them to the group.

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

ComDaGroupManager() public method

Initializes a new instance of the ComDaGroupManager class.

public ComDaGroupManager ( ComNamespaceMapper mapper, ComDaBrowseManager browser ) : System
mapper	ComNamespaceMapper	The mapper.
browser	ComDaBrowseManager	The browser.
return	System

Dispose() public method

Frees any unmanaged resources.

public Dispose ( ) : void
return	void

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[]

OnSessionRemoved() public method

Called when a session is removed.

public OnSessionRemoved ( ) : void
return	void

OnSessionReplaced() public method

Called when a session is replaced.

public OnSessionReplaced ( ) : void
return	void

Read() public method

Reads the attribute values from the server.

public Read ( ReadValueIdCollection valuesToRead ) : DaValue[]
valuesToRead	ReadValueIdCollection	The values to read.
return	DaValue[]

RecoverSessionContext() public method

Recovers the session context.

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

RemoveGroup() public method

Removes the group.

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

SetGroupName() public method

Sets the name.

public SetGroupName ( ComDaGroup group, string groupName ) : void
group	ComDaGroup	The group.
groupName	string	Name of the group.
return	void

SetLastUpdateTime() public method

Sets the last update time to the current time.

public SetLastUpdateTime ( ) : void
return	void

UpdateItemEuInfo() public method

Updates the EUInfo for the items.

public UpdateItemEuInfo ( ComDaGroup group, IList items ) : void
group	ComDaGroup	The group.
items	IList	The items. Null entries are ignored.
return	void

ValidateItems() public method

Validates the items.

public ValidateItems ( ComDaGroup group, ComDaCreateItemRequest requests ) : Opc.Ua.Com.Server.ComDaGroupItem[]
group	ComDaGroup	The group.
requests	ComDaCreateItemRequest	The requests.
return	Opc.Ua.Com.Server.ComDaGroupItem[]

Write() public method

Reads the attribute values from the server.

public Write ( WriteValueCollection valuesToWrite ) : int[]
valuesToWrite	WriteValueCollection	The values to write.
return	int[]