OpcDataFieldInfo Members

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

CustomAttributes

Gets an array of custom attributes associated with this field.

C#

public virtual string[] CustomAttributes { get; }


Property Value

String[]

An array of String values used by the author of this field.



Remarks

Applications are not be required to understand these attributes in order to interpret an encoded field value.

DeclaringType

Gets the type that declares the current OpcDataFieldInfo.

C#

public OpcDataTypeInfo DeclaringType { get; }


Property Value

OpcDataTypeInfo

An instance of the OpcDataTypeInfo which declares the current OpcDataFieldInfo.

Documentation

Gets any semantic information that would help a human to understand what is contained in the field.

C#

public virtual string Documentation { get; }


Property Value

String

A human readable text that describes what is contained in the field and that would help a human to understand what the field represented.

FieldType

Gets the type of value this field provides.

C#

public OpcDataTypeInfo FieldType { get; }


Property Value

OpcDataTypeInfo

The OpcDataTypeInfo representing the type of value this field provides.

IsOptional

Gets a value indicating whether the current field might not necessarily exist in the object defined by the DeclaringType.

C#

public bool IsOptional { get; }


Property Value

Boolean

The value true if the field might not always exists; otherwise the value false. Additionally see the Switch property.

Length

Gets the length of the field expressed either explicit or implicit using a different OpcDataFieldInfo.

C#

public virtual OpcMemberLength Length { get; }


Property Value

OpcMemberLength

An instance of the OpcMemberLength class with the explicit length of the field or the reference to the OpcDataFieldInfo its value expresses the length of the current OpcDataFieldInfo.

LengthField

Gets the OpcDataFieldInfo used to define the length of the current OpcDataFieldInfo.

C#

public virtual OpcDataFieldInfo LengthField { get; }


Property Value

OpcDataFieldInfo

An instance of the OpcDataFieldInfo class its value expresses the length of the current OpcDataFieldInfo or a null reference (Nothing in Visual Basic) if the Length does not refer to a different OpcDataFieldInfo used to express the length of the field.

Name

Gets the name of the current OpcDataFieldInfo.

C#

public string Name { get; }


Property Value

String

A String containing the name of this field.

ReflectedType

Gets the type that was used to obtain this instance of OpcDataFieldInfo.

C#

public OpcDataTypeInfo ReflectedType { get; }


Property Value

OpcDataTypeInfo

An instance of the OpcDataTypeInfo used to obtain this instance.

Switch

Gets the switch condition which applies to the current OpcDataFieldInfo.

C#

public virtual OpcMemberSwitch Switch { get; }


Property Value

OpcMemberSwitch

An instance of the OpcMemberSwitch class which defines the conditions to fulfill so that the current OpcDataFieldInfo exists in an instance.

SwitchField

Gets the OpcDataFieldInfo used to evaluate the Switch condition which applies to the current OpcDataFieldInfo.

C#

public virtual OpcDataFieldInfo SwitchField { get; }


Property Value

OpcDataFieldInfo

An instance of the OpcDataFieldInfo class its value is to be evaluated to determine whether the current OpcDataFieldInfo exists in an instance.

GetValue(Object)

Gets the value of the field supported by the given object instance.

C#

public virtual object GetValue(object instance)


Parameters

instance Object

The Object whose field value will be returned.


Returns

Object

An object containing the value of the field reflected by this instance.


Remarks

This method throws a NotSupportedException and have to be overridden in a derived class.

SetValue(Object, Object)

Sets the value of the field supported by the given object instance.

C#

public virtual void SetValue(object instance, object value)


Parameters

instance Object

The Object whose field value will be set.

value Object

The value to assign to the field.


Remarks

This method throws a NotSupportedException and have to be overridden in a derived class.

ToString()

Returns a String representing the Name and FieldType of the current OpcDataFieldInfo.

C#

public override string ToString()


Returns

String

A String representing the Name and the FieldType of the current OpcDataFieldInfo.