.NET Based OPC UA Client/Server SDK  3.3.0.530
UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel Class Reference

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

Inherits UnifiedAutomation.UaServer.BaseObjectModel.

Public Member Functions

 SessionDiagnosticsObjectModel (ServerManager server)
 Initializes a new instance of the SessionDiagnosticsObjectModel class. More...
 
override ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
 SessionDiagnosticsObjectModel ()
 Initializes a new instance of the SessionDiagnosticsObjectModel class. More...
 
 SessionDiagnosticsObjectModel (SessionDiagnosticsObjectModel template, DummyArgument dummy=null)
 Initializes a new instance of the SessionDiagnosticsObjectModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel
 BaseObjectModel ()
 Initializes a new instance of the BaseObjectModel class. More...
 
 BaseObjectModel (BaseObjectModel template, DummyArgument dummy=null)
 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...
 
StatusCode GetStatusCode (string propertyName)
 Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.
Parameters
propertyNameThe property name.
Returns
The status code of the property.

 
void SetStatusCode (string propertyName, StatusCode statusCode)
 Sets the status code of the given property. More...
 

Static Public Member Functions

static SessionDiagnosticsDataType GetSessionDiagnostics (SessionDiagnosticsVariableModel diagnostics)
 Gets the session diagnostics. More...
 
static
SessionSecurityDiagnosticsDataType 
GetSessionSecurityDiagnostics (SessionSecurityDiagnosticsModel diagnostics)
 Gets the session diagnostics. More...
 

Properties

SessionDiagnosticsVariableModel SessionDiagnostics [get, set]
 Contains general diagnostic information about the session More...
 
SessionSecurityDiagnosticsModel SessionSecurityDiagnostics [get, set]
 Contains security-related diagnostic information. More...
 
SubscriptionDiagnosticsDataType[] SubscriptionDiagnosticsArray [get, set]
 An array of subscription diagnostic information per opened subscription, (see). 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...
 
- Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool HasStatusCodes [get]
 true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
 

Additional Inherited Members

- Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0
 
- Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
 Raises an property change event. More...
 
void RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
 Called when the value of a property is supposed to be changed. More...
 
bool SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
 Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...
 
- Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler PropertyChanged
 Occurs when a property value changes. More...
 
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...
 
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 
- Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The property change request event. More...
 
- Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 Occurs if the status code of a property was changed. More...
 

Detailed Description

Defines application specific behavior for the Server object.

This object type defines diagnostic information about a session of the OPC UA Server.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.SessionDiagnosticsObjectModel ( ServerManager  server)

Initializes a new instance of the SessionDiagnosticsObjectModel class.

Parameters
serverThe server.
UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.SessionDiagnosticsObjectModel ( )

Initializes a new instance of the SessionDiagnosticsObjectModel class.

UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.SessionDiagnosticsObjectModel ( SessionDiagnosticsObjectModel  template,
DummyArgument  dummy = null 
)

Initializes a new instance of the SessionDiagnosticsObjectModel class.

Parameters
templateThe template.
dummyDummy argument to enable writing own constructors that are called by the generated code.

Member Function Documentation

override ModelHandle UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.GetModelHandle ( StringTable  namespaceUris,
object  instance 
)
virtual

Gets the metadata handle.

Parameters
namespaceUrisThe namespace uris.
instanceThe instance.
Returns

Reimplemented from UnifiedAutomation.UaServer.ModelControllerBase.

static SessionDiagnosticsDataType UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.GetSessionDiagnostics ( SessionDiagnosticsVariableModel  diagnostics)
static

Gets the session diagnostics.

Parameters
diagnosticsThe diagnostics.
Returns
static SessionSecurityDiagnosticsDataType UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.GetSessionSecurityDiagnostics ( SessionSecurityDiagnosticsModel  diagnostics)
static

Gets the session diagnostics.

Parameters
diagnosticsThe diagnostics.
Returns

Property Documentation

SessionDiagnosticsVariableModel UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.SessionDiagnostics
getset

Contains general diagnostic information about the session

SessionSecurityDiagnosticsModel UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.SessionSecurityDiagnostics
getset

Contains security-related diagnostic information.

Because the information of this variable is security-related, it should not be made accessible to all users, but only to authorised users.

SubscriptionDiagnosticsDataType [] UnifiedAutomation.UaServer.SessionDiagnosticsObjectModel.SubscriptionDiagnosticsArray
getset

An array of subscription diagnostic information per opened subscription, (see).

Its type definition node is the variable type UnifiedAutomation.UaServer.SubscriptionDiagnosticsArrayModel providing a variable for each entry in the array.


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