Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

OpcDataObject Members

Namespace: Opc.UaFx
Assemblies: Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll
The OpcDataObject type exposes the following members.

Constructors

OpcDataObject(OpcDataTypeInfo)

Initializes a new instance of the OpcDataObject class using the type information of the dataType specified.

C# 

public OpcDataObject(OpcDataTypeInfo dataType)


Parameters

dataType OpcDataTypeInfo

The OpcDataTypeInfo of the structured data type to represent.


Exceptions

ArgumentException

The dataType is not a structured data type (see IsStruct).

ArgumentNullException

The dataType is a null reference (Nothing in Visual Basic).

Properties

Item[String]

Gets the field associated with the specified name.

C# 

public OpcDataField this[string name] { get; }


Property Value

OpcDataField

An instance of the OpcDataField representing the field with the specified name, if existent; otherwise a null reference (Nothing in Visual Basic).

Methods

GetField(String)

Searches for the field with the specified name.

C# 

public OpcDataField GetField(string name)


Parameters

name String

The String containing the name of the data field to get.


Returns

OpcDataField

An instance of the OpcDataField representing the field with the specified name, if found; otherwise a null reference (Nothing in Visual Basic).


Remarks

The name specified is compared using Ordinal.

GetFields()

Returns all the fields of the current OpcDataObject.

C# 

public OpcDataField[] GetFields()


Returns

OpcDataField[]

An array of OpcDataField objects representing all the fields defined for the current OpcDataObject or an empty array of type OpcDataField if no fields are defined for the current OpcDataObject.

GetTypeInfo()

Gets the OpcDataTypeInfo of the current structured data type instance represented.

C# 

public OpcDataTypeInfo GetTypeInfo()


Returns

OpcDataTypeInfo

The OpcDataTypeInfo of the current structured data type instance.

HasField(String)

Determines whether the current OpcDataObject provides a OpcDataField with the Name equals to the name specified.

C# 

public bool HasField(string name)


Parameters

name String

The String containing the name of the data field to test.


Returns

Boolean

The value true if there exists a OpcDataField with the name specified; otherwise the value false.


Remarks

The name specified is compared using Ordinal.

TryGetField(String, out OpcDataField)

Searches for the field associated with the name specified.

C# 

public bool TryGetField(string name, out OpcDataField field)


Parameters

name String

The String containing the name of the data field to get.

field OpcDataField

The OpcDataField representing the field with the specified name, if found; otherwise a null reference (Nothing in Visual Basic).


Returns

Boolean

The value true if there exists a OpcDataField with the name specified (and field is set to that field); otherwise the value false.


Remarks

The name specified is compared using Ordinal.