.NET Based OPC UA Client/Server SDK  2.6.1.422
UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel Class Reference

Inherits UnifiedAutomation.UaServer.BaseObjectModel.

Public Member Functions

 HistoryServerCapabilitiesModel ()
 Initializes a new instance of the HistoryServerCapabilitiesModel class. More...
 
 HistoryServerCapabilitiesModel (HistoryServerCapabilitiesModel template)
 Initializes a new instance of the HistoryServerCapabilitiesModel 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 ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
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...
 

Properties

bool AccessHistoryDataCapability [get, set]
 Defines if the server supports access to historical data values. More...
 
bool AccessHistoryEventsCapability [get, set]
 Defines if the server supports access to historical Events. More...
 
FolderModel AggregateFunctions [get, set]
 An entry point to browse to all Aggregate capabilities supported by the server for Historical Access. More...
 
bool DeleteAtTimeCapability [get, set]
 Indicates support for the delete raw values capability. More...
 
bool DeleteEventCapability [get, set]
 Indicates support for the deletion of Events capability. More...
 
bool DeleteRawCapability [get, set]
 Indicates support for the delete raw values capability. More...
 
bool InsertAnnotationCapability [get, set]
 Indicates support for Annotations. More...
 
bool InsertDataCapability [get, set]
 Indicates support for the Insert capability. More...
 
bool InsertEventCapability [get, set]
 Indicates support for the Insert capability. More...
 
uint MaxReturnDataValues [get, set]
 Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request. More...
 
uint MaxReturnEventValues [get, set]
 Specifies the maximum number of Events that a server can return for a HistoricalEventNode. More...
 
bool ReplaceDataCapability [get, set]
 Indicates support for the Replace capability. More...
 
bool ReplaceEventCapability [get, set]
 Indicates support for the Replace capability. More...
 
bool UpdateDataCapability [get, set]
 Indicates support for the Update capability. More...
 
bool UpdateEventCapability [get, set]
 Indicates support for the Update capability. 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

The UnifiedAutomation.UaServer.ServerCapabilitiesModel objects for any OPC UA Server supporting Historical Access shall contain a Reference to a HistoryServerCapabilitiesType object.

The content of this UnifiedAutomation.UaServer.BaseObjectModel is already defined by its type definition in Part 5 of the OPC UA Specification.

The object extensions are intended to inform a Client of the general capabilities of the server. They do not guarantee that all capabilities will be available for all Nodes. For example, not all Nodes will support Events, or in the case of an aggregating server where underlying servers may not support Insert or a particular Aggregate. In such cases, the HistoryServerCapabilities Property would indicate the capability is supported, and the server would return appropriate StatusCodes for situations where the capability does not apply.

All UA servers that support Historical access shall include the HistoryServerCapabilities as part of its ServerCapabilities.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.HistoryServerCapabilitiesModel ( )
inline

Initializes a new instance of the HistoryServerCapabilitiesModel class.

UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.HistoryServerCapabilitiesModel ( HistoryServerCapabilitiesModel  template)
inline

Initializes a new instance of the HistoryServerCapabilitiesModel class.

Parameters
templateThe template.

Property Documentation

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.AccessHistoryDataCapability
getset

Defines if the server supports access to historical data values.

A value of True indicates the server supports access to history for HistoricalNodes, a value of False indicates the server does not support access to history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.AccessHistoryEventsCapability
getset

Defines if the server supports access to historical Events.

A value of True indicates the server supports access to history of Events, a value of False indicates the server does not support access to history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

FolderModel UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.AggregateFunctions
getset

An entry point to browse to all Aggregate capabilities supported by the server for Historical Access.

All HistoryAggregates supported by the Server should be able to be browsed starting from this object. Aggregates are defined in Part 13 of the OPC UA Specification. If the Server does not support Aggregates the Folder is left empty.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.DeleteAtTimeCapability
getset

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.DeleteEventCapability
getset

Indicates support for the deletion of Events capability.

A value of True indicates the server supports the capability to delete Events in history. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.DeleteRawCapability
getset

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.InsertAnnotationCapability
getset

Indicates support for Annotations.

A value of True indicates the server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.InsertDataCapability
getset

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.InsertEventCapability
getset

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

uint UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.MaxReturnDataValues
getset

Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

uint UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.MaxReturnEventValues
getset

Specifies the maximum number of Events that a server can return for a HistoricalEventNode.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.ReplaceDataCapability
getset

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.ReplaceEventCapability
getset

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.UpdateDataCapability
getset

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

bool UnifiedAutomation.UaServer.HistoryServerCapabilitiesModel.UpdateEventCapability
getset

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.


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