Class Variant

Hierarchy (View Summary)

BaseUAObject
- Variant

Index

Constructors

Properties

arrayType dataType dimensions schema value coerce computer_default_value maxArrayLength maxTypedArrayLength schema

Accessors

Methods

applyOnAllFields binaryStoreSize clone decode decodeDebug encode explore isValid toJSON toString

Constructors

constructor

new Variant(options?: VariantOptions | null): Variant
Parameters
- Optionaloptions: VariantOptions | null
Returns Variant
Overrides BaseUAObject.constructor
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:32

Properties

arrayType

arrayType: VariantArrayType

dataType

dataType: DataType

dimensions

dimensions: number[] | null

schema

schema: IStructuredTypeSchema

value

value: any

`Static`coerce

coerce: (variantLike: VariantOptions | Variant) => Variant

`Static`computer_default_value

computer_default_value: () => Variant

`Static`maxArrayLength

maxArrayLength: number

`Static`maxTypedArrayLength

maxTypedArrayLength: number

`Static`schema

schema: IStructuredTypeSchema

Accessors

encoded

get encoded(): Uint8Array<ArrayBufferLike> | null
the binary encoding the Variant is kept as (EncodedVariant); null for a Variant of fields

Returns Uint8Array<ArrayBufferLike> | null
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:39

Methods

applyOnAllFields

applyOnAllFields<T>(func: Func1<T>, data: T): void
Type Parameters
- T
Parameters
- func: Func1<T>
- data: T
Returns void
Inherited from BaseUAObject.applyOnAllFields
- Defined in work/node-opcua/node-opcua/packages/node-opcua-factory/dist/base_ua_object.d.ts:35

binaryStoreSize

binaryStoreSize(): number
Calculate the required size to store this object in a binary stream.

Returns number
Inherited from BaseUAObject.binaryStoreSize
- Defined in work/node-opcua/node-opcua/packages/node-opcua-factory/dist/base_ua_object.d.ts:21

clone

clone(): Variant
Returns Variant
Overrides BaseUAObject.clone
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:40

decode

decode(stream: BinaryStream): void
Decode the object from the binary stream.
Parameters
- stream: BinaryStream
Returns void
Overrides BaseUAObject.decode
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:34

decodeDebug

decodeDebug(stream: BinaryStream, options: DecodeDebugOptions): void
Parameters
- stream: BinaryStream
- options: DecodeDebugOptions
Returns void
Overrides BaseUAObject.decodeDebug
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:35

encode

encode(stream: OutputBinaryStream): void
Encode the object to the binary stream.
Parameters
- stream: OutputBinaryStream
Returns void
Overrides BaseUAObject.encode
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:33

explore

explore(): string
Returns string
Inherited from BaseUAObject.explore
- Defined in work/node-opcua/node-opcua/packages/node-opcua-factory/dist/base_ua_object.d.ts:34

isValid

isValid(): boolean
verify that all object attributes values are valid according to schema

Returns boolean
Overrides BaseUAObject.isValid
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:37

toJSON

toJSON(...args: unknown[]): unknown
Parameters
- ...args: unknown[]
Returns unknown
Inherited from BaseUAObject.toJSON
- Defined in work/node-opcua/node-opcua/packages/node-opcua-factory/dist/base_ua_object.d.ts:36

toString

toString(): string
Returns string
Overrides BaseUAObject.toString
- Defined in work/node-opcua/node-opcua/packages/node-opcua-variant/dist/variant.d.ts:36