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

Reads objects from a XML stream. More...

Inherits UnifiedAutomation.UaBase.IDecoder, and IDisposable.

Public Member Functions

 XmlDecoder (MessageContext context)
 Initializes the object with default values. More...
 
 XmlDecoder (XmlString element, MessageContext context)
 Initializes the object with an XML element to parse. More...
 
 XmlDecoder (System.Type systemType, XmlReader reader, MessageContext context)
 Initializes the object with a XML reader. More...
 
void SetMappingTables (NamespaceTable namespaceUris, StringTable serverUris)
 Initializes the tables used to map namespace and server uris during decoding. More...
 
bool LoadStringTable (string tableName, string elementName, StringTable stringTable)
 Initializes a string table from an XML stream. More...
 
void Close ()
 Closes the stream used for reading. More...
 
void Close (bool checkEof)
 Closes the stream used for reading. More...
 
XmlQualifiedName Peek (XmlNodeType nodeType)
 Returns the qualified name for the next element in the stream. More...
 
bool Peek (string fieldName)
 Returns true if the specified field is the next element to be extracted. More...
 
void ReadStartElement ()
 Returns the qualified name for the next element in the stream. More...
 
void Skip (XmlQualifiedName qname)
 Skips to the end of the specified element. More...
 
object ReadVariantContents (out TypeInfo typeInfo)
 Reads the contents of an Variant object. More...
 
object ReadExtensionObjectBody (ExpandedNodeId typeId)
 Reads the body extension object from the stream. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
void PushNamespace (string namespaceUri)
 Pushes a namespace onto the namespace stack. More...
 
void PopNamespace ()
 Pops a namespace from the namespace stack. More...
 
bool ReadBoolean (string fieldName)
 Reads a boolean from the stream. More...
 
sbyte ReadSByte (string fieldName)
 Reads a sbyte from the stream. More...
 
byte ReadByte (string fieldName)
 Reads a byte from the stream. More...
 
short ReadInt16 (string fieldName)
 Reads a short from the stream. More...
 
ushort ReadUInt16 (string fieldName)
 Reads a ushort from the stream. More...
 
int ReadInt32 (string fieldName)
 Reads an int from the stream. More...
 
uint ReadUInt32 (string fieldName)
 Reads a uint from the stream. More...
 
long ReadInt64 (string fieldName)
 Reads a long from the stream. More...
 
ulong ReadUInt64 (string fieldName)
 Reads a ulong from the stream. More...
 
float ReadFloat (string fieldName)
 Reads a float from the stream. More...
 
double ReadDouble (string fieldName)
 Reads a double from the stream. More...
 
string ReadString (string fieldName)
 Reads a string from the stream. More...
 
DateTime ReadDateTime (string fieldName)
 Reads a UTC date/time from the stream. More...
 
Uuid ReadGuid (string fieldName)
 Reads a GUID from the stream. More...
 
byte[] ReadByteString (string fieldName)
 Reads a byte string from the stream. More...
 
XmlString ReadXmlElement (string fieldName)
 Reads an XmlElement from the stream. More...
 
NodeId ReadNodeId (string fieldName)
 Reads an NodeId from the stream. More...
 
ExpandedNodeId ReadExpandedNodeId (string fieldName)
 Reads an ExpandedNodeId from the stream. More...
 
StatusCode ReadStatusCode (string fieldName)
 Reads an StatusCode from the stream. More...
 
DiagnosticInfo ReadDiagnosticInfo (string fieldName)
 Reads an DiagnosticInfo from the stream. More...
 
DiagnosticInfo ReadDiagnosticInfo ()
 Reads an DiagnosticInfo from the stream. More...
 
QualifiedName ReadQualifiedName (string fieldName)
 Reads an QualifiedName from the stream. More...
 
LocalizedText ReadLocalizedText (string fieldName)
 Reads an LocalizedText from the stream. More...
 
Variant ReadVariant (string fieldName)
 Reads an Variant from the stream. More...
 
DataValue ReadDataValue (string fieldName)
 Reads an DataValue from the stream. More...
 
ExtensionObject ReadExtensionObject (string fieldName)
 Reads an extension object from the stream. More...
 
IEncodeable ReadEncodeable (string fieldName, System.Type systemType)
 Reads an encodeable object from the stream. More...
 
IEncodeable ReadGenericEncodeable (string fieldName, GenericStructureDataType genericType)
 Reads an encodeable object from the stream. More...
 
Enum ReadEnumerated (string fieldName, System.Type enumType)
 Reads an enumerated value from the stream. More...
 
BooleanCollection ReadBooleanArray (string fieldName)
 Reads a boolean array from the stream. More...
 
SByteCollection ReadSByteArray (string fieldName)
 Reads a sbyte array from the stream. More...
 
ByteCollection ReadByteArray (string fieldName)
 Reads a byte array from the stream. More...
 
Int16Collection ReadInt16Array (string fieldName)
 Reads a short array from the stream. More...
 
UInt16Collection ReadUInt16Array (string fieldName)
 Reads a ushort array from the stream. More...
 
Int32Collection ReadInt32Array (string fieldName)
 Reads a int array from the stream. More...
 
UInt32Collection ReadUInt32Array (string fieldName)
 Reads a uint array from the stream. More...
 
Int64Collection ReadInt64Array (string fieldName)
 Reads a long array from the stream. More...
 
UInt64Collection ReadUInt64Array (string fieldName)
 Reads a ulong array from the stream. More...
 
FloatCollection ReadFloatArray (string fieldName)
 Reads a float array from the stream. More...
 
DoubleCollection ReadDoubleArray (string fieldName)
 Reads a double array from the stream. More...
 
StringCollection ReadStringArray (string fieldName)
 Reads a string array from the stream. More...
 
DateTimeCollection ReadDateTimeArray (string fieldName)
 Reads a UTC date/time array from the stream. More...
 
UuidCollection ReadGuidArray (string fieldName)
 Reads a GUID array from the stream. More...
 
ByteStringCollection ReadByteStringArray (string fieldName)
 Reads a byte string array from the stream. More...
 
XmlElementCollection ReadXmlElementArray (string fieldName)
 Reads an XmlElement array from the stream. More...
 
NodeIdCollection ReadNodeIdArray (string fieldName)
 Reads an NodeId array from the stream. More...
 
ExpandedNodeIdCollection ReadExpandedNodeIdArray (string fieldName)
 Reads an ExpandedNodeId array from the stream. More...
 
StatusCodeCollection ReadStatusCodeArray (string fieldName)
 Reads an StatusCode array from the stream. More...
 
DiagnosticInfoCollection ReadDiagnosticInfoArray (string fieldName)
 Reads an DiagnosticInfo array from the stream. More...
 
QualifiedNameCollection ReadQualifiedNameArray (string fieldName)
 Reads an QualifiedName array from the stream. More...
 
LocalizedTextCollection ReadLocalizedTextArray (string fieldName)
 Reads an LocalizedText array from the stream. More...
 
VariantCollection ReadVariantArray (string fieldName)
 Reads an Variant array from the stream. More...
 
DataValueCollection ReadDataValueArray (string fieldName)
 Reads an DataValue array from the stream. More...
 
ExtensionObjectCollection ReadExtensionObjectArray (string fieldName)
 Reads an array of extension objects from the stream. More...
 
Array ReadEncodeableArray (string fieldName, System.Type systemType)
 Reads an encodeable object array from the stream. More...
 
Array ReadGenericEncodeableArray (string fieldName, GenericStructureDataType genericType)
 Reads an encodeable object array from the stream. More...
 
Array ReadEnumeratedArray (string fieldName, System.Type enumType)
 Reads an enumerated value array from the stream. More...
 
void SkipExtensionObject (string fieldName)
 Skips an ExtensionObjectFrom the stream More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 

Properties

EncodingType EncodingType [get]
 The type of encoding being used. More...
 
MessageContext Context [get]
 The message context associated with the decoder. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IDecoder
EncodingType EncodingType [get]
 The type of encoding being used. More...
 
MessageContext Context [get]
 The message context associated with the decoder. More...
 

Detailed Description

Reads objects from a XML stream.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.XmlDecoder.XmlDecoder ( MessageContext  context)
inline

Initializes the object with default values.

UnifiedAutomation.UaBase.XmlDecoder.XmlDecoder ( XmlString  element,
MessageContext  context 
)
inline

Initializes the object with an XML element to parse.

UnifiedAutomation.UaBase.XmlDecoder.XmlDecoder ( System.Type  systemType,
XmlReader  reader,
MessageContext  context 
)
inline

Initializes the object with a XML reader.

Member Function Documentation

void UnifiedAutomation.UaBase.XmlDecoder.Close ( )
inline

Closes the stream used for reading.

void UnifiedAutomation.UaBase.XmlDecoder.Close ( bool  checkEof)
inline

Closes the stream used for reading.

void UnifiedAutomation.UaBase.XmlDecoder.Dispose ( )
inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaBase.XmlDecoder.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

bool UnifiedAutomation.UaBase.XmlDecoder.LoadStringTable ( string  tableName,
string  elementName,
StringTable  stringTable 
)
inline

Initializes a string table from an XML stream.

Parameters
tableNameName of the table.
elementNameName of the element.
stringTableThe string table.
Returns
True if the table was found. False otherwise.
XmlQualifiedName UnifiedAutomation.UaBase.XmlDecoder.Peek ( XmlNodeType  nodeType)
inline

Returns the qualified name for the next element in the stream.

bool UnifiedAutomation.UaBase.XmlDecoder.Peek ( string  fieldName)
inline

Returns true if the specified field is the next element to be extracted.

void UnifiedAutomation.UaBase.XmlDecoder.PopNamespace ( )
inline

Pops a namespace from the namespace stack.

Implements UnifiedAutomation.UaBase.IDecoder.

void UnifiedAutomation.UaBase.XmlDecoder.PushNamespace ( string  namespaceUri)
inline

Pushes a namespace onto the namespace stack.

Implements UnifiedAutomation.UaBase.IDecoder.

bool UnifiedAutomation.UaBase.XmlDecoder.ReadBoolean ( string  fieldName)
inline

Reads a boolean from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

BooleanCollection UnifiedAutomation.UaBase.XmlDecoder.ReadBooleanArray ( string  fieldName)
inline

Reads a boolean array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

byte UnifiedAutomation.UaBase.XmlDecoder.ReadByte ( string  fieldName)
inline

Reads a byte from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ByteCollection UnifiedAutomation.UaBase.XmlDecoder.ReadByteArray ( string  fieldName)
inline

Reads a byte array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

byte [] UnifiedAutomation.UaBase.XmlDecoder.ReadByteString ( string  fieldName)
inline

Reads a byte string from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ByteStringCollection UnifiedAutomation.UaBase.XmlDecoder.ReadByteStringArray ( string  fieldName)
inline

Reads a byte string array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DataValue UnifiedAutomation.UaBase.XmlDecoder.ReadDataValue ( string  fieldName)
inline

Reads an DataValue from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DataValueCollection UnifiedAutomation.UaBase.XmlDecoder.ReadDataValueArray ( string  fieldName)
inline

Reads an DataValue array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DateTime UnifiedAutomation.UaBase.XmlDecoder.ReadDateTime ( string  fieldName)
inline

Reads a UTC date/time from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DateTimeCollection UnifiedAutomation.UaBase.XmlDecoder.ReadDateTimeArray ( string  fieldName)
inline

Reads a UTC date/time array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DiagnosticInfo UnifiedAutomation.UaBase.XmlDecoder.ReadDiagnosticInfo ( string  fieldName)
inline

Reads an DiagnosticInfo from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DiagnosticInfo UnifiedAutomation.UaBase.XmlDecoder.ReadDiagnosticInfo ( )
inline

Reads an DiagnosticInfo from the stream.

DiagnosticInfoCollection UnifiedAutomation.UaBase.XmlDecoder.ReadDiagnosticInfoArray ( string  fieldName)
inline

Reads an DiagnosticInfo array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

double UnifiedAutomation.UaBase.XmlDecoder.ReadDouble ( string  fieldName)
inline

Reads a double from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

DoubleCollection UnifiedAutomation.UaBase.XmlDecoder.ReadDoubleArray ( string  fieldName)
inline

Reads a double array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

IEncodeable UnifiedAutomation.UaBase.XmlDecoder.ReadEncodeable ( string  fieldName,
System.Type  systemType 
)
inline

Reads an encodeable object from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Array UnifiedAutomation.UaBase.XmlDecoder.ReadEncodeableArray ( string  fieldName,
System.Type  systemType 
)
inline

Reads an encodeable object array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Enum UnifiedAutomation.UaBase.XmlDecoder.ReadEnumerated ( string  fieldName,
System.Type  enumType 
)
inline

Reads an enumerated value from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Array UnifiedAutomation.UaBase.XmlDecoder.ReadEnumeratedArray ( string  fieldName,
System.Type  enumType 
)
inline

Reads an enumerated value array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ExpandedNodeId UnifiedAutomation.UaBase.XmlDecoder.ReadExpandedNodeId ( string  fieldName)
inline

Reads an ExpandedNodeId from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ExpandedNodeIdCollection UnifiedAutomation.UaBase.XmlDecoder.ReadExpandedNodeIdArray ( string  fieldName)
inline

Reads an ExpandedNodeId array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ExtensionObject UnifiedAutomation.UaBase.XmlDecoder.ReadExtensionObject ( string  fieldName)
inline

Reads an extension object from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ExtensionObjectCollection UnifiedAutomation.UaBase.XmlDecoder.ReadExtensionObjectArray ( string  fieldName)
inline

Reads an array of extension objects from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

object UnifiedAutomation.UaBase.XmlDecoder.ReadExtensionObjectBody ( ExpandedNodeId  typeId)
inline

Reads the body extension object from the stream.

float UnifiedAutomation.UaBase.XmlDecoder.ReadFloat ( string  fieldName)
inline

Reads a float from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

FloatCollection UnifiedAutomation.UaBase.XmlDecoder.ReadFloatArray ( string  fieldName)
inline

Reads a float array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

IEncodeable UnifiedAutomation.UaBase.XmlDecoder.ReadGenericEncodeable ( string  fieldName,
GenericStructureDataType  genericType 
)
inline

Reads an encodeable object from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Array UnifiedAutomation.UaBase.XmlDecoder.ReadGenericEncodeableArray ( string  fieldName,
GenericStructureDataType  genericType 
)
inline

Reads an encodeable object array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Uuid UnifiedAutomation.UaBase.XmlDecoder.ReadGuid ( string  fieldName)
inline

Reads a GUID from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

UuidCollection UnifiedAutomation.UaBase.XmlDecoder.ReadGuidArray ( string  fieldName)
inline

Reads a GUID array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

short UnifiedAutomation.UaBase.XmlDecoder.ReadInt16 ( string  fieldName)
inline

Reads a short from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Int16Collection UnifiedAutomation.UaBase.XmlDecoder.ReadInt16Array ( string  fieldName)
inline

Reads a short array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

int UnifiedAutomation.UaBase.XmlDecoder.ReadInt32 ( string  fieldName)
inline

Reads an int from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Int32Collection UnifiedAutomation.UaBase.XmlDecoder.ReadInt32Array ( string  fieldName)
inline

Reads a int array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

long UnifiedAutomation.UaBase.XmlDecoder.ReadInt64 ( string  fieldName)
inline

Reads a long from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Int64Collection UnifiedAutomation.UaBase.XmlDecoder.ReadInt64Array ( string  fieldName)
inline

Reads a long array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

LocalizedText UnifiedAutomation.UaBase.XmlDecoder.ReadLocalizedText ( string  fieldName)
inline

Reads an LocalizedText from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

LocalizedTextCollection UnifiedAutomation.UaBase.XmlDecoder.ReadLocalizedTextArray ( string  fieldName)
inline

Reads an LocalizedText array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

NodeId UnifiedAutomation.UaBase.XmlDecoder.ReadNodeId ( string  fieldName)
inline

Reads an NodeId from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

NodeIdCollection UnifiedAutomation.UaBase.XmlDecoder.ReadNodeIdArray ( string  fieldName)
inline

Reads an NodeId array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

QualifiedName UnifiedAutomation.UaBase.XmlDecoder.ReadQualifiedName ( string  fieldName)
inline

Reads an QualifiedName from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

QualifiedNameCollection UnifiedAutomation.UaBase.XmlDecoder.ReadQualifiedNameArray ( string  fieldName)
inline

Reads an QualifiedName array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

sbyte UnifiedAutomation.UaBase.XmlDecoder.ReadSByte ( string  fieldName)
inline

Reads a sbyte from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

SByteCollection UnifiedAutomation.UaBase.XmlDecoder.ReadSByteArray ( string  fieldName)
inline

Reads a sbyte array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

void UnifiedAutomation.UaBase.XmlDecoder.ReadStartElement ( )
inline

Returns the qualified name for the next element in the stream.

StatusCode UnifiedAutomation.UaBase.XmlDecoder.ReadStatusCode ( string  fieldName)
inline

Reads an StatusCode from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

StatusCodeCollection UnifiedAutomation.UaBase.XmlDecoder.ReadStatusCodeArray ( string  fieldName)
inline

Reads an StatusCode array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

string UnifiedAutomation.UaBase.XmlDecoder.ReadString ( string  fieldName)
inline

Reads a string from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

StringCollection UnifiedAutomation.UaBase.XmlDecoder.ReadStringArray ( string  fieldName)
inline

Reads a string array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ushort UnifiedAutomation.UaBase.XmlDecoder.ReadUInt16 ( string  fieldName)
inline

Reads a ushort from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

UInt16Collection UnifiedAutomation.UaBase.XmlDecoder.ReadUInt16Array ( string  fieldName)
inline

Reads a ushort array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

uint UnifiedAutomation.UaBase.XmlDecoder.ReadUInt32 ( string  fieldName)
inline

Reads a uint from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

UInt32Collection UnifiedAutomation.UaBase.XmlDecoder.ReadUInt32Array ( string  fieldName)
inline

Reads a uint array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

ulong UnifiedAutomation.UaBase.XmlDecoder.ReadUInt64 ( string  fieldName)
inline

Reads a ulong from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

UInt64Collection UnifiedAutomation.UaBase.XmlDecoder.ReadUInt64Array ( string  fieldName)
inline

Reads a ulong array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

Variant UnifiedAutomation.UaBase.XmlDecoder.ReadVariant ( string  fieldName)
inline

Reads an Variant from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

VariantCollection UnifiedAutomation.UaBase.XmlDecoder.ReadVariantArray ( string  fieldName)
inline

Reads an Variant array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

object UnifiedAutomation.UaBase.XmlDecoder.ReadVariantContents ( out TypeInfo  typeInfo)
inline

Reads the contents of an Variant object.

Returns
XmlString UnifiedAutomation.UaBase.XmlDecoder.ReadXmlElement ( string  fieldName)
inline

Reads an XmlElement from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

XmlElementCollection UnifiedAutomation.UaBase.XmlDecoder.ReadXmlElementArray ( string  fieldName)
inline

Reads an XmlElement array from the stream.

Implements UnifiedAutomation.UaBase.IDecoder.

void UnifiedAutomation.UaBase.XmlDecoder.SetMappingTables ( NamespaceTable  namespaceUris,
StringTable  serverUris 
)
inline

Initializes the tables used to map namespace and server uris during decoding.

Parameters
namespaceUrisThe namespaces URIs referenced by the data being decoded.
serverUrisThe server URIs referenced by the data being decoded.
void UnifiedAutomation.UaBase.XmlDecoder.Skip ( XmlQualifiedName  qname)
inline

Skips to the end of the specified element.

Parameters
qnameThe qualified name of the element to skip.
void UnifiedAutomation.UaBase.XmlDecoder.SkipExtensionObject ( string  fieldName)
inline

Skips an ExtensionObjectFrom the stream

Parameters
fieldName

Implements UnifiedAutomation.UaBase.IDecoder.

Property Documentation

MessageContext UnifiedAutomation.UaBase.XmlDecoder.Context
get

The message context associated with the decoder.

EncodingType UnifiedAutomation.UaBase.XmlDecoder.EncodingType
get

The type of encoding being used.


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