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

Identifier for an item to read or to monitor. More...

Inherits IFormattable, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 ReadValueId ()
 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 a Node. 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. If a range of elements is specified, the values are returned as a composite. The first element is identified by index 0 (zero). This parameter is null if the specified Attribute is not an array. However, if the specified Attribute is an array, and this parameter is null, then all elements are to be included in the range. More...
 
QualifiedName DataEncoding [get, set]
 This parameter specifies the BrowseName of the DataTypeEncoding that the Server should use when returning the Value Attribute of a Variable. It is an error to specify this parameter for other Attributes. A Client can discover what DataTypeEncodings are available by following the HasEncoding Reference from the DataType Node for a Variable. OPC UA defines BrowseNames which Servers shall recognize even if the DataType Nodes are not visible in the Server address space. These BrowseNames are: 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

Identifier for an item to read or to monitor.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ReadValueId.ReadValueId ( )
inline

The default constructor.

Member Function Documentation

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

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

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

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.
string UnifiedAutomation.UaBase.ReadValueId.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.ReadValueId.AttributeId
getset

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

QualifiedName UnifiedAutomation.UaBase.ReadValueId.DataEncoding
getset

This parameter specifies the BrowseName of the DataTypeEncoding that the Server should use when returning the Value Attribute of a Variable. It is an error to specify this parameter for other Attributes. A Client can discover what DataTypeEncodings are available by following the HasEncoding Reference from the DataType Node for a Variable. OPC UA defines BrowseNames which Servers shall recognize even if the DataType Nodes are not visible in the Server address space. These BrowseNames are:

DefaultBinaryThe default or native binary (or non-XML) encoding.
DefaultXMLThe default XML encoding.

Each DataType shall support at least one of these encodings. DataTypes that do not have a true binary encoding (e.g. they only have a non-XML text encoding) should use the DefaultBinary name to identify the encoding that is considered to be the default non-XML encoding. DataTypes that support at least one XML-based encoding shall identify one of the encodings as the DefaultXML encoding. Other standards bodies may define other well-known data encodings that could be supported. If this parameter is not specified then the Server shall choose either the DefaultBinary or DefaultXML encoding according to what Message encoding (see Part 6) is used for the Session. If the Server does not support the encoding that matches the Message encoding then the Server shall choose the default encoding that it does support. If this parameter is specified for a MonitoredItem, the Server shall set the StructureChanged bit in the StatusCode (see 7.33) if the DataTypeEncoding changes. The DataTypeEncoding changes if the DataTypeVersion of the DataTypeDescription or the DataTypeDictionary associated with the DataTypeEncoding changes.

string UnifiedAutomation.UaBase.ReadValueId.IndexRange
getset

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

NodeId UnifiedAutomation.UaBase.ReadValueId.NodeId
getset

NodeId of a Node.

object UnifiedAutomation.UaBase.ReadValueId.UserData
getset

Gets or sets the user data.

The user data.


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