C# Class Opc.Ua.Server.SamplingGroupManager

An object that manages the sampling groups for a node manager.

Inheritance: IDisposable

Mostra file Open project: OPCFoundation/UA-.NET Class Usage Examples

Public Methods

Method	Description
ApplyChanges ( ) : void	Applies any pending changes caused by adding,changing or removing monitored items.
CreateMonitoredItem ( OperationContext context, uint subscriptionId, double publishingInterval, TimestampsToReturn timestampsToReturn, uint monitoredItemId, object managerHandle, MonitoredItemCreateRequest itemToCreate, Range range, double minimumSamplingInterval ) : MonitoredItem	Creates a new monitored item and calls StartMonitoring().
Dispose ( ) : void	Frees any unmanaged resources.
ModifyMonitoredItem ( OperationContext context, TimestampsToReturn timestampsToReturn, ISampledDataChangeMonitoredItem monitoredItem, MonitoredItemModifyRequest itemToModify, Range range ) : ServiceResult	Modifies a monitored item and calls ModifyMonitoring().
ModifyMonitoring ( OperationContext context, ISampledDataChangeMonitoredItem monitoredItem ) : void	Changes monitoring attributes the item. It will call the external source to change the monitoring if an external source was provided originally. The changes will not take affect until the ApplyChanges() method is called.
SamplingGroupManager ( IServerInternal server, INodeManager nodeManager, uint maxQueueSize, IEnumerable samplingRates ) : System	Creates a new instance of a sampling group.
Shutdown ( ) : void	Stops all sampling groups and clears all items.
StartMonitoring ( OperationContext context, ISampledDataChangeMonitoredItem monitoredItem ) : void	Starts monitoring the item. It will use the external source for monitoring if the source accepts the item. The changes will not take affect until the ApplyChanges() method is called.
StopMonitoring ( ISampledDataChangeMonitoredItem monitoredItem ) : void	Stops monitoring the item. It will call the external source to stop the monitoring if an external source was provided originally. The changes will not take affect until the ApplyChanges() method is called.

Protected Methods

Method	Description
CreateMonitoredItem ( IServerInternal server, INodeManager nodeManager, object managerHandle, uint subscriptionId, uint id, Session session, ReadValueId itemToMonitor, DiagnosticsMasks diagnosticsMasks, TimestampsToReturn timestampsToReturn, MonitoringMode monitoringMode, uint clientHandle, MonitoringFilter originalFilter, MonitoringFilter filterToUse, Range range, double samplingInterval, uint queueSize, bool discardOldest, double minimumSamplingInterval ) : MonitoredItem	Creates a new monitored item.
Dispose ( bool disposing ) : void	An overrideable version of the Dispose.

Method Details

ApplyChanges() public method

Applies any pending changes caused by adding,changing or removing monitored items.

public ApplyChanges ( ) : void
return	void

CreateMonitoredItem() protected method

Creates a new monitored item.

protected CreateMonitoredItem ( IServerInternal server, INodeManager nodeManager, object managerHandle, uint subscriptionId, uint id, Session session, ReadValueId itemToMonitor, DiagnosticsMasks diagnosticsMasks, TimestampsToReturn timestampsToReturn, MonitoringMode monitoringMode, uint clientHandle, MonitoringFilter originalFilter, MonitoringFilter filterToUse, Range range, double samplingInterval, uint queueSize, bool discardOldest, double minimumSamplingInterval ) : MonitoredItem
server	IServerInternal	The server.
nodeManager	INodeManager	The node manager.
managerHandle	object	The manager handle.
subscriptionId	uint	The subscription id.
id	uint	The id.
session	Session	The session.
itemToMonitor	ReadValueId	The item to monitor.
diagnosticsMasks	DiagnosticsMasks	The diagnostics masks.
timestampsToReturn	TimestampsToReturn	The timestamps to return.
monitoringMode	MonitoringMode	The monitoring mode.
clientHandle	uint	The client handle.
originalFilter	MonitoringFilter	The original filter.
filterToUse	MonitoringFilter	The filter to use.
range	Range	The range.
samplingInterval	double	The sampling interval.
queueSize	uint	Size of the queue.
discardOldest	bool	if set to true [discard oldest].
minimumSamplingInterval	double	The minimum sampling interval.
return	MonitoredItem

CreateMonitoredItem() public method

Creates a new monitored item and calls StartMonitoring().

public CreateMonitoredItem ( OperationContext context, uint subscriptionId, double publishingInterval, TimestampsToReturn timestampsToReturn, uint monitoredItemId, object managerHandle, MonitoredItemCreateRequest itemToCreate, Range range, double minimumSamplingInterval ) : MonitoredItem
context	OperationContext
subscriptionId	uint
publishingInterval	double
timestampsToReturn	TimestampsToReturn
monitoredItemId	uint
managerHandle	object
itemToCreate	MonitoredItemCreateRequest
range	Range
minimumSamplingInterval	double
return	MonitoredItem

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

ModifyMonitoredItem() public method

Modifies a monitored item and calls ModifyMonitoring().

public ModifyMonitoredItem ( OperationContext context, TimestampsToReturn timestampsToReturn, ISampledDataChangeMonitoredItem monitoredItem, MonitoredItemModifyRequest itemToModify, Range range ) : ServiceResult
context	OperationContext
timestampsToReturn	TimestampsToReturn
monitoredItem	ISampledDataChangeMonitoredItem
itemToModify	MonitoredItemModifyRequest
range	Range
return	ServiceResult

ModifyMonitoring() public method

Changes monitoring attributes the item.

It will call the external source to change the monitoring if an external source was provided originally. The changes will not take affect until the ApplyChanges() method is called.

public ModifyMonitoring ( OperationContext context, ISampledDataChangeMonitoredItem monitoredItem ) : void
context	OperationContext
monitoredItem	ISampledDataChangeMonitoredItem
return	void

SamplingGroupManager() public method

Creates a new instance of a sampling group.

public SamplingGroupManager ( IServerInternal server, INodeManager nodeManager, uint maxQueueSize, IEnumerable samplingRates ) : System
server	IServerInternal
nodeManager	INodeManager
maxQueueSize	uint
samplingRates	IEnumerable
return	System

Shutdown() public method

Stops all sampling groups and clears all items.

public Shutdown ( ) : void
return	void

StartMonitoring() public method

Starts monitoring the item.

It will use the external source for monitoring if the source accepts the item. The changes will not take affect until the ApplyChanges() method is called.

public StartMonitoring ( OperationContext context, ISampledDataChangeMonitoredItem monitoredItem ) : void
context	OperationContext
monitoredItem	ISampledDataChangeMonitoredItem
return	void

StopMonitoring() public method

Stops monitoring the item.

It will call the external source to stop the monitoring if an external source was provided originally. The changes will not take affect until the ApplyChanges() method is called.

public StopMonitoring ( ISampledDataChangeMonitoredItem monitoredItem ) : void
monitoredItem	ISampledDataChangeMonitoredItem
return	void