.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaServer.ServerDiagnosticsModel Class Reference

Defines application specific behavoir for the Server object. More...

Inherits UnifiedAutomation.UaServer.BaseObjectModel.

Public Member Functions

 ServerDiagnosticsModel (ServerManager server)
 Initializes a new instance of the ServerDiagnosticsModel class. More...
 
override ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
 ServerDiagnosticsModel ()
 Initializes a new instance of the ServerDiagnosticsModel class. More...
 
 ServerDiagnosticsModel (ServerDiagnosticsModel template)
 Initializes a new instance of the ServerDiagnosticsModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel
 BaseObjectModel ()
 Initializes a new instance of the BaseObjectModel class. More...
 
 BaseObjectModel (BaseObjectModel template)
 Initializes a new instance of the BaseObjectModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)
 Gets the value associated with the mapping. More...
 
virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 

Static Public Member Functions

static
ServerDiagnosticsSummaryDataType 
GetServerDiagnosticsSummary (ServerDiagnosticsSummaryModel diagnostics)
 Gets the server diagnostics. More...
 

Properties

bool EnabledFlag [get, set]
 Identifies whether or not diagnostic information is collected by the Server. More...
 
SamplingIntervalDiagnosticsDataType[] SamplingIntervalDiagnosticsArray [get, set]
 An array of diagnostic information per sampling rate (see UnifiedAutomation.UaBase.SamplingIntervalDiagnosticsDataType). More...
 
ServerDiagnosticsSummaryModel ServerDiagnosticsSummary [get, set]
 Contains diagnostic summary information for the Server. More...
 
SessionsDiagnosticsSummaryModel SessionsDiagnosticsSummary [get, set]
 Contains diagnostic information per session (see UnifiedAutomation.UaServer.SessionsDiagnosticsSummaryModel). More...
 
SubscriptionDiagnosticsDataType[] SubscriptionDiagnosticsArray [get, set]
 An array of subscription diagnostic information per subscription (see UnifiedAutomation.UaBase.SubscriptionDiagnosticsDataType). More...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 

Detailed Description

Defines application specific behavoir for the Server object.

This ObjectType defines diagnostic information about the OPC UA Server.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.ServerDiagnosticsModel.ServerDiagnosticsModel ( ServerManager  server)
inline

Initializes a new instance of the ServerDiagnosticsModel class.

Parameters
serverThe server.
UnifiedAutomation.UaServer.ServerDiagnosticsModel.ServerDiagnosticsModel ( )
inline

Initializes a new instance of the ServerDiagnosticsModel class.

UnifiedAutomation.UaServer.ServerDiagnosticsModel.ServerDiagnosticsModel ( ServerDiagnosticsModel  template)
inline

Initializes a new instance of the ServerDiagnosticsModel class.

Parameters
templateThe template.

Member Function Documentation

override ModelHandle UnifiedAutomation.UaServer.ServerDiagnosticsModel.GetModelHandle ( StringTable  namespaceUris,
object  instance 
)
inlinevirtual

Gets the metadata handle.

Parameters
namespaceUrisThe namespace uris.
instanceThe instance.
Returns

Reimplemented from UnifiedAutomation.UaServer.ModelControllerBase.

static ServerDiagnosticsSummaryDataType UnifiedAutomation.UaServer.ServerDiagnosticsModel.GetServerDiagnosticsSummary ( ServerDiagnosticsSummaryModel  diagnostics)
inlinestatic

Gets the server diagnostics.

Parameters
diagnosticsThe diagnostics.
Returns

Property Documentation

bool UnifiedAutomation.UaServer.ServerDiagnosticsModel.EnabledFlag
getset

Identifies whether or not diagnostic information is collected by the Server.

It can also be used by a client to enable or disable the collection of diagnostic information of the Server. The following settings of the boolean value apply: TRUE indicates that the Server collects diagnostic information, and setting the value to TRUE leads to re setting and enabling the collection. FALSE indicates that no statistic information is collected, and setting the value to FALSE disables the collection without resetting the statistic values.

Static diagnostic Nodes that always appear in the address space will return Bad_NotReadable when the Value attribute of such a Node is read or subscribed to and diagnostics are turned off. Dynamic diagnostic nodes (such as the Session nodes) will not appear in the address space when diagnostics are turned off.

SamplingIntervalDiagnosticsDataType [] UnifiedAutomation.UaServer.ServerDiagnosticsModel.SamplingIntervalDiagnosticsArray
getset

An array of diagnostic information per sampling rate (see UnifiedAutomation.UaBase.SamplingIntervalDiagnosticsDataType).

There is one entry for each sampling rate currently used by the Server. Its type definition node is the variable type UnifiedAutomation.UaServer.SamplingIntervalDiagnosticsArrayModel, providing a Variable for each entry in the array (see UnifiedAutomation.UaServer.SamplingIntervalDiagnosticsArrayModel ).

The sampling interval diagnostics are only collected by Servers which use a fixed set of sampling intervals. In these cases, length of the array and the set of contained variables will be determined by the Server configuration and the NodeId assigned to a given sampling interval diagnostics variable shall not change as long as the Server configuration does not change. A Server may not expose the SamplingIntervalDiagnosticsArray if it does not use fixed sampling rates.

ServerDiagnosticsSummaryModel UnifiedAutomation.UaServer.ServerDiagnosticsModel.ServerDiagnosticsSummary
getset

Contains diagnostic summary information for the Server.

See UnifiedAutomation.UaBase.ServerDiagnosticsSummaryDataType.

SessionsDiagnosticsSummaryModel UnifiedAutomation.UaServer.ServerDiagnosticsModel.SessionsDiagnosticsSummary
getset

Contains diagnostic information per session (see UnifiedAutomation.UaServer.SessionsDiagnosticsSummaryModel).

SubscriptionDiagnosticsDataType [] UnifiedAutomation.UaServer.ServerDiagnosticsModel.SubscriptionDiagnosticsArray
getset

An array of subscription diagnostic information per subscription (see UnifiedAutomation.UaBase.SubscriptionDiagnosticsDataType).

There is one entry for each notification channel actually established in the Server. Its type definition node is the variable type UnifiedAutomation.UaServer.SubscriptionDiagnosticsArrayModel, providing a variable for each entry in the array (see UnifiedAutomation.UaServer.SubscriptionDiagnosticsArrayModel). Those variables are also used as variables referenced by other variables.


The documentation for this class was generated from the following files: