.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.UpdateStructureDataDetails Class Reference

This function inserts, replaces or removes structured history data or annotations into the history database at the specified timestamps for one or more HistoricalDataNodes. More...

Inherits UnifiedAutomation.UaBase.HistoryUpdateDetails.

Public Member Functions

 UpdateStructureDataDetails ()
 The default constructor. More...
 
override void Encode (IEncoder encoder)
 
override void Decode (IDecoder decoder)
 
override bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
override object Clone ()
 
- Public Member Functions inherited from UnifiedAutomation.UaBase.HistoryUpdateDetails
 HistoryUpdateDetails ()
 The default constructor. More...
 

Properties

PerformUpdateType PerformInsertReplace [get, set]
 Determines which action of insert, replace, update, or remove is performed. More...
 
DataValueCollection UpdateValues [get, set]
 New values to be inserted, replaced, or removed. More...
 
override ExpandedNodeId TypeId [get]
 
override ExpandedNodeId BinaryEncodingId [get]
 
override ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.HistoryUpdateDetails
NodeId NodeId [get, set]
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

This function inserts, replaces or removes structured history data or annotations into the history database at the specified timestamps for one or more HistoricalDataNodes.

Structured history data provides metadata describing an entry in the history database. The server shall define what uniqueness means for each structured history data structure type. For example, a server may only allow one annotation per timestamp, which means the timestamp is the unique key for the structure. Another server may allow for multiple annotations to exist per user, so a combination of a username, timestamp, and message may be used as the unique key for the structure. In the following sections the terms “Structured Histroy Data exists” and “at the specificed parameters” means a matching entry has been found at the specified timestamp using the Server’s criteria for uniqueness.

In the case where the Client wishes to replace a parameter that is part of the uniqueness criteria, the resulting StatusCode would be Bad_NoEntryExists. The Client must remove the existing structure and then insert the new structure.

Insert functionality
Setting performInsertReplace = INSERT_1 inserts structured history data, such as annotations, into the history database at the specified parameters for one or more properties of HistoricalDataNodes.

If a structured history data entry already exists at the specified parameters, the StatusCode shall indicate Bad_EntryExists.

Replace functionality
Setting performInsertReplace = REPLACE_2 replaces structured history data such as annotations in the history database at the specified parameters for one or more properties of HistoricalDataNodes.

If a structured history data entry does not already exist at the specified parameters, the StatusCode shall indicate Bad_NoEntryExists.

Update functionality
Setting performInsertReplace = UPDATE_3 inserts or replaces structured history data such as annotations in the history database at the specified parameters for one or more properties of HistoricalDataNodes.

If a structure history data entry already exists at the specified paramters, it is deleted and the value provided by the Client is inserted. If no existing entry exists, the new entry is inserted.

If an existing entry was replaced successfully, the StatusCode shall be Good_EntryReplaced. If a new entry was created, the StatusCode shall be Good_EntryInserted. If the server cannot determine whether it replaced or inserted an entry, the StatusCode shall be Good.

Remove functionality
Setting performInsertReplace = REMOVE_4 removes structured history data such as annotations from the history database at the specified parameters for one or more properties of HistoricalDataNodes.

If a structure history data entry exists at the specified parameters, it is deleted. If structured history data does not already exist at the specified parameters, the StatusCode shall indicate Bad_NoEntryExists.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.UpdateStructureDataDetails.UpdateStructureDataDetails ( )
inline

The default constructor.

Member Function Documentation

override bool UnifiedAutomation.UaBase.UpdateStructureDataDetails.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Reimplemented from UnifiedAutomation.UaBase.HistoryUpdateDetails.

Property Documentation

PerformUpdateType UnifiedAutomation.UaBase.UpdateStructureDataDetails.PerformInsertReplace
getset

Determines which action of insert, replace, update, or remove is performed.

Possible values are INSERT_1, REPLACE_2, UPDATE_3, or REMOVE_4.

DataValueCollection UnifiedAutomation.UaBase.UpdateStructureDataDetails.UpdateValues
getset

New values to be inserted, replaced, or removed.


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