C# Class Quickstarts.HistoricalAccessServer.HistoricalAccessServerNodeManager

A node manager for a server that exposes several variables.

Inheritance: Opc.Ua.Server.CustomNodeManager2

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

Public Methods

Method	Description
CreateAddressSpace ( IDictionary externalReferences ) : void	Does any initialization required before the address space can be used.
DeleteAddressSpace ( ) : void	Frees any resources allocated for the address space.
HistoricalAccessServerNodeManager ( IServerInternal server, ApplicationConfiguration configuration ) : System	Initializes the node manager.
New ( ISystemContext context, NodeState node ) : Opc.Ua.NodeId	Creates the NodeId for the specified node. This method is called by the NodeState.Create() method which initializes a Node from the type model. During initialization a number of child nodes are created and need to have NodeIds assigned to them. This implementation constructs NodeIds by constructing strings. Other implementations could assign unique integers or Guids and save the new Node in a dictionary for later lookup.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	An overrideable version of the Dispose.
GetManagerHandle ( ServerSystemContext context, Opc.Ua.NodeId nodeId, NodeState>.IDictionary cache ) : NodeHandle	Returns a unique handle for the node.
HistoryDeleteAtTime ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Deletes the data history for one or more nodes.
HistoryDeleteRawModified ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Deletes the data history for one or more nodes.
HistoryReadAtTime ( ServerSystemContext context, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, IList nodesToRead, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Reads the data at the specified time for an item.
HistoryReadProcessed ( ServerSystemContext context, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, IList nodesToRead, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Reads the processed data for an item.
HistoryReadRawModified ( ServerSystemContext context, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, IList nodesToRead, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Reads the raw data for an item.
HistoryReleaseContinuationPoints ( ServerSystemContext context, IList nodesToRead, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Releases the history continuation point.
HistoryUpdateData ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Updates the data history for one or more nodes.
HistoryUpdateStructureData ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void	Updates the data history for one or more nodes.
OnMonitoredItemCreated ( ServerSystemContext context, NodeHandle handle, MonitoredItem monitoredItem ) : void	Called after creating a MonitoredItem.
OnMonitoredItemDeleted ( ServerSystemContext context, NodeHandle handle, MonitoredItem monitoredItem ) : void	Called after deleting a MonitoredItem.
Read ( ServerSystemContext context, IList nodesToRead, IList values, IList errors, List nodesToValidate, NodeState>.IDictionary cache ) : void	Validates the nodes and reads the values from the underlying source.
ReadInitialValue ( ServerSystemContext context, NodeHandle handle, MonitoredItem monitoredItem ) : void	Reads the initial value for a monitored item.
ReviseAggregateFilter ( ServerSystemContext context, NodeHandle handle, double samplingInterval, uint queueSize, ServerAggregateFilter filterToUse ) : Opc.Ua.StatusCode	Revises an aggregate filter (may require knowledge of the variable being used).
ValidateNode ( ServerSystemContext context, NodeHandle handle, NodeState>.IDictionary cache ) : NodeState	Verifies that the specified node exists.

Private Methods

Method	Description
CreateFolderFromResources ( NodeState root, string folderName ) : void	Creates items from embedded resources.
CreateHistoryReadRequest ( ServerSystemContext context, ReadAtTimeDetails details, NodeHandle handle, HistoryReadValueId nodeToRead ) : HistoryReadRequest	Creates a new history request.
CreateHistoryReadRequest ( ServerSystemContext context, ReadProcessedDetails details, NodeHandle handle, HistoryReadValueId nodeToRead, Opc.Ua.NodeId aggregateId ) : HistoryReadRequest	Creates a new history request.
CreateHistoryReadRequest ( ServerSystemContext context, ReadRawModifiedDetails details, NodeHandle handle, HistoryReadValueId nodeToRead ) : HistoryReadRequest	Creates a new history request.
DoSimulation ( object state ) : void	Runs the simulation.
LoadContinuationPoint ( ServerSystemContext context, byte continuationPoint ) : HistoryReadRequest	Loads a history continuation point.
QueueProcessedValues ( ServerSystemContext context, IAggregateCalculator calculator, NumericRange indexRange, Opc.Ua.QualifiedName dataEncoding, bool applyIndexRangeOrEncoding, bool returnPartial, LinkedList values ) : void	Extracts and queues any processed values.
Reload ( ServerSystemContext context, NodeHandle handle ) : ArchiveItemState	Loads the archive item state from the underlying source.
ReviseAggregateConfiguration ( ServerSystemContext context, ArchiveItemState item, AggregateConfiguration configurationToUse ) : void	Revises the aggregate configuration.
RowToDataValue ( ServerSystemContext context, HistoryReadValueId nodeToRead, DataRowView row, bool applyIndexRangeOrEncoding ) : Opc.Ua.DataValue	Creates a new history request.
SaveContinuationPoint ( ServerSystemContext context, HistoryReadRequest request ) : byte[]	Saves a history continuation point.

Method Details

CreateAddressSpace() public method

Does any initialization required before the address space can be used.

public CreateAddressSpace ( IDictionary externalReferences ) : void
externalReferences	IDictionary
return	void

DeleteAddressSpace() public method

Frees any resources allocated for the address space.

public DeleteAddressSpace ( ) : void
return	void

Dispose() protected method

An overrideable version of the Dispose.

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

GetManagerHandle() protected method

Returns a unique handle for the node.

protected GetManagerHandle ( ServerSystemContext context, Opc.Ua.NodeId nodeId, NodeState>.IDictionary cache ) : NodeHandle
context	Opc.Ua.Server.ServerSystemContext
nodeId	Opc.Ua.NodeId
cache	NodeState>.IDictionary
return	Opc.Ua.Server.NodeHandle

HistoricalAccessServerNodeManager() public method

Initializes the node manager.

public HistoricalAccessServerNodeManager ( IServerInternal server, ApplicationConfiguration configuration ) : System
server	IServerInternal
configuration	ApplicationConfiguration
return	System

HistoryDeleteAtTime() protected method

Deletes the data history for one or more nodes.

protected HistoryDeleteAtTime ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
nodesToUpdate	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryDeleteRawModified() protected method

Deletes the data history for one or more nodes.

protected HistoryDeleteRawModified ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
nodesToUpdate	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryReadAtTime() protected method

Reads the data at the specified time for an item.

protected HistoryReadAtTime ( ServerSystemContext context, ReadAtTimeDetails details, TimestampsToReturn timestampsToReturn, IList nodesToRead, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
details	ReadAtTimeDetails
timestampsToReturn	TimestampsToReturn
nodesToRead	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryReadProcessed() protected method

Reads the processed data for an item.

protected HistoryReadProcessed ( ServerSystemContext context, ReadProcessedDetails details, TimestampsToReturn timestampsToReturn, IList nodesToRead, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
details	ReadProcessedDetails
timestampsToReturn	TimestampsToReturn
nodesToRead	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryReadRawModified() protected method

Reads the raw data for an item.

protected HistoryReadRawModified ( ServerSystemContext context, ReadRawModifiedDetails details, TimestampsToReturn timestampsToReturn, IList nodesToRead, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
details	ReadRawModifiedDetails
timestampsToReturn	TimestampsToReturn
nodesToRead	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryReleaseContinuationPoints() protected method

Releases the history continuation point.

protected HistoryReleaseContinuationPoints ( ServerSystemContext context, IList nodesToRead, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
nodesToRead	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryUpdateData() protected method

Updates the data history for one or more nodes.

protected HistoryUpdateData ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
nodesToUpdate	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

HistoryUpdateStructureData() protected method

Updates the data history for one or more nodes.

protected HistoryUpdateStructureData ( ServerSystemContext context, IList nodesToUpdate, IList results, IList errors, List nodesToProcess, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
nodesToUpdate	IList
results	IList
errors	IList
nodesToProcess	List
cache	NodeState>.IDictionary
return	void

New() public method

Creates the NodeId for the specified node.

This method is called by the NodeState.Create() method which initializes a Node from the type model. During initialization a number of child nodes are created and need to have NodeIds assigned to them. This implementation constructs NodeIds by constructing strings. Other implementations could assign unique integers or Guids and save the new Node in a dictionary for later lookup.

public New ( ISystemContext context, NodeState node ) : Opc.Ua.NodeId
context	ISystemContext	The context.
node	NodeState	The node.
return	Opc.Ua.NodeId

OnMonitoredItemCreated() protected method

Called after creating a MonitoredItem.

protected OnMonitoredItemCreated ( ServerSystemContext context, NodeHandle handle, MonitoredItem monitoredItem ) : void
context	Opc.Ua.Server.ServerSystemContext
handle	Opc.Ua.Server.NodeHandle
monitoredItem	Opc.Ua.Server.MonitoredItem
return	void

OnMonitoredItemDeleted() protected method

Called after deleting a MonitoredItem.

protected OnMonitoredItemDeleted ( ServerSystemContext context, NodeHandle handle, MonitoredItem monitoredItem ) : void
context	Opc.Ua.Server.ServerSystemContext
handle	Opc.Ua.Server.NodeHandle
monitoredItem	Opc.Ua.Server.MonitoredItem
return	void

Read() protected method

Validates the nodes and reads the values from the underlying source.

protected Read ( ServerSystemContext context, IList nodesToRead, IList values, IList errors, List nodesToValidate, NodeState>.IDictionary cache ) : void
context	Opc.Ua.Server.ServerSystemContext
nodesToRead	IList
values	IList
errors	IList
nodesToValidate	List
cache	NodeState>.IDictionary
return	void

ReadInitialValue() protected method

Reads the initial value for a monitored item.

protected ReadInitialValue ( ServerSystemContext context, NodeHandle handle, MonitoredItem monitoredItem ) : void
context	Opc.Ua.Server.ServerSystemContext	The context.
handle	Opc.Ua.Server.NodeHandle	The item handle.
monitoredItem	Opc.Ua.Server.MonitoredItem	The monitored item.
return	void

ReviseAggregateFilter() protected method

Revises an aggregate filter (may require knowledge of the variable being used).

protected ReviseAggregateFilter ( ServerSystemContext context, NodeHandle handle, double samplingInterval, uint queueSize, ServerAggregateFilter filterToUse ) : Opc.Ua.StatusCode
context	Opc.Ua.Server.ServerSystemContext	The context.
handle	Opc.Ua.Server.NodeHandle	The handle.
samplingInterval	double	The sampling interval for the monitored item.
queueSize	uint	The queue size for the monitored item.
filterToUse	Opc.Ua.Server.ServerAggregateFilter	The filter to revise.
return	Opc.Ua.StatusCode

ValidateNode() protected method

Verifies that the specified node exists.

protected ValidateNode ( ServerSystemContext context, NodeHandle handle, NodeState>.IDictionary cache ) : NodeState
context	Opc.Ua.Server.ServerSystemContext
handle	Opc.Ua.Server.NodeHandle
cache	NodeState>.IDictionary
return	NodeState