.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.WriteRequest Class Reference

Asynchronously writes variable values to an OPC UA Server. More...

Inherits UnifiedAutomation.UaBase.IServiceRequest, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 WriteRequest ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 

Properties

RequestHeader RequestHeader [get, set]
 
WriteValueCollection NodesToWrite [get, set]
 List of Nodes and their Attributes to write. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IServiceRequest
RequestHeader RequestHeader [get, set]
 The header for the request. More...
 
- 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

Asynchronously writes variable values to an OPC UA Server.

This service is used to write values to one or more attributes of one or more Nodes. For constructed attribute values whose elements are indexed, such as an array, this service allows Clients to write the entire set of indexed values as a composite, to write individual elements or to write ranges of elements of the composite.

The values are written to the data source, such as a device, and the service does not return until it writes the values or determines that the value cannot be written. In certain cases, the Server will successfully write to an intermediate system or Server, and will not know whether the data source was updated properly. In these cases, the Server should report a success code that indicates that the write was not verified. In the cases where the Server is able to verify that it has successfully written to the data source, it reports an unconditional success.

The order the operations are processed in the Server is not defined and depends on the different data sources and the internal Server logic. If an attribute and node combination is contained in more than one operation, the order of the processing is undefined. If a Client requires sequential processing, the Client needs separate service calls.

It is possible that the Server may successfully write some attributes, but not others. Rollback is the responsibility of the Client.

If a Server allows writing of attributes with the DataType LocalizedText, the Client can add or overwrite the text for a locale by writing the text with the associated LocaleId. Writing a null string for the text for a locale shall delete the String for that locale. Writing a null string for the locale and a non-null string for the text is setting the text for an invariant locale. Writing a null string for the text and a null string for the locale shall delete the entries for all locales. If a Client attempts to write a locale that is either syntactically invalid or not supported, the Server returns Bad_LocaleNotSupported.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.WriteRequest.WriteRequest ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.WriteRequest.IsEqual ( IEncodeable  encodeable)
inlinevirtual

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

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

WriteValueCollection UnifiedAutomation.UaBase.WriteRequest.NodesToWrite
getset

List of Nodes and their Attributes to write.

RequestHeader UnifiedAutomation.UaBase.WriteRequest.RequestHeader
getset


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