UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.WriteValue Class Reference

List of Nodes and their Attributes to write. More...

Inherits IFormattable, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 WriteValue ()
 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 ()
 
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Returns a System.String that represents this instance. More...
 

Properties

NodeId NodeId [get, set]
 NodeId of the Node that contains the Attributes. More...
 
uint AttributeId [get, set]
 Id of the Attribute. This shall be a valid Attribute id. The IntegerIds for the Attributes are defined in NodeAttributesMask. More...
 
string IndexRange [get, set]
 This parameter is used to identify a single element of an array, or a single range of indexes for arrays. The first element is identified by index 0 (zero). This parameter is not used if the specified Attribute is not an array. However, if the specified Attribute is an array and this parameter is not used, then all elements are to be included in the range. The parameter is null if not used. More...
 
DataValue Value [get, set]
 The Node’s Attribute value. If the indexRange parameter is specified then the Value shall be an array even if only one element is being written. If the SourceTimestamp or the ServerTimestamp is specified, the Server shall use these values. The Server returns a Bad_WriteNotSupported error if it does not support writing of timestamps. A Server shall return a Bad_TypeMismatch error if the data type of the written value is not the same type or subtype as the Attribute’s DataType. Based on the DataType hierarchy, subtypes of the Attribute DataType shall be accepted by the Server. For the Value Attribute the DataType is defined through the DataType Attribute. A ByteString is structurally the same as a one dimensional array of Byte. A Server shall accept a ByteString if an array of Byte is expected. The Server returns a Bad_DataEncodingUnsupported error if it does not support writing of the passed data encoding. More...
 
virtual ExpandedNodeId TypeId [get]
 
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
 
virtual ExpandedNodeId XmlEncodingId [get]
 
 
object UserData [get, set]
 Gets or sets the user data. 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

List of Nodes and their Attributes to write.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.WriteValue.WriteValue ( )
inline

The default constructor.

Member Function Documentation

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

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

Parameters
encodeable
Returns
override string UnifiedAutomation.UaBase.WriteValue.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.
string UnifiedAutomation.UaBase.WriteValue.ToString ( string  format,
IFormatProvider  formatProvider 
)
inline

Returns a System.String that represents this instance.

Parameters
formatThe format.
formatProviderThe format provider.
Returns
A System.String that represents this instance.

Property Documentation

uint UnifiedAutomation.UaBase.WriteValue.AttributeId
getset

Id of the Attribute. This shall be a valid Attribute id. The IntegerIds for the Attributes are defined in NodeAttributesMask.

string UnifiedAutomation.UaBase.WriteValue.IndexRange
getset

This parameter is used to identify a single element of an array, or a single range of indexes for arrays. The first element is identified by index 0 (zero). This parameter is not used if the specified Attribute is not an array. However, if the specified Attribute is an array and this parameter is not used, then all elements are to be included in the range. The parameter is null if not used.

NodeId UnifiedAutomation.UaBase.WriteValue.NodeId
getset

NodeId of the Node that contains the Attributes.

object UnifiedAutomation.UaBase.WriteValue.UserData
getset

Gets or sets the user data.

The user data.

DataValue UnifiedAutomation.UaBase.WriteValue.Value
getset

The Node’s Attribute value. If the indexRange parameter is specified then the Value shall be an array even if only one element is being written. If the SourceTimestamp or the ServerTimestamp is specified, the Server shall use these values. The Server returns a Bad_WriteNotSupported error if it does not support writing of timestamps. A Server shall return a Bad_TypeMismatch error if the data type of the written value is not the same type or subtype as the Attribute’s DataType. Based on the DataType hierarchy, subtypes of the Attribute DataType shall be accepted by the Server. For the Value Attribute the DataType is defined through the DataType Attribute. A ByteString is structurally the same as a one dimensional array of Byte. A Server shall accept a ByteString if an array of Byte is expected. The Server returns a Bad_DataEncodingUnsupported error if it does not support writing of the passed data encoding.


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