node-opcua-address-space | NodeOPCUA reference documentation

Index

References

Enumerations

EUEngineeringUnit

Interfaces

Variables

NamespaceOptions

Functions

References

ConstructNodeIdOptions

Re-exports ConstructNodeIdOptions

ContinuationPointManager

Re-exports ContinuationPointManager

NodeIdManager

Re-exports NodeIdManager

Reference

Re-exports Reference

adjustBrowseDirection

Re-exports adjustBrowseDirection

Type aliases

AccessLevelString

AccessLevelString: string

AddStateVariableOptionals

AddStateVariableOptionals: "EffectiveDisplayName" | "Name" | "Number" | string

AddTwoStateVariableOptionals

AddTwoStateVariableOptionals: AddStateVariableOptionals | "TransitionTime" | "EffectiveTransitionTime" | "TrueState" | "FalseState"

BindVariableOptions

BindVariableOptions: BindVariableOptionsVariation1 | BindVariableOptionsVariation2 | BindVariableOptionsVariation3

ContinuationPoint

ContinuationPoint: Buffer

CreateNodeOptions

CreateNodeOptions: any

DataValueCallback

DataValueCallback: (err: Error | null, dataValue?: DataValue) => void

Type declaration

- (err: Error | null, dataValue?: DataValue): void
- Parameters
  - err: Error | null
  - Optional dataValue: DataValue
  Returns void

Duration

Duration: number

EventTypeLike

EventTypeLike: string | NodeId | UAEventType

FolderType

FolderType: UAObjectType

IHistoricalDataNodeOptions

IHistoricalDataNodeOptions: IVariableHistorianOptions | { historian: IVariableHistorian }

MethodFunctor

MethodFunctor: (this: UAMethod, inputArguments: Variant[], context: SessionContext, callback: MethodFunctorCallback) => void

Type declaration

- (this: UAMethod, inputArguments: Variant[], context: SessionContext, callback: MethodFunctorCallback): void
- Parameters
  - this: UAMethod
  - inputArguments: Variant[]
  - context: SessionContext
  - callback: MethodFunctorCallback
  Returns void

MethodFunctorCallback

MethodFunctorCallback: (err: Error | null, callMethodResult: CallMethodResultOptions) => void

Type declaration

- (err: Error | null, callMethodResult: CallMethodResultOptions): void
- Parameters
  - err: Error | null
  - callMethodResult: CallMethodResultOptions
  Returns void

ModellingRuleType

PseudoVariant

PseudoVariantNumber

TransitionSelector

TransitionSelector: (transitions: Transition[], fromState: State, toState: State) => Transition | null

Type declaration

- (transitions: Transition[], fromState: State, toState: State): Transition | null
- Parameters
  - transitions: Transition[]
  - fromState: State
  - toState: State
  Returns Transition | null

UABaseEventType

UABaseEventType: UAObjectType

UAClonable

UAClonable: UAObject | UAVariable | UAMethod

UtcTime

UtcTime: DateTime

VariableDataValueGetterAsync

VariableDataValueGetterAsync: (callback: DataValueCallback) => void

Type declaration

- (callback: DataValueCallback): void
- Parameters
  - callback: DataValueCallback
  Returns void

VariableDataValueGetterSync

VariableDataValueGetterSync: () => DataValue

Type declaration

- (): DataValue
- Returns DataValue

VariableDataValueSetterWithCallback

VariableDataValueSetterWithCallback: (dataValue: DataValue, callback: StatusCodeCallback) => void

Type declaration

- (dataValue: DataValue, callback: StatusCodeCallback): void
- Parameters
  - dataValue: DataValue
  - callback: StatusCodeCallback
  Returns void

VariableSetter

VariableSetter: VariableSetterVariation1 | VariableSetterVariation2

VariableSetterVariation1

VariableSetterVariation1: (this: UAVariable, value: Variant) => StatusCode

Type declaration

- (this: UAVariable, value: Variant): StatusCode
- Parameters
  - this: UAVariable
  - value: Variant
  Returns StatusCode

VariableSetterVariation2

VariableSetterVariation2: (this: UAVariable, value: Variant, callback: (err: Error | null, statusCode: StatusCode) => void) => void

Type declaration

- (this: UAVariable, value: Variant, callback: (err: Error | null, statusCode: StatusCode) => void): void
- Parameters
  - this: UAVariable
  - value: Variant
  - callback: (err: Error | null, statusCode: StatusCode) => void
    - - (err: Error | null, statusCode: StatusCode): void
      - Parameters
        
        err: Error | null
        
        statusCode: StatusCode
        
        Returns void
  Returns void

XmlLoaderFunc

XmlLoaderFunc: (nodeset2xmlUri: string, callback: CallbackT<string>) => void

Type declaration

- (nodeset2xmlUri: string, callback: CallbackT<string>): void
- Parameters
  - nodeset2xmlUri: string
  - callback: CallbackT<string>
  Returns void

Variables

Const NamespaceOptions

NamespaceOptions: { nodeIdNameSeparator: string }

Type declaration

nodeIdNameSeparator: string

Functions

__checkWhereClause

__checkWhereClause(addressSpace: AddressSpace, sessionContext: SessionContext, whereClause: ContentFilter, index: number, eventData: IEventData): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/check_where_clause.d.ts:3
Parameters
- addressSpace: AddressSpace
- sessionContext: SessionContext
- whereClause: ContentFilter
- index: number
- eventData: IEventData
Returns boolean

addElement

addElement<T>(options: any, uaArrayVariableNode: UADynamicVariableArray<T>): UAVariable

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2646
Type parameters
- T: ExtensionObject<T>
Parameters
- options: any
- uaArrayVariableNode: UADynamicVariableArray<T>
Returns UAVariable

binaryStoreSize_ArgumentList

binaryStoreSize_ArgumentList(description: any, args: any): number

- Defined in packages/node-opcua-address-space/dist/source/helpers/argument_list.d.ts:9
Parameters
- description: any
- args: any
Returns number

bindExtObjArrayNode

bindExtObjArrayNode<T>(uaArrayVariableNode: UADynamicVariableArray<T>, variableTypeNodeId: string | NodeId, indexPropertyName: string): UAVariable

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2640
Type parameters
- T: ExtensionObject<T>
Parameters
- uaArrayVariableNode: UADynamicVariableArray<T>
- variableTypeNodeId: string | NodeId
- indexPropertyName: string
Returns UAVariable

build_retrieveInputArgumentsDefinition

build_retrieveInputArgumentsDefinition(addressSpace: AddressSpace): (objectId: NodeId, methodId: NodeId) => Argument[]

- Defined in packages/node-opcua-address-space/dist/source/helpers/argument_list.d.ts:25
Parameters
- addressSpace: AddressSpace
Returns (objectId: NodeId, methodId: NodeId) => Argument[]
- - (objectId: NodeId, methodId: NodeId): Argument[]
  - Parameters
    - objectId: NodeId
    - methodId: NodeId
    Returns Argument[]

callMethodHelper

callMethodHelper(server: IServerBase, session: ISessionBase, addressSpace: AddressSpace, callMethodRequest: CallMethodRequest, callback: ResponseCallback<CallMethodResultOptions>): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/call_helpers.d.ts:6
Parameters
- server: IServerBase
- session: ISessionBase
- addressSpace: AddressSpace
- callMethodRequest: CallMethodRequest
- callback: ResponseCallback<CallMethodResultOptions>
Returns void

checkSelectClause

checkSelectClause(parentNode: BaseNode, selectClause: SimpleAttributeOperand): StatusCode

- Defined in packages/node-opcua-address-space/dist/source/helpers/check_event_clause.d.ts:10
method

checkSelectClause

Parameters
- parentNode: BaseNode
- selectClause: SimpleAttributeOperand
Returns StatusCode

checkSelectClauses

checkSelectClauses(eventTypeNode: UAObjectType, selectClauses: SimpleAttributeOperand[]): StatusCode[]

- Defined in packages/node-opcua-address-space/dist/source/helpers/check_event_clause.d.ts:17
method

checkSelectClauses

Parameters
- eventTypeNode: UAObjectType
- selectClauses: SimpleAttributeOperand[]
Returns StatusCode[]

an array of StatusCode

checkWhereClause

checkWhereClause(addressSpace: AddressSpace, sessionContext: SessionContext, whereClause: ContentFilter, eventData: IEventData): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/check_where_clause.d.ts:4
Parameters
- addressSpace: AddressSpace
- sessionContext: SessionContext
- whereClause: ContentFilter
- eventData: IEventData
Returns boolean

createExtObjArrayNode

createExtObjArrayNode<T>(parentFolder: UAObject, options: any): UADynamicVariableArray<T>

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2635
Type parameters
- T: ExtensionObject<T>
Parameters
- parentFolder: UAObject
- options: any
Returns UADynamicVariableArray<T>

decode_ArgumentList

decode_ArgumentList(definition: any[], stream: BinaryStream): any[]

- Defined in packages/node-opcua-address-space/dist/source/helpers/argument_list.d.ts:8
Parameters
- definition: any[]
- stream: BinaryStream
Returns any[]

dumpBrowseDescription

dumpBrowseDescription(node: BaseNode, _browseDescription: BrowseDescriptionOptions): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:7
Parameters
- node: BaseNode
- _browseDescription: BrowseDescriptionOptions
Returns void

dumpReferenceDescription

dumpReferenceDescription(addressSpace: AddressSpace, referenceDescription: ReferenceDescription): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:5
Parameters
- addressSpace: AddressSpace
- referenceDescription: ReferenceDescription
Returns void

dumpReferenceDescriptions

dumpReferenceDescriptions(addressSpace: AddressSpace, referenceDescriptions: ReferenceDescription[]): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:6
Parameters
- addressSpace: AddressSpace
- referenceDescriptions: ReferenceDescription[]
Returns void

dumpReferences

dumpReferences(addressSpace: AddressSpace, references: UAReference[]): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:14
method

dumpReferences

static

Parameters
- addressSpace: AddressSpace
- references: UAReference[]
Returns void

dumpToBSD

dumpToBSD(namespace: Namespace): string

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2659
Parameters
- namespace: Namespace
Returns string

dumpXml

dumpXml(node: BaseNode, options: any): string

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2658
Parameters
- node: BaseNode
- options: any
Returns string

encode_ArgumentList

encode_ArgumentList(definition: any[], args: any, stream: OutputBinaryStream): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/argument_list.d.ts:7
Parameters
- definition: any[]
- args: any
- stream: OutputBinaryStream
Returns void

ensureObjectIsSecure

ensureObjectIsSecure(node: BaseNode): void

- Defined in packages/node-opcua-address-space/dist/source/helpers/ensure_secure_access.d.ts:7
make sure that the given ia node can only be read by Admistrrator user on a encrypted channel

Parameters
- node: BaseNode
Returns void

extractEventFields

extractEventFields(sessionContext: SessionContext, selectClauses: SimpleAttributeOperand[], eventData: IEventData): Variant[]

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/extract_event_fields.d.ts:11
method

extractEventFields extract a array of eventFields from a event node, matching the selectClauses

Parameters
- sessionContext: SessionContext
- selectClauses: SimpleAttributeOperand[]
- eventData: IEventData
  
  : a pseudo Node that provides a browse Method and a readValue(nodeId)
Returns Variant[]

generateAddressSpaceRaw

generateAddressSpaceRaw(addressSpace: AddressSpace, xmlFiles: string | string[], xmlLoader: XmlLoaderFunc): Promise<void>

- Defined in packages/node-opcua-address-space/dist/source/loader/generateAddressSpaceRaw.d.ts:10
Parameters
- addressSpace: AddressSpace
- xmlFiles: string | string[]
- xmlLoader: XmlLoaderFunc
Returns Promise<void>

generateAddressSpaceRawCallback

generateAddressSpaceRawCallback(addressSpace: AddressSpace, xmlFiles: string | string[], xmlLoader: (nodeset2xmlUri: string, callback: CallbackT<string>) => void, callback?: ErrorCallback): void

- Defined in packages/node-opcua-address-space/dist/source/loader/generateAddressSpaceRaw.d.ts:8
xmlfiles:

a lis of xml files

Parameters
- addressSpace: AddressSpace
  
  the addressSpace to populate
- xmlFiles: string | string[]
- xmlLoader: (nodeset2xmlUri: string, callback: CallbackT<string>) => void
  
  a helper function to return the content of the xml file
  - - (nodeset2xmlUri: string, callback: CallbackT<string>): void
    - Parameters
      - nodeset2xmlUri: string
      - callback: CallbackT<string>
      Returns void
- Optional callback: ErrorCallback
Returns void

getMethodDeclaration_ArgumentList

getMethodDeclaration_ArgumentList(addressSpace: AddressSpace, objectId: NodeId, methodId: NodeId): { methodDeclaration?: UAMethod; statusCode: StatusCode }

- Defined in packages/node-opcua-address-space/dist/source/helpers/argument_list.d.ts:10
Parameters
- addressSpace: AddressSpace
- objectId: NodeId
- methodId: NodeId
Returns { methodDeclaration?: UAMethod; statusCode: StatusCode }
- Optional methodDeclaration?: UAMethod
- statusCode: StatusCode

makeAttributeEventName

makeAttributeEventName(attributeId: AttributeIds): string

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:133
Parameters
- attributeId: AttributeIds
Returns string

promoteToStateMachine

promoteToStateMachine(node: UAObject): StateMachine

- Defined in packages/node-opcua-address-space/dist/source/interfaces/state_machine/state_machine.d.ts:328
Parameters
- node: UAObject
Returns StateMachine

referenceTypeToString

referenceTypeToString(addressSpace: AddressSpace, referenceTypeId: NodeIdLike | null): string

- Defined in packages/node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:4
Parameters
- addressSpace: AddressSpace
- referenceTypeId: NodeIdLike | null
Returns string

removeElement

removeElement<T>(uaArrayVariableNode: UADynamicVariableArray<T>, element: any): void

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:2651
Type parameters
- T: ExtensionObject<T>
Parameters
- uaArrayVariableNode: UADynamicVariableArray<T>
- element: any
Returns void

resolveReferenceNode

resolveReferenceNode(addressSpace: MinimalistAddressSpace, reference: UAReference): BaseNode

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:110
Parameters
- addressSpace: MinimalistAddressSpace
- reference: UAReference
Returns BaseNode

resolveReferenceType

resolveReferenceType(addressSpace: MinimalistAddressSpace, reference: UAReference): UAReferenceType

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:108
Parameters
- addressSpace: MinimalistAddressSpace
- reference: UAReference
Returns UAReferenceType

verifyArguments_ArgumentList

verifyArguments_ArgumentList(addressSpace: AddressSpace, methodInputArguments: Argument[], inputArguments?: Variant[]): { inputArgumentResults?: StatusCode[]; statusCode: StatusCode }

- Defined in packages/node-opcua-address-space/dist/source/helpers/argument_list.d.ts:21
method

verifyArguments_ArgumentList

Parameters
- addressSpace: AddressSpace
- methodInputArguments: Argument[]
- Optional inputArguments: Variant[]
Returns { inputArgumentResults?: StatusCode[]; statusCode: StatusCode }

statusCode,inputArgumentResults
- Optional inputArgumentResults?: StatusCode[]
- statusCode: StatusCode

subscribe now with sterfive to access the online-user manual

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

ConstructNodeIdOptions

ContinuationPointManager

NodeIdManager

Reference

adjustBrowseDirection

ensureDatatypeExtracted

ensureDatatypeExtractedWithCallback

promoteToMultiStateDiscrete

promoteToMultiStateValueDiscrete

promoteToTwoStateDiscrete

Type aliases

AccessLevelString

AddStateVariableOptionals

AddTwoStateVariableOptionals

BindVariableOptions

ContinuationPoint

CreateNodeOptions

DataValueCallback

Type declaration

Parameters

err: Error | null

Optional dataValue: DataValue

Returns void

Duration

EventTypeLike

FolderType

IHistoricalDataNodeOptions

MethodFunctor

Type declaration

Parameters

this: UAMethod

inputArguments: Variant[]

context: SessionContext

callback: MethodFunctorCallback

Returns void

MethodFunctorCallback

Type declaration

Parameters

err: Error | null

callMethodResult: CallMethodResultOptions

Returns void

ModellingRuleType

PseudoVariant

PseudoVariantNumber

TransitionSelector

Type declaration

Parameters

transitions: Transition[]

fromState: State

toState: State

Returns Transition | null

UABaseEventType

UAClonable

UtcTime

VariableDataValueGetterAsync

Type declaration

Parameters

callback: DataValueCallback

Returns void

VariableDataValueGetterSync

Type declaration

Returns DataValue

VariableDataValueSetterWithCallback

Type declaration

Parameters

dataValue: DataValue

callback: StatusCodeCallback

Returns void

VariableSetter

VariableSetterVariation1