.NET Based OPC UA Client/Server SDK  3.1.0.500
UnifiedAutomation.UaBase.GenericEncodeableObject Class Reference

A value for a generic structured or generic union data type. More...

Inherits UnifiedAutomation.UaBase.EncodeableObject, and IFormattable.

Public Member Functions

 GenericEncodeableObject ()
 Initializes a new instance of the GenericEncodeableObject class. More...
 
 GenericEncodeableObject (GenericDataType dataType)
 Initializes a new instance of the GenericEncodeableObject class. More...
 
override void Encode (IEncoder encoder)
 Encodes the value in the stream. More...
 
override void Decode (IDecoder decoder)
 Decodes the value from a stream. More...
 
override bool IsEqual (IEncodeable encodeable)
 Does a deep comparison of two encodeable objects. More...
 
void SetType (GenericStructureDataType dataType)
 Sets the structured or union data type that describes the value. More...
 
bool TryGetFieldValue (string name, out Variant value)
 Tries to get the value of the field. More...
 
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...
 
- Public Member Functions inherited from UnifiedAutomation.UaBase.EncodeableObject
virtual object Clone ()
 Returns a deep copy of an encodeable object. More...
 

Properties

override ExpandedNodeId TypeId [get]
 The id of the data type node. More...
 
override ExpandedNodeId BinaryEncodingId [get]
 The is of the DefaultBinary encoding node. More...
 
override ExpandedNodeId XmlEncodingId [get]
 The is of the DefaultXML encoding node. More...
 
GenericStructureDataType TypeDefinition [get]
 Gets the structured data type which describes the value. More...
 
uint SwitchValue [get, set]
 Gets or sets the value of the switch field (only valid if the type is a union). More...
 
uint EncodingMask [get, set]
 Gets or sets the encoding mask (only valid if the type is a structure with optional fields). More...
 
Variant this[string name] [get, set]
 Gets or sets the value of a field with the specified field name. More...
 
Variant this[int ii] [get, set]
 Gets or sets the value of a field at the specified index. More...
 
- Properties inherited from UnifiedAutomation.UaBase.EncodeableObject
abstract ExpandedNodeId TypeId [get]
 
abstract ExpandedNodeId BinaryEncodingId [get]
 
abstract 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from UnifiedAutomation.UaBase.EncodeableObject
static StatusCode ApplyDataEncoding (MessageContext context, QualifiedName dataEncoding, ref object value)
 Applies the data encoding to the value. More...
 
static ExtensionObject Encode (MessageContext context, IEncodeable encodeable, bool useXml)
 Encodes the object in XML or Binary More...
 
static XmlString EncodeXml (IEncodeable encodeable, MessageContext context)
 Encodes the object in XML. More...
 
static byte[] EncodeBinary (IEncodeable encodeable, MessageContext context)
 Encodes the object in binary More...
 

Detailed Description

A value for a generic structured or generic union data type.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.GenericEncodeableObject.GenericEncodeableObject ( )
inline

Initializes a new instance of the GenericEncodeableObject class.

UnifiedAutomation.UaBase.GenericEncodeableObject.GenericEncodeableObject ( GenericDataType  dataType)
inline

Initializes a new instance of the GenericEncodeableObject class.

Parameters
dataTypeThe structured data type that describes the value.

Member Function Documentation

override void UnifiedAutomation.UaBase.GenericEncodeableObject.Decode ( IDecoder  decoder)
inlinevirtual

Decodes the value from a stream.

Parameters
decoderThe decoder wrapping the stream.

Reimplemented from UnifiedAutomation.UaBase.EncodeableObject.

override void UnifiedAutomation.UaBase.GenericEncodeableObject.Encode ( IEncoder  encoder)
inlinevirtual

Encodes the value in the stream.

Parameters
encoderThe encoder wrapping the stream.

Reimplemented from UnifiedAutomation.UaBase.EncodeableObject.

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

Does a deep comparison of two encodeable objects.

Parameters
encodeableThe target to compare.
Returns
TRUE if the target is equal; FALSE otherwise.

Reimplemented from UnifiedAutomation.UaBase.EncodeableObject.

void UnifiedAutomation.UaBase.GenericEncodeableObject.SetType ( GenericStructureDataType  dataType)
inline

Sets the structured or union data type that describes the value.

Parameters
dataTypeType of the data.
override string UnifiedAutomation.UaBase.GenericEncodeableObject.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.
string UnifiedAutomation.UaBase.GenericEncodeableObject.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.
bool UnifiedAutomation.UaBase.GenericEncodeableObject.TryGetFieldValue ( string  name,
out Variant  value 
)
inline

Tries to get the value of the field.

Parameters
nameThe name of the field.
valueThe value.
Returns
TRUE if the field exists; FALSE otherwise.

Property Documentation

override ExpandedNodeId UnifiedAutomation.UaBase.GenericEncodeableObject.BinaryEncodingId
get

The is of the DefaultBinary encoding node.

uint UnifiedAutomation.UaBase.GenericEncodeableObject.EncodingMask
getset

Gets or sets the encoding mask (only valid if the type is a structure with optional fields).

The encoding mask (only valid if the type is a structure with optional fields).

Exceptions
System.NotSupportedExceptionOnly Structires with Optional Fields have encoding masks.
uint UnifiedAutomation.UaBase.GenericEncodeableObject.SwitchValue
getset

Gets or sets the value of the switch field (only valid if the type is a union).

The value of the switch field (only valid if the type is a union).

Exceptions
System.NotSupportedExceptionOnly Unions have switch fields.
Variant UnifiedAutomation.UaBase.GenericEncodeableObject.this[int ii]
getset

Gets or sets the value of a field at the specified index.

The field at the specified index.

Parameters
iiThe index of field.
Returns
The value for the field at the specified index.
Variant UnifiedAutomation.UaBase.GenericEncodeableObject.this[string name]
getset

Gets or sets the value of a field with the specified field name.

The value of a field with the specified field name.

Parameters
nameThe name of the field.
Returns
The value of the field.
GenericStructureDataType UnifiedAutomation.UaBase.GenericEncodeableObject.TypeDefinition
get

Gets the structured data type which describes the value.

The structured data type which describes the value.

override ExpandedNodeId UnifiedAutomation.UaBase.GenericEncodeableObject.TypeId
get

The id of the data type node.

override ExpandedNodeId UnifiedAutomation.UaBase.GenericEncodeableObject.XmlEncodingId
get

The is of the DefaultXML encoding node.


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