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

Wraps a structured data value. More...

Inherits IFormattable, and ICloneable.

Public Member Functions

 ExtensionObject ()
 Initializes a new instance of the ExtensionObject class. More...
 
 ExtensionObject (ExpandedNodeId typeId)
 Initializes a new instance of the ExtensionObject class. More...
 
 ExtensionObject (IEncodeable encodeable)
 Initializes a new instance of the ExtensionObject class. More...
 
 ExtensionObject (ExpandedNodeId typeId, object body)
 Initializes a new instance of the ExtensionObject class. More...
 
object Clone ()
 Creates a deep copy of the object. More...
 
override string ToString ()
 Formats the object as a string. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Formats the object as a string. More...
 
string Format ()
 Formats a node id as a string. More...
 
void Format (StringBuilder buffer)
 Formats the node ids as string and adds it to the buffer. More...
 

Static Public Member Functions

static bool IsNull (ExtensionObject extension)
 Determines whether the specified extension is null. More...
 
static T GetObject< T > (ExtensionObject extension)
 Gets the extension body as the specified type. Null if the body is not of the specified type. More...
 
static T[] GetArray< T > (IEnumerable< ExtensionObject > extensions)
 Converts the extension objects to an array of on null objects of the specified tye. More...
 

Static Public Attributes

static readonly ExtensionObject Empty = new ExtensionObject()
 An ExpandedNodeId that represents a Empty value. More...
 

Properties

ExpandedNodeId TypeId [get, set]
 Gets the type id. More...
 
ExtensionObjectEncoding Encoding [get, set]
 Gets the encoding. More...
 
object Body [get, set]
 Gets the body. More...
 

Detailed Description

Wraps a structured data value.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ExtensionObject.ExtensionObject ( )
inline

Initializes a new instance of the ExtensionObject class.

UnifiedAutomation.UaBase.ExtensionObject.ExtensionObject ( ExpandedNodeId  typeId)
inline

Initializes a new instance of the ExtensionObject class.

Parameters
typeIdThe type id.
UnifiedAutomation.UaBase.ExtensionObject.ExtensionObject ( IEncodeable  encodeable)
inline

Initializes a new instance of the ExtensionObject class.

Parameters
encodeableAn encodeable object.
UnifiedAutomation.UaBase.ExtensionObject.ExtensionObject ( ExpandedNodeId  typeId,
object  body 
)
inline

Initializes a new instance of the ExtensionObject class.

Parameters
typeIdThe type id.
bodyThe body.

Member Function Documentation

object UnifiedAutomation.UaBase.ExtensionObject.Clone ( )
inline

Creates a deep copy of the object.

string UnifiedAutomation.UaBase.ExtensionObject.Format ( )
inline

Formats a node id as a string.

void UnifiedAutomation.UaBase.ExtensionObject.Format ( StringBuilder  buffer)
inline

Formats the node ids as string and adds it to the buffer.

Parameters
bufferThe buffer.
static T [] UnifiedAutomation.UaBase.ExtensionObject.GetArray< T > ( IEnumerable< ExtensionObject extensions)
inlinestatic

Converts the extension objects to an array of on null objects of the specified tye.

Template Parameters
T
Parameters
extensionsThe extensions.
Returns
Null if there is a conversion error. The array otherwise with no null elements.
Type Constraints
T :class 
static T UnifiedAutomation.UaBase.ExtensionObject.GetObject< T > ( ExtensionObject  extension)
inlinestatic

Gets the extension body as the specified type. Null if the body is not of the specified type.

Template Parameters
T
Parameters
extensionThe extension.
Returns
Type Constraints
T :class 
static bool UnifiedAutomation.UaBase.ExtensionObject.IsNull ( ExtensionObject  extension)
inlinestatic

Determines whether the specified extension is null.

Parameters
extensionThe extension.
Returns
true if the specified extension is null; otherwise, false.
override string UnifiedAutomation.UaBase.ExtensionObject.ToString ( )
inline

Formats the object as a string.

string UnifiedAutomation.UaBase.ExtensionObject.ToString ( string  format,
IFormatProvider  formatProvider 
)
inline

Formats the object as a string.

Member Data Documentation

readonly ExtensionObject UnifiedAutomation.UaBase.ExtensionObject.Empty = new ExtensionObject()
static

An ExpandedNodeId that represents a Empty value.

Property Documentation

object UnifiedAutomation.UaBase.ExtensionObject.Body
getset

Gets the body.

ExtensionObjectEncoding UnifiedAutomation.UaBase.ExtensionObject.Encoding
getset

Gets the encoding.

ExpandedNodeId UnifiedAutomation.UaBase.ExtensionObject.TypeId
getset

Gets the type id.


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