Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InstantiateObjectOptions

  subscribe now with sterfive to access the online-user manual

Hierarchy

  • InstantiateOptions
    • InstantiateObjectOptions

Index

Properties

Properties

browseName

browseName: QualifiedNameLike

the browse name of the new node to instantiate

Optional componentOf

componentOf: NodeIdLike | BaseNode

the parent Object holding this object note

  • when componentOf is specified, organizedBy must not be defined

Optional conditionSource

conditionSource: NodeId | BaseNode

Optional copyAlsoModellingRules

copyAlsoModellingRules: boolean

shall we also replicate the HasModelling rule reference ?

Optional description

description: LocalizedTextLike

an optional description

if not provided the default description of the corresponding Type will be used.

Optional displayName

displayName: LocalizedTextLike

an optional displayName

if not provided the default description of the corresponding browseName will be used.

Optional encodingOf

encodingOf: NodeId | BaseNode

Optional eventNotifier

eventNotifier: number

Optional eventSourceOf

eventSourceOf: NodeIdLike | BaseNode

Optional modellingRule

modellingRule: ModellingRuleType

modellingRule

Optional namespace

namespace: INamespace

the namespace in which the node shall be instantiated (if not specified, the default instance namespace (own namespace) of the addressSpace will be used)

Optional nodeId

nodeId: NodeIdLike

a (optional) predefined nodeId to assigned to the instance If not specified, a default nodeid will be created.

Optional notifierOf

notifierOf: NodeIdLike | BaseNode

Optional optionals

optionals: string[]

a list of components and properties names that have a HasModellingRule of Optional in the type definition that we want to instantiate. Note:

  • the name must follow the OPCUA naming convention and match the browse name of the property (same case)
  • the name can be composed to represent a path to a property or component
example
  optionals: ["MyOptionalVariable", "MyOptionalMethod", "MyOptionalComponent.MyProperty"];
default:

[]

Optional organizedBy

organizedBy: NodeIdLike | BaseNode

the parent Folder holding this object

note

  • when organizedBy is specified, componentOf must not be defined

Generated using TypeDoc