⚠️ You are reading documentation for an OLD version (v2.32.0). The current released version is v2.173.1. View latest documentation →

Module node-opcua-data-model

subscribe now with sterfive to access the online-user manual

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

References

AttributeIds

Re-exports AttributeIds

attributeNameById

Re-exports attributeNameById

isValidAttributeId

Re-exports isValidAttributeId

Type aliases

LocalizedTextLike

LocalizedTextLike: LocalizedTextOptions | string

QualifiedNameLike

QualifiedNameLike: QualifiedNameOptions | string

Variables

Const _enumerationBrowseDirection

_enumerationBrowseDirection: Enum = ...

Const _enumerationResultMask

_enumerationResultMask: Enum

Const schemaBrowseDirection

schemaBrowseDirection: { enumValues: typeof BrowseDirection; name: string } = ...

Type declaration

enumValues: typeof BrowseDirection
name: string

Const schemaDiagnosticInfo

schemaDiagnosticInfo: StructuredTypeSchema = ...

Const schemaEnumNodeClass

schemaEnumNodeClass: { documentation: string; enumValues: typeof NodeClass; name: string }

Type declaration

documentation: string
enumValues: typeof NodeClass
name: string

Const schemaQualifiedName

schemaQualifiedName: StructuredTypeSchema

Const schemaResultMask

schemaResultMask: { enumValues: typeof ResultMask; name: string }

Type declaration

enumValues: typeof ResultMask
name: string

Functions

accessLevelFlagToString

accessLevelFlagToString(accessLevelFlag: AccessLevelFlag): string

- Defined in packages/node-opcua-data-model/source/access_level.ts:59
Parameters
- accessLevelFlag: AccessLevelFlag
Returns string

Const coerceAccessLevelFlag

coerceAccessLevelFlag(str: string | number | null): AccessLevelFlag

- Defined in packages/node-opcua-data-model/source/access_level.ts:52
Parameters
- str: string | number | null
Returns AccessLevelFlag

coerceLocalizedText

coerceLocalizedText(value?: null | string | LocalizedTextOptions): LocalizedText | null

- Defined in packages/node-opcua-data-model/dist/localized_text.d.ts:4
Parameters
- Optional value: null | string | LocalizedTextOptions
Returns LocalizedText | null

coerceQualifiedName

coerceQualifiedName(value: null): null
coerceQualifiedName(value: QualifiedNameLike): QualifiedName
coerceQualifiedName(value: string): QualifiedName

- Defined in packages/node-opcua-data-model/dist/qualified_name.d.ts:41
Parameters
- value: null
Returns null
- Defined in packages/node-opcua-data-model/dist/qualified_name.d.ts:42
Parameters
- value: QualifiedNameLike
Returns QualifiedName
- Defined in packages/node-opcua-data-model/dist/qualified_name.d.ts:43
Parameters
- value: string
Returns QualifiedName

convertAccessLevelFlagToByte

convertAccessLevelFlagToByte(accessLevel: AccessLevelFlag): number

- Defined in packages/node-opcua-data-model/source/access_level.ts:23
Parameters
- accessLevel: AccessLevelFlag
Returns number

decodeAccessLevelFlag

decodeAccessLevelFlag(stream: BinaryStream): AccessLevelFlag

- Defined in packages/node-opcua-data-model/source/access_level.ts:88
Parameters
- stream: BinaryStream
Returns AccessLevelFlag

decodeBrowseDirection

decodeBrowseDirection(stream: BinaryStream, _value?: BrowseDirection): BrowseDirection

- Defined in packages/node-opcua-data-model/source/BrowseDirection.ts:33
Parameters
- stream: BinaryStream
- Optional _value: BrowseDirection
Returns BrowseDirection

decodeDiagnosticInfo

decodeDiagnosticInfo(stream: BinaryStream, _value?: DiagnosticInfo | null): DiagnosticInfo

- Defined in packages/node-opcua-data-model/source/diagnostic_info.ts:350
Parameters
- stream: BinaryStream
- Optional _value: DiagnosticInfo | null
Returns DiagnosticInfo

decodeLocalizedText

decodeLocalizedText(stream: BinaryStream, value?: LocalizedText): LocalizedText

- Defined in packages/node-opcua-data-model/dist/localized_text.d.ts:24
Parameters
- stream: BinaryStream
- Optional value: LocalizedText
Returns LocalizedText

decodeQualifiedName

decodeQualifiedName(stream: BinaryStream, value?: QualifiedName): QualifiedName

- Defined in packages/node-opcua-data-model/dist/qualified_name.d.ts:45
Parameters
- stream: BinaryStream
- Optional value: QualifiedName
Returns QualifiedName

encodeAccessLevelFlag

encodeAccessLevelFlag(value: AccessLevelFlag, stream: OutputBinaryStream): void

- Defined in packages/node-opcua-data-model/source/access_level.ts:93
Parameters
- value: AccessLevelFlag
- stream: OutputBinaryStream
Returns void

encodeBrowseDirection

encodeBrowseDirection(value: BrowseDirection, stream: OutputBinaryStream): void

- Defined in packages/node-opcua-data-model/source/BrowseDirection.ts:29
Parameters
- value: BrowseDirection
- stream: OutputBinaryStream
Returns void

encodeDiagnosticInfo

encodeDiagnosticInfo(value: DiagnosticInfo | null, stream: OutputBinaryStream): void

- Defined in packages/node-opcua-data-model/source/diagnostic_info.ts:342
Parameters
- value: DiagnosticInfo | null
- stream: OutputBinaryStream
Returns void

encodeLocalizedText

encodeLocalizedText(value: LocalizedText, stream: OutputBinaryStream): void

- Defined in packages/node-opcua-data-model/dist/localized_text.d.ts:23
Parameters
- value: LocalizedText
- stream: OutputBinaryStream
Returns void

encodeQualifiedName

encodeQualifiedName(value: QualifiedName, stream: OutputBinaryStream): void

- Defined in packages/node-opcua-data-model/dist/qualified_name.d.ts:44
Parameters
- value: QualifiedName
- stream: OutputBinaryStream
Returns void

isDataEncoding

isDataEncoding(dataEncoding: any): boolean

- Defined in packages/node-opcua-data-model/source/data_encoding.ts:6
Parameters
- dataEncoding: any
Returns boolean

isValidDataEncoding

isValidDataEncoding(dataEncoding?: string | null | QualifiedNameLike): boolean

- Defined in packages/node-opcua-data-model/source/data_encoding.ts:11
Parameters
- Optional dataEncoding: string | null | QualifiedNameLike
Returns boolean

makeAccessLevelFlag

makeAccessLevelFlag(str: string | number | null): AccessLevelFlag

- Defined in packages/node-opcua-data-model/source/access_level.ts:28
Parameters
- str: string | number | null
Returns AccessLevelFlag

makeNodeClassMask

makeNodeClassMask(str: string): NodeClassMask

- Defined in packages/node-opcua-data-model/dist/node_class_mask.d.ts:14
Parameters
- str: string
Returns NodeClassMask

makeResultMask

makeResultMask(str: string): ResultMask

- Defined in packages/node-opcua-data-model/dist/result_mask.d.ts:18
Parameters
- str: string
Returns ResultMask

randomAccessLevel

randomAccessLevel(): AccessLevelFlag

- Defined in packages/node-opcua-data-model/source/access_level.ts:54
Returns AccessLevelFlag

stringToQualifiedName

stringToQualifiedName(value: string): QualifiedName

- Defined in packages/node-opcua-data-model/dist/qualified_name.d.ts:40
method

stringToQualifiedName

example

stringToQualifiedName("Hello") => {namespaceIndex: 0, name: "Hello"} stringToQualifiedName("3:Hello") => {namespaceIndex: 3, name: "Hello"}

Parameters
- value: string
Returns QualifiedName

Generated using TypeDoc