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

Writes objects to a XML stream. More...

Inherits UnifiedAutomation.UaBase.IEncoder, and IDisposable.

Public Member Functions

 XmlEncoder (MessageContext context)
 Initializes the object with default values. More...
 
 XmlEncoder (System.Type systemType, XmlWriter writer, MessageContext context)
 Initializes the object with a system type to encode and a XML writer. More...
 
 XmlEncoder (XmlQualifiedName root, XmlWriter writer, MessageContext context)
 Initializes the object with a system type to encode and a XML writer. More...
 
void SetMappingTables (NamespaceTable namespaceUris, StringTable serverUris)
 Initializes the tables used to map namespace and server uris during encoding. More...
 
void SaveStringTable (string tableName, string elementName, StringTable stringTable)
 Saves a string table from an XML stream. More...
 
void Push (string fieldName, string namespaceUri)
 Writes a start element. More...
 
void Pop ()
 Writes an end element. More...
 
string Close ()
 Completes writing and returns the XML text. 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...
 
void WriteBoolean (string fieldName, bool value)
 Writes a boolean to the stream. More...
 
void WriteSByte (string fieldName, sbyte value)
 Writes a sbyte to the stream. More...
 
void WriteByte (string fieldName, byte value)
 Writes a byte to the stream. More...
 
void WriteInt16 (string fieldName, short value)
 Writes a short to the stream. More...
 
void WriteUInt16 (string fieldName, ushort value)
 Writes a ushort to the stream. More...
 
void WriteInt32 (string fieldName, int value)
 Writes an int to the stream. More...
 
void WriteUInt32 (string fieldName, uint value)
 Writes a uint to the stream. More...
 
void WriteInt64 (string fieldName, long value)
 Writes a long to the stream. More...
 
void WriteUInt64 (string fieldName, ulong value)
 Writes a ulong to the stream. More...
 
void WriteFloat (string fieldName, float value)
 Writes a float to the stream. More...
 
void WriteDouble (string fieldName, double value)
 Writes a double to the stream. More...
 
void WriteString (string fieldName, string value)
 Writes a string to the stream. More...
 
void WriteDateTime (string fieldName, DateTime value)
 Writes a UTC date/time to the stream. More...
 
void WriteGuid (string fieldName, Uuid value)
 Writes a GUID to the stream. More...
 
void WriteGuid (string fieldName, Guid value)
 Writes a GUID to the stream. More...
 
void WriteByteString (string fieldName, byte[] value)
 Writes a byte string to the stream. More...
 
void WriteXmlElement (string fieldName, XmlElement value)
 Writes an XmlElement to the stream. More...
 
void WriteNodeId (string fieldName, NodeId value)
 Writes an NodeId to the stream. More...
 
void WriteExpandedNodeId (string fieldName, ExpandedNodeId value)
 Writes an ExpandedNodeId to the stream. More...
 
void WriteStatusCode (string fieldName, StatusCode value)
 Writes an StatusCode to the stream. More...
 
void WriteDiagnosticInfo (string fieldName, DiagnosticInfo value)
 Writes an DiagnosticInfo to the stream. More...
 
void WriteQualifiedName (string fieldName, QualifiedName value)
 Writes an QualifiedName to the stream. More...
 
void WriteLocalizedText (string fieldName, LocalizedText value)
 Writes an LocalizedText to the stream. More...
 
void WriteVariant (string fieldName, Variant value)
 Writes an Variant array to the stream. More...
 
void WriteDataValue (string fieldName, DataValue value)
 Writes an DataValue array to the stream. More...
 
void WriteExtensionObject (string fieldName, ExtensionObject value)
 Writes an ExtensionObject to the stream. More...
 
void WriteEncodeable (string fieldName, IEncodeable value, System.Type systemType)
 Writes an encodeable object to the stream. More...
 
void WriteEnumerated (string fieldName, Enum value)
 Writes an enumerated value array to the stream. More...
 
void WriteBooleanArray (string fieldName, IList< bool > values)
 Writes a boolean array to the stream. More...
 
void WriteSByteArray (string fieldName, IList< sbyte > values)
 Writes a sbyte array to the stream. More...
 
void WriteByteArray (string fieldName, IList< byte > values)
 Writes a sbyte array to the stream. More...
 
void WriteInt16Array (string fieldName, IList< short > values)
 Writes a short array to the stream. More...
 
void WriteUInt16Array (string fieldName, IList< ushort > values)
 Writes a ushort array to the stream. More...
 
void WriteInt32Array (string fieldName, IList< int > values)
 Writes a int array to the stream. More...
 
void WriteUInt32Array (string fieldName, IList< uint > values)
 Writes a uint array to the stream. More...
 
void WriteInt64Array (string fieldName, IList< long > values)
 Writes a long array to the stream. More...
 
void WriteUInt64Array (string fieldName, IList< ulong > values)
 Writes a ulong array to the stream. More...
 
void WriteFloatArray (string fieldName, IList< float > values)
 Writes a float array to the stream. More...
 
void WriteDoubleArray (string fieldName, IList< double > values)
 Writes a double array to the stream. More...
 
void WriteStringArray (string fieldName, IList< string > values)
 Writes a string array to the stream. More...
 
void WriteDateTimeArray (string fieldName, IList< DateTime > values)
 Writes a UTC date/time array to the stream. More...
 
void WriteGuidArray (string fieldName, IList< Uuid > values)
 Writes a GUID array to the stream. More...
 
void WriteGuidArray (string fieldName, IList< Guid > values)
 Writes a GUID array to the stream. More...
 
void WriteByteStringArray (string fieldName, IList< byte[]> values)
 Writes a byte string array to the stream. More...
 
void WriteXmlElementArray (string fieldName, IList< XmlElement > values)
 Writes an XmlElement array to the stream. More...
 
void WriteNodeIdArray (string fieldName, IList< NodeId > values)
 Writes an NodeId array to the stream. More...
 
void WriteExpandedNodeIdArray (string fieldName, IList< ExpandedNodeId > values)
 Writes an ExpandedNodeId array to the stream. More...
 
void WriteStatusCodeArray (string fieldName, IList< StatusCode > values)
 Writes an StatusCode array to the stream. More...
 
void WriteDiagnosticInfoArray (string fieldName, IList< DiagnosticInfo > values)
 Writes an DiagnosticInfo array to the stream. More...
 
void WriteQualifiedNameArray (string fieldName, IList< QualifiedName > values)
 Writes an QualifiedName array to the stream. More...
 
void WriteLocalizedTextArray (string fieldName, IList< LocalizedText > values)
 Writes an LocalizedText array to the stream. More...
 
void WriteVariantArray (string fieldName, IList< Variant > values)
 Writes an Variant array to the stream. More...
 
void WriteDataValueArray (string fieldName, IList< DataValue > values)
 Writes an DataValue array to the stream. More...
 
void WriteExtensionObjectArray (string fieldName, IList< ExtensionObject > values)
 Writes an extension object array to the stream. More...
 
void WriteEncodeableArray (string fieldName, IList< IEncodeable > values, System.Type systemType)
 Writes an encodeable object array to the stream. More...
 
void WriteEnumeratedArray (string fieldName, Array values, System.Type systemType)
 Writes an enumerated value array to the stream. More...
 
void WriteVariantContents (object value, TypeInfo typeInfo)
 Writes the contents of an Variant to the stream. More...
 
void WriteExtensionObjectBody (object body)
 Writes the body of an ExtensionObject to the stream. More...
 
void WriteObjectArray (string fieldName, IList< object > values)
 Writes an Variant array to 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 encoder. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncoder
EncodingType EncodingType [get]
 The type of encoding being used. More...
 
MessageContext Context [get]
 The message context associated with the encoder. More...
 

Detailed Description

Writes objects to a XML stream.

Constructor & Destructor Documentation

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

Initializes the object with default values.

UnifiedAutomation.UaBase.XmlEncoder.XmlEncoder ( System.Type  systemType,
XmlWriter  writer,
MessageContext  context 
)
inline

Initializes the object with a system type to encode and a XML writer.

UnifiedAutomation.UaBase.XmlEncoder.XmlEncoder ( XmlQualifiedName  root,
XmlWriter  writer,
MessageContext  context 
)
inline

Initializes the object with a system type to encode and a XML writer.

Member Function Documentation

string UnifiedAutomation.UaBase.XmlEncoder.Close ( )
inline

Completes writing and returns the XML text.

void UnifiedAutomation.UaBase.XmlEncoder.Dispose ( )
inline

Frees any unmanaged resources.

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

An overrideable version of the Dispose.

void UnifiedAutomation.UaBase.XmlEncoder.Pop ( )
inline

Writes an end element.

void UnifiedAutomation.UaBase.XmlEncoder.PopNamespace ( )
inline

Pops a namespace from the namespace stack.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.Push ( string  fieldName,
string  namespaceUri 
)
inline

Writes a start element.

Parameters
fieldNameThe name of the element.
namespaceUriThe namespace that qualifies the element name.
void UnifiedAutomation.UaBase.XmlEncoder.PushNamespace ( string  namespaceUri)
inline

Pushes a namespace onto the namespace stack.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.SaveStringTable ( string  tableName,
string  elementName,
StringTable  stringTable 
)
inline

Saves a string table from an XML stream.

Parameters
tableNameName of the table.
elementNameName of the element.
stringTableThe string table.
void UnifiedAutomation.UaBase.XmlEncoder.SetMappingTables ( NamespaceTable  namespaceUris,
StringTable  serverUris 
)
inline

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

Parameters
namespaceUrisThe namespaces URIs referenced by the data being encoded.
serverUrisThe server URIs referenced by the data being encoded.
void UnifiedAutomation.UaBase.XmlEncoder.WriteBoolean ( string  fieldName,
bool  value 
)
inline

Writes a boolean to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteBooleanArray ( string  fieldName,
IList< bool >  values 
)
inline

Writes a boolean array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteByte ( string  fieldName,
byte  value 
)
inline

Writes a byte to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteByteArray ( string  fieldName,
IList< byte >  values 
)
inline

Writes a sbyte array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteByteString ( string  fieldName,
byte[]  value 
)
inline

Writes a byte string to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteByteStringArray ( string  fieldName,
IList< byte[]>  values 
)
inline

Writes a byte string array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDataValue ( string  fieldName,
DataValue  value 
)
inline

Writes an DataValue array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDataValueArray ( string  fieldName,
IList< DataValue values 
)
inline

Writes an DataValue array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDateTime ( string  fieldName,
DateTime  value 
)
inline

Writes a UTC date/time to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDateTimeArray ( string  fieldName,
IList< DateTime values 
)
inline

Writes a UTC date/time array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDiagnosticInfo ( string  fieldName,
DiagnosticInfo  value 
)
inline

Writes an DiagnosticInfo to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDiagnosticInfoArray ( string  fieldName,
IList< DiagnosticInfo values 
)
inline

Writes an DiagnosticInfo array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDouble ( string  fieldName,
double  value 
)
inline

Writes a double to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteDoubleArray ( string  fieldName,
IList< double >  values 
)
inline

Writes a double array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteEncodeable ( string  fieldName,
IEncodeable  value,
System.Type  systemType 
)
inline

Writes an encodeable object to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteEncodeableArray ( string  fieldName,
IList< IEncodeable values,
System.Type  systemType 
)
inline

Writes an encodeable object array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteEnumerated ( string  fieldName,
Enum  value 
)
inline

Writes an enumerated value array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteEnumeratedArray ( string  fieldName,
Array  values,
System.Type  systemType 
)
inline

Writes an enumerated value array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteExpandedNodeId ( string  fieldName,
ExpandedNodeId  value 
)
inline

Writes an ExpandedNodeId to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteExpandedNodeIdArray ( string  fieldName,
IList< ExpandedNodeId values 
)
inline

Writes an ExpandedNodeId array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteExtensionObject ( string  fieldName,
ExtensionObject  value 
)
inline

Writes an ExtensionObject to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteExtensionObjectArray ( string  fieldName,
IList< ExtensionObject values 
)
inline

Writes an extension object array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteExtensionObjectBody ( object  body)
inline

Writes the body of an ExtensionObject to the stream.

void UnifiedAutomation.UaBase.XmlEncoder.WriteFloat ( string  fieldName,
float  value 
)
inline

Writes a float to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteFloatArray ( string  fieldName,
IList< float >  values 
)
inline

Writes a float array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteGuid ( string  fieldName,
Uuid  value 
)
inline

Writes a GUID to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteGuid ( string  fieldName,
Guid  value 
)
inline

Writes a GUID to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteGuidArray ( string  fieldName,
IList< Uuid values 
)
inline

Writes a GUID array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteGuidArray ( string  fieldName,
IList< Guid values 
)
inline

Writes a GUID array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteInt16 ( string  fieldName,
short  value 
)
inline

Writes a short to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteInt16Array ( string  fieldName,
IList< short >  values 
)
inline

Writes a short array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteInt32 ( string  fieldName,
int  value 
)
inline

Writes an int to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteInt32Array ( string  fieldName,
IList< int >  values 
)
inline

Writes a int array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteInt64 ( string  fieldName,
long  value 
)
inline

Writes a long to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteInt64Array ( string  fieldName,
IList< long >  values 
)
inline

Writes a long array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteLocalizedText ( string  fieldName,
LocalizedText  value 
)
inline

Writes an LocalizedText to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteLocalizedTextArray ( string  fieldName,
IList< LocalizedText values 
)
inline

Writes an LocalizedText array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteNodeId ( string  fieldName,
NodeId  value 
)
inline

Writes an NodeId to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteNodeIdArray ( string  fieldName,
IList< NodeId values 
)
inline

Writes an NodeId array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteObjectArray ( string  fieldName,
IList< object >  values 
)
inline

Writes an Variant array to the stream.

void UnifiedAutomation.UaBase.XmlEncoder.WriteQualifiedName ( string  fieldName,
QualifiedName  value 
)
inline

Writes an QualifiedName to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteQualifiedNameArray ( string  fieldName,
IList< QualifiedName values 
)
inline

Writes an QualifiedName array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteSByte ( string  fieldName,
sbyte  value 
)
inline

Writes a sbyte to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteSByteArray ( string  fieldName,
IList< sbyte >  values 
)
inline

Writes a sbyte array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteStatusCode ( string  fieldName,
StatusCode  value 
)
inline

Writes an StatusCode to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteStatusCodeArray ( string  fieldName,
IList< StatusCode values 
)
inline

Writes an StatusCode array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteString ( string  fieldName,
string  value 
)
inline

Writes a string to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteStringArray ( string  fieldName,
IList< string >  values 
)
inline

Writes a string array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteUInt16 ( string  fieldName,
ushort  value 
)
inline

Writes a ushort to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteUInt16Array ( string  fieldName,
IList< ushort >  values 
)
inline

Writes a ushort array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteUInt32 ( string  fieldName,
uint  value 
)
inline

Writes a uint to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteUInt32Array ( string  fieldName,
IList< uint >  values 
)
inline

Writes a uint array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteUInt64 ( string  fieldName,
ulong  value 
)
inline

Writes a ulong to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteUInt64Array ( string  fieldName,
IList< ulong >  values 
)
inline

Writes a ulong array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteVariant ( string  fieldName,
Variant  value 
)
inline

Writes an Variant array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteVariantArray ( string  fieldName,
IList< Variant values 
)
inline

Writes an Variant array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteVariantContents ( object  value,
TypeInfo  typeInfo 
)
inline

Writes the contents of an Variant to the stream.

void UnifiedAutomation.UaBase.XmlEncoder.WriteXmlElement ( string  fieldName,
XmlElement  value 
)
inline

Writes an XmlElement to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

void UnifiedAutomation.UaBase.XmlEncoder.WriteXmlElementArray ( string  fieldName,
IList< XmlElement values 
)
inline

Writes an XmlElement array to the stream.

Implements UnifiedAutomation.UaBase.IEncoder.

Property Documentation

MessageContext UnifiedAutomation.UaBase.XmlEncoder.Context
get

The message context associated with the encoder.

EncodingType UnifiedAutomation.UaBase.XmlEncoder.EncodingType
get

The type of encoding being used.


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