Skip to content

Reference

OpcEncodingMask Members

Defines the characteristics of the 'EncodingMask' of a type with optional members.

Reference

OpcEncodingMask Members ​

Type
OpcEncodingMask
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Constructors ​

OpcEncodingMask ​

2 overloads

OverloadDescription
OpcEncodingMask(OpcEncodingMaskKind)Initializes a new instance of the OpcEncodingMask class using the kind defined while the Size of the mask is determined depending on the OpcEncodingMaskKind specified.
OpcEncodingMask(OpcEncodingMaskKind, int)Initializes a new instance of the OpcEncodingMask class using the kind and sizeInBits specified.

OpcEncodingMask(OpcEncodingMaskKind) ​

Initializes a new instance of the OpcEncodingMask class using the kind defined while the Size of the mask is determined depending on the OpcEncodingMaskKind specified.

csharp
public OpcEncodingMask(OpcEncodingMaskKind kind)
vbnet
Public Sub New(kind As OpcEncodingMaskKind)

Parameters

NameTypeDescription
kindOpcEncodingMaskKindThe OpcEncodingMaskKind value to use to control the definition and use of the 'EncodingMask'.

OpcEncodingMask(OpcEncodingMaskKind, int) ​

Initializes a new instance of the OpcEncodingMask class using the kind and sizeInBits specified.

csharp
public OpcEncodingMask(OpcEncodingMaskKind kind, int sizeInBits)
vbnet
Public Sub New(kind As OpcEncodingMaskKind, sizeInBits As Integer)

Parameters

NameTypeDescription
kindOpcEncodingMaskKindThe OpcEncodingMaskKind value to use to control the definition and use of the 'EncodingMask'.
sizeInBitsInt32The size in bits which have to be a multiple of eight. Each bit acquired by the 'EncodingMask' can be used by an optional member to control its existence within a data stream. In case there a value less than -1 is used the SizeInBits is set to -1 which results into the same OpcEncodingMask as OpcEncodingMask would be used.

Properties ​

Default ​

static

Gets the default characteristics used to encode optional members of a type using the Explicit.

csharp
public static OpcEncodingMask Default { get; }
vbnet
Public Shared ReadOnly Property [Default] As OpcEncodingMask

Property value

OpcEncodingMask

An instance of the OpcEncodingMask class initialized with the default characteristics used to encode optional members using the Explicit.

DefaultAuto ​

static · since v2.50

Gets the default characteristics used to encode optional members of a type using the Auto.

csharp
public static OpcEncodingMask DefaultAuto { get; }
vbnet
Public Shared ReadOnly Property DefaultAuto As OpcEncodingMask

Property value

OpcEncodingMask

An instance of the OpcEncodingMask class initialized with the default characteristics used to encode optional members using the Auto.

Kind ​

Gets a value which defines how the 'EncodingMask' of a type is used and an which way it is declared and used by the type to control the existence of its optional members.

csharp
public OpcEncodingMaskKind Kind { get; }
vbnet
Public ReadOnly Property Kind As OpcEncodingMaskKind

Property value

OpcEncodingMaskKind

One of the members defined by the OpcEncodingMaskKind enumeration.

Size ​

Gets the number of bytes to use for the 'EncodingMask'. Each bit in the bytes acquired by the 'EncodingMask' can be used to control the existence of optional members within a data stream.

csharp
public int Size { get; }
vbnet
Public ReadOnly Property Size As Integer

Property value

Int32

The number of bytes to use or -1 in case there the size of the 'EncodingMask' is determined depending on the Kind.

SizeInBits ​

Gets the number of bits to use for the 'EncodingMask'. Each bit can be used to control the existence of optional members within a data stream.

csharp
public int SizeInBits { get; }
vbnet
Public ReadOnly Property SizeInBits As Integer

Property value

Int32

The number of bits to use or -1 in case there the number of bits required by the 'EncodingMask' is determined depending on the Kind.