C# Class Opc.Ua.XmlEncoder

Writes objects to a XML stream.
Inheritance: IEncoder, IDisposable
ファイルを表示 Open project: OPCFoundation/UA-.NETStandardLibrary Class Usage Examples

Public Methods

Method Description
Close ( ) : string

Completes writing and returns the XML text.

Dispose ( ) : void

Frees any unmanaged resources.

Pop ( ) : void

Writes an end element.

PopNamespace ( ) : void

Pops a namespace from the namespace stack.

Push ( string fieldName, string namespaceUri ) : void

Writes a start element.

PushNamespace ( string namespaceUri ) : void

Pushes a namespace onto the namespace stack.

SaveStringTable ( string tableName, string elementName, StringTable stringTable ) : void

Saves a string table from an XML stream.

SetMappingTables ( Opc.Ua.NamespaceTable namespaceUris, StringTable serverUris ) : void

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

WriteBoolean ( string fieldName, bool value ) : void

Writes a boolean to the stream.

WriteBooleanArray ( string fieldName, IList values ) : void

Writes a boolean array to the stream.

WriteByte ( string fieldName, byte value ) : void

Writes a byte to the stream.

WriteByteArray ( string fieldName, IList values ) : void

Writes a sbyte array to the stream.

WriteByteString ( string fieldName, byte value ) : void

Writes a byte string to the stream.

WriteByteStringArray ( string fieldName, IList values ) : void

Writes a byte string array to the stream.

WriteDataValue ( string fieldName, Opc.Ua.DataValue value ) : void

Writes an DataValue array to the stream.

WriteDataValueArray ( string fieldName, IList values ) : void

Writes an DataValue array to the stream.

WriteDateTime ( string fieldName, System.DateTime value ) : void

Writes a UTC date/time to the stream.

WriteDateTimeArray ( string fieldName, IList values ) : void

Writes a UTC date/time array to the stream.

WriteDiagnosticInfo ( string fieldName, DiagnosticInfo value ) : void

Writes an DiagnosticInfo to the stream.

WriteDiagnosticInfoArray ( string fieldName, IList values ) : void

Writes an DiagnosticInfo array to the stream.

WriteDouble ( string fieldName, double value ) : void

Writes a double to the stream.

WriteDoubleArray ( string fieldName, IList values ) : void

Writes a double array to the stream.

WriteEncodeable ( string fieldName, IEncodeable value, System systemType ) : void

Writes an encodeable object to the stream.

WriteEncodeableArray ( string fieldName, IList values, System systemType ) : void

Writes an encodeable object array to the stream.

WriteEnumerated ( string fieldName, Enum value ) : void

Writes an enumerated value array to the stream.

WriteEnumeratedArray ( string fieldName, Array values, System systemType ) : void

Writes an enumerated value array to the stream.

WriteExpandedNodeId ( string fieldName, Opc.Ua.ExpandedNodeId value ) : void

Writes an ExpandedNodeId to the stream.

WriteExpandedNodeIdArray ( string fieldName, IList values ) : void

Writes an ExpandedNodeId array to the stream.

WriteExtensionObject ( string fieldName, Opc.Ua.ExtensionObject value ) : void

Writes an ExtensionObject to the stream.

WriteExtensionObjectArray ( string fieldName, IList values ) : void

Writes an extension object array to the stream.

WriteExtensionObjectBody ( object body ) : void

Writes the body of an ExtensionObject to the stream.

WriteFloat ( string fieldName, float value ) : void

Writes a float to the stream.

WriteFloatArray ( string fieldName, IList values ) : void

Writes a float array to the stream.

WriteGuid ( string fieldName, System.Guid value ) : void

Writes a GUID to the stream.

WriteGuid ( string fieldName, Uuid value ) : void

Writes a GUID to the stream.

WriteGuidArray ( string fieldName, IList values ) : void

Writes a GUID array to the stream.

WriteGuidArray ( string fieldName, IList values ) : void

Writes a GUID array to the stream.

WriteInt16 ( string fieldName, short value ) : void

Writes a short to the stream.

WriteInt16Array ( string fieldName, IList values ) : void

Writes a short array to the stream.

WriteInt32 ( string fieldName, int value ) : void

Writes an int to the stream.

WriteInt32Array ( string fieldName, IList values ) : void

Writes a int array to the stream.

WriteInt64 ( string fieldName, long value ) : void

Writes a long to the stream.

WriteInt64Array ( string fieldName, IList values ) : void

Writes a long array to the stream.

WriteLocalizedText ( string fieldName, Opc.Ua.LocalizedText value ) : void

Writes an LocalizedText to the stream.

WriteLocalizedTextArray ( string fieldName, IList values ) : void

Writes an LocalizedText array to the stream.

WriteNodeId ( string fieldName, Opc.Ua.NodeId value ) : void

Writes an NodeId to the stream.

WriteNodeIdArray ( string fieldName, IList values ) : void

Writes an NodeId array to the stream.

WriteObjectArray ( string fieldName, IList values ) : void

Writes an Variant array to the stream.

WriteQualifiedName ( string fieldName, Opc.Ua.QualifiedName value ) : void

Writes an QualifiedName to the stream.

WriteQualifiedNameArray ( string fieldName, IList values ) : void

Writes an QualifiedName array to the stream.

WriteSByte ( string fieldName, sbyte value ) : void

Writes a sbyte to the stream.

WriteSByteArray ( string fieldName, IList values ) : void

Writes a sbyte array to the stream.

WriteStatusCode ( string fieldName, Opc.Ua.StatusCode value ) : void

Writes an StatusCode to the stream.

WriteStatusCodeArray ( string fieldName, IList values ) : void

Writes an StatusCode array to the stream.

WriteString ( string fieldName, string value ) : void

Writes a string to the stream.

WriteStringArray ( string fieldName, IList values ) : void

Writes a string array to the stream.

WriteUInt16 ( string fieldName, ushort value ) : void

Writes a ushort to the stream.

WriteUInt16Array ( string fieldName, IList values ) : void

Writes a ushort array to the stream.

WriteUInt32 ( string fieldName, uint value ) : void

Writes a uint to the stream.

WriteUInt32Array ( string fieldName, IList values ) : void

Writes a uint array to the stream.

WriteUInt64 ( string fieldName, ulong value ) : void

Writes a ulong to the stream.

WriteUInt64Array ( string fieldName, IList values ) : void

Writes a ulong array to the stream.

WriteVariant ( string fieldName, Variant value ) : void

Writes an Variant array to the stream.

WriteVariantArray ( string fieldName, IList values ) : void

Writes an Variant array to the stream.

WriteXmlElement ( string fieldName, XmlElement value ) : void

Writes an XmlElement to the stream.

WriteXmlElementArray ( string fieldName, IList values ) : void

Writes an XmlElement array to the stream.

XmlEncoder ( ServiceMessageContext context ) : System

Initializes the object with default values.

XmlEncoder ( System systemType, XmlWriter writer, ServiceMessageContext context ) : System

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

XmlEncoder ( XmlQualifiedName root, XmlWriter writer, ServiceMessageContext context ) : System

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

Protected Methods

Method Description
Dispose ( bool disposing ) : void

An overrideable version of the Dispose.

Private Methods

Method Description
BeginField ( string fieldName, bool isDefault, bool isNillable ) : bool

Writes the start element for a field.

EndField ( string fieldName ) : void

Writes the end element for a field.

Initialize ( ) : void

Sets private members to default values.

Initialize ( string fieldName, string namespaceUri ) : void

Writes the root element to the stream.

WriteMatrix ( string fieldName, System.Matrix value ) : void

Writes an DataValue array to the stream.

WriteVariantContents ( object value, TypeInfo typeInfo ) : void

Method Details

Close() public method

Completes writing and returns the XML text.
public Close ( ) : string
return string

Dispose() public method

Frees any unmanaged resources.
public Dispose ( ) : void
return void

Dispose() protected method

An overrideable version of the Dispose.
protected Dispose ( bool disposing ) : void
disposing bool
return void

Pop() public method

Writes an end element.
public Pop ( ) : void
return void

PopNamespace() public method

Pops a namespace from the namespace stack.
public PopNamespace ( ) : void
return void

Push() public method

Writes a start element.
public Push ( string fieldName, string namespaceUri ) : void
fieldName string The name of the element.
namespaceUri string The namespace that qualifies the element name.
return void

PushNamespace() public method

Pushes a namespace onto the namespace stack.
public PushNamespace ( string namespaceUri ) : void
namespaceUri string
return void

SaveStringTable() public method

Saves a string table from an XML stream.
public SaveStringTable ( string tableName, string elementName, StringTable stringTable ) : void
tableName string Name of the table.
elementName string Name of the element.
stringTable StringTable The string table.
return void

SetMappingTables() public method

Initializes the tables used to map namespace and server uris during encoding.
public SetMappingTables ( Opc.Ua.NamespaceTable namespaceUris, StringTable serverUris ) : void
namespaceUris Opc.Ua.NamespaceTable The namespaces URIs referenced by the data being encoded.
serverUris StringTable The server URIs referenced by the data being encoded.
return void

WriteBoolean() public method

Writes a boolean to the stream.
public WriteBoolean ( string fieldName, bool value ) : void
fieldName string
value bool
return void

WriteBooleanArray() public method

Writes a boolean array to the stream.
public WriteBooleanArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteByte() public method

Writes a byte to the stream.
public WriteByte ( string fieldName, byte value ) : void
fieldName string
value byte
return void

WriteByteArray() public method

Writes a sbyte array to the stream.
public WriteByteArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteByteString() public method

Writes a byte string to the stream.
public WriteByteString ( string fieldName, byte value ) : void
fieldName string
value byte
return void

WriteByteStringArray() public method

Writes a byte string array to the stream.
public WriteByteStringArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteDataValue() public method

Writes an DataValue array to the stream.
public WriteDataValue ( string fieldName, Opc.Ua.DataValue value ) : void
fieldName string
value Opc.Ua.DataValue
return void

WriteDataValueArray() public method

Writes an DataValue array to the stream.
public WriteDataValueArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteDateTime() public method

Writes a UTC date/time to the stream.
public WriteDateTime ( string fieldName, System.DateTime value ) : void
fieldName string
value System.DateTime
return void

WriteDateTimeArray() public method

Writes a UTC date/time array to the stream.
public WriteDateTimeArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteDiagnosticInfo() public method

Writes an DiagnosticInfo to the stream.
public WriteDiagnosticInfo ( string fieldName, DiagnosticInfo value ) : void
fieldName string
value DiagnosticInfo
return void

WriteDiagnosticInfoArray() public method

Writes an DiagnosticInfo array to the stream.
public WriteDiagnosticInfoArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteDouble() public method

Writes a double to the stream.
public WriteDouble ( string fieldName, double value ) : void
fieldName string
value double
return void

WriteDoubleArray() public method

Writes a double array to the stream.
public WriteDoubleArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteEncodeable() public method

Writes an encodeable object to the stream.
public WriteEncodeable ( string fieldName, IEncodeable value, System systemType ) : void
fieldName string
value IEncodeable
systemType System
return void

WriteEncodeableArray() public method

Writes an encodeable object array to the stream.
public WriteEncodeableArray ( string fieldName, IList values, System systemType ) : void
fieldName string
values IList
systemType System
return void

WriteEnumerated() public method

Writes an enumerated value array to the stream.
public WriteEnumerated ( string fieldName, Enum value ) : void
fieldName string
value System.Enum
return void

WriteEnumeratedArray() public method

Writes an enumerated value array to the stream.
public WriteEnumeratedArray ( string fieldName, Array values, System systemType ) : void
fieldName string
values System.Array
systemType System
return void

WriteExpandedNodeId() public method

Writes an ExpandedNodeId to the stream.
public WriteExpandedNodeId ( string fieldName, Opc.Ua.ExpandedNodeId value ) : void
fieldName string
value Opc.Ua.ExpandedNodeId
return void

WriteExpandedNodeIdArray() public method

Writes an ExpandedNodeId array to the stream.
public WriteExpandedNodeIdArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteExtensionObject() public method

Writes an ExtensionObject to the stream.
public WriteExtensionObject ( string fieldName, Opc.Ua.ExtensionObject value ) : void
fieldName string
value Opc.Ua.ExtensionObject
return void

WriteExtensionObjectArray() public method

Writes an extension object array to the stream.
public WriteExtensionObjectArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteExtensionObjectBody() public method

Writes the body of an ExtensionObject to the stream.
public WriteExtensionObjectBody ( object body ) : void
body object
return void

WriteFloat() public method

Writes a float to the stream.
public WriteFloat ( string fieldName, float value ) : void
fieldName string
value float
return void

WriteFloatArray() public method

Writes a float array to the stream.
public WriteFloatArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteGuid() public method

Writes a GUID to the stream.
public WriteGuid ( string fieldName, System.Guid value ) : void
fieldName string
value System.Guid
return void

WriteGuid() public method

Writes a GUID to the stream.
public WriteGuid ( string fieldName, Uuid value ) : void
fieldName string
value Uuid
return void

WriteGuidArray() public method

Writes a GUID array to the stream.
public WriteGuidArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteGuidArray() public method

Writes a GUID array to the stream.
public WriteGuidArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteInt16() public method

Writes a short to the stream.
public WriteInt16 ( string fieldName, short value ) : void
fieldName string
value short
return void

WriteInt16Array() public method

Writes a short array to the stream.
public WriteInt16Array ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteInt32() public method

Writes an int to the stream.
public WriteInt32 ( string fieldName, int value ) : void
fieldName string
value int
return void

WriteInt32Array() public method

Writes a int array to the stream.
public WriteInt32Array ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteInt64() public method

Writes a long to the stream.
public WriteInt64 ( string fieldName, long value ) : void
fieldName string
value long
return void

WriteInt64Array() public method

Writes a long array to the stream.
public WriteInt64Array ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteLocalizedText() public method

Writes an LocalizedText to the stream.
public WriteLocalizedText ( string fieldName, Opc.Ua.LocalizedText value ) : void
fieldName string
value Opc.Ua.LocalizedText
return void

WriteLocalizedTextArray() public method

Writes an LocalizedText array to the stream.
public WriteLocalizedTextArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteNodeId() public method

Writes an NodeId to the stream.
public WriteNodeId ( string fieldName, Opc.Ua.NodeId value ) : void
fieldName string
value Opc.Ua.NodeId
return void

WriteNodeIdArray() public method

Writes an NodeId array to the stream.
public WriteNodeIdArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteObjectArray() public method

Writes an Variant array to the stream.
public WriteObjectArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteQualifiedName() public method

Writes an QualifiedName to the stream.
public WriteQualifiedName ( string fieldName, Opc.Ua.QualifiedName value ) : void
fieldName string
value Opc.Ua.QualifiedName
return void

WriteQualifiedNameArray() public method

Writes an QualifiedName array to the stream.
public WriteQualifiedNameArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteSByte() public method

Writes a sbyte to the stream.
public WriteSByte ( string fieldName, sbyte value ) : void
fieldName string
value sbyte
return void

WriteSByteArray() public method

Writes a sbyte array to the stream.
public WriteSByteArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteStatusCode() public method

Writes an StatusCode to the stream.
public WriteStatusCode ( string fieldName, Opc.Ua.StatusCode value ) : void
fieldName string
value Opc.Ua.StatusCode
return void

WriteStatusCodeArray() public method

Writes an StatusCode array to the stream.
public WriteStatusCodeArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteString() public method

Writes a string to the stream.
public WriteString ( string fieldName, string value ) : void
fieldName string
value string
return void

WriteStringArray() public method

Writes a string array to the stream.
public WriteStringArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteUInt16() public method

Writes a ushort to the stream.
public WriteUInt16 ( string fieldName, ushort value ) : void
fieldName string
value ushort
return void

WriteUInt16Array() public method

Writes a ushort array to the stream.
public WriteUInt16Array ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteUInt32() public method

Writes a uint to the stream.
public WriteUInt32 ( string fieldName, uint value ) : void
fieldName string
value uint
return void

WriteUInt32Array() public method

Writes a uint array to the stream.
public WriteUInt32Array ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteUInt64() public method

Writes a ulong to the stream.
public WriteUInt64 ( string fieldName, ulong value ) : void
fieldName string
value ulong
return void

WriteUInt64Array() public method

Writes a ulong array to the stream.
public WriteUInt64Array ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteVariant() public method

Writes an Variant array to the stream.
public WriteVariant ( string fieldName, Variant value ) : void
fieldName string
value Variant
return void

WriteVariantArray() public method

Writes an Variant array to the stream.
public WriteVariantArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

WriteXmlElement() public method

Writes an XmlElement to the stream.
public WriteXmlElement ( string fieldName, XmlElement value ) : void
fieldName string
value System.Xml.XmlElement
return void

WriteXmlElementArray() public method

Writes an XmlElement array to the stream.
public WriteXmlElementArray ( string fieldName, IList values ) : void
fieldName string
values IList
return void

XmlEncoder() public method

Initializes the object with default values.
public XmlEncoder ( ServiceMessageContext context ) : System
context ServiceMessageContext
return System

XmlEncoder() public method

Initializes the object with a system type to encode and a XML writer.
public XmlEncoder ( System systemType, XmlWriter writer, ServiceMessageContext context ) : System
systemType System
writer System.Xml.XmlWriter
context ServiceMessageContext
return System

XmlEncoder() public method

Initializes the object with a system type to encode and a XML writer.
public XmlEncoder ( XmlQualifiedName root, XmlWriter writer, ServiceMessageContext context ) : System
root System.Xml.XmlQualifiedName
writer System.Xml.XmlWriter
context ServiceMessageContext
return System