SubmodelObject | node-opcua-coreaas

Hierarchy

UAObject
ReferableNamespaceObject
- SubmodelObject

Index

Methods

Properties

addressSpace

addressSpace: AddressSpace

Optional administration

administration: UAObject

browseName

browseName: QualifiedName

description

description: LocalizedText

displayName

displayName: LocalizedText[]

hasMethods

hasMethods: boolean

idShort

idShort: UAVariable

identification

identification: UAVariable

Optional kind

kind: UAVariable

Optional modellingRule

modellingRule: ModellingRuleType

namespace

namespace: Namespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

nodeClass

nodeClass: Object

nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: undefined | function

parent

parent: BaseNode | null

Optional parentNodeId

parentNodeId: NodeId

referableChildrenMap

referableChildrenMap: Map<string, UAObject>

Optional semanticId

semanticId: AASReferenceObject

submodelElements

submodelElements: Folder

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addElements

addElements(elemArray: SubmodelElementObject[]): SubmodelObject

- Defined in src/types.ts:144
Parameters
- elemArray: SubmodelElementObject[]
Returns SubmodelObject

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

addParent

addParent(parent: RefArgument): SubmodelObject

- Defined in src/types.ts:143
Parameters
- parent: RefArgument
Returns SubmodelObject

addReference

addReference(options: AddReferenceOpts): void

Inherited from BaseNode.addReference
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:88
Parameters
- options: AddReferenceOpts
Returns void

addSemanticId

addSemanticId(semanticId: RefArgument): SubmodelObject

- Defined in src/types.ts:141
Parameters
- semanticId: RefArgument
Returns SubmodelObject

allReferences

allReferences(): Reference[]

Inherited from BaseNode.allReferences
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:108
Returns Reference[]

browseNode

browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]

Inherited from BaseNode.browseNode
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:126
browse the node to extract information requested in browseDescription

method

browseNode

Parameters
- browseDescription: BrowseDescriptionOptions
- Optional session: SessionContext
Returns ReferenceDescription[]

clone

clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject

Inherited from UAObject.clone
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:563
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAObject

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

findReference

findReference(strReference: string, isForward?: undefined | false | true): UAReference | null

Inherited from BaseNode.findReference
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:105
Parameters
- strReference: string
- Optional isForward: undefined | false | true
Returns UAReference | null

findReferences

findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: undefined | false | true): UAReference[]

Inherited from BaseNode.findReferences
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:104
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: undefined | false | true
Returns UAReference[]

findReferencesAsObject

findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]

Inherited from BaseNode.findReferencesAsObject
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:107
Parameters
- strReference: string
- isForward: boolean
Returns BaseNode[]

findReferencesEx

findReferencesEx(strReference: string, browseDirection?: BrowseDirection): UAReference[]

Inherited from BaseNode.findReferencesEx
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:103
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

Inherited from BaseNode.findReferencesExAsObject
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:106
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from BaseNode.fullName
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:87
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string

getAggregates

getAggregates(): BaseNode[]

Inherited from IPropertyAndComponentHolder.getAggregates
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:166
Returns BaseNode[]

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode | null

Inherited from BaseNode.getChildByName
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:109
Parameters
- browseName: string | QualifiedName
Returns BaseNode | null

getComponentByName

getComponentByName(componentName: QualifiedNameLike, namespaceIndex?: undefined | number): UAObject | UAVariable | null

Inherited from IPropertyAndComponentHolder.getComponentByName
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:164
Parameters
- componentName: QualifiedNameLike
- Optional namespaceIndex: undefined | number
Returns UAObject | UAVariable | null

getComponents

getComponents(): BaseNode[]

Inherited from IPropertyAndComponentHolder.getComponents
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:167
Returns BaseNode[]

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from BaseNode.getEventSourceOfs
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:101
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from BaseNode.getEventSources
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:96
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode[]

getFolderElementByName

getFolderElementByName(browseName: string, namespaceIndex?: undefined | number): BaseNode | null

Inherited from UAObject.getFolderElementByName
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:557
Parameters
- browseName: string
- Optional namespaceIndex: undefined | number
Returns BaseNode | null

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getMethodById

getMethodById(nodeId: NodeId): UAMethod | null

Inherited from UAObject.getMethodById
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:558
Parameters
- nodeId: NodeId
Returns UAMethod | null

getMethodByName

getMethodByName(methodName: string): UAMethod | null

Inherited from UAObject.getMethodByName
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:559
Parameters
- methodName: string
Returns UAMethod | null

getMethods

getMethods(): UAMethod[]

Inherited from UAObject.getMethods
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:560
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from IPropertyAndComponentHolder.getNotifiers
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:169
Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from IPropertyAndComponentHolder.getProperties
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:168
Returns BaseNode[]

getPropertyByName

getPropertyByName(browseName: string, namespaceIndex?: undefined | number): UAVariable | null

Inherited from IPropertyAndComponentHolder.getPropertyByName
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:165
Parameters
- browseName: string
- Optional namespaceIndex: undefined | number
Returns UAVariable | null

hasSemantic

hasSemantic(semanticElem: UAObject): SubmodelObject

- Defined in src/types.ts:140
Parameters
- semanticElem: UAObject
Returns SubmodelObject

hasSubmodelSemantic

hasSubmodelSemantic(semanticElem: SubmodelObject): SubmodelObject

- Defined in src/types.ts:139
Parameters
- semanticElem: SubmodelObject
Returns SubmodelObject

install_extra_properties

install_extra_properties(): void

Inherited from BaseNode.install_extra_properties
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:102
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(eventName: "event", eventHandler: function): this

Inherited from UAObject.on

Overrides EventEmitter.on
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:562
Parameters
- eventName: "event"
- eventHandler: function
  - - (eventData: IEventData): void
    - Parameters
      - eventData: IEventData
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

propagate_back_references

propagate_back_references(): void

Inherited from BaseNode.propagate_back_references
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:114
this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

Returns void

raiseEvent

raiseEvent(eventType: EventTypeLike, eventData: RaiseEventData): void

Inherited from UAObject.raiseEvent

Overrides EventRaiser.raiseEvent
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:561
Parameters
- eventType: EventTypeLike
- eventData: RaiseEventData
Returns void

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

readAttribute

readAttribute(context: SessionContext | null, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike | null): DataValue

Inherited from BaseNode.readAttribute
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:90
Parameters
- context: SessionContext | null
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike | null
Returns DataValue

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from BaseNode.removeReference
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:89
Parameters
- referenceOpts: AddReferenceOpts
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

submodelOf

submodelOf(aas: AASObject): SubmodelObject

- Defined in src/types.ts:142
Parameters
- aas: AASObject
Returns SubmodelObject

writeAttribute

writeAttribute(context: SessionContext, writeValue: any, callback: function): void

Inherited from BaseNode.writeAttribute
- Defined in node_modules/node-opcua-address-space/dist/source/address_space_ts.d.ts:91
Parameters
- context: SessionContext
- writeValue: any
- callback: function
  - - (err: Error | null, statusCode?: StatusCode): void
    - Parameters
      - err: Error | null
      - Optional statusCode: StatusCode
      Returns void
Returns void

Hierarchy

Index

Properties

Methods

Properties

addressSpace

Optional administration

browseName

description

displayName

hasMethods

idShort

identification

Optional kind

Optional modellingRule

namespace

namespaceIndex

namespaceUri

nodeClass

nodeId

Optional onFirstBrowseAction

parent

Optional parentNodeId

referableChildrenMap

Optional semanticId

submodelElements

typeDefinition

typeDefinitionObj

Methods

addElements

Parameters

elemArray: SubmodelElementObject[]

Returns SubmodelObject

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

addParent

Parameters

parent: RefArgument

Returns SubmodelObject

addReference

Parameters

options: AddReferenceOpts

Returns void

addSemanticId

Parameters

semanticId: RefArgument

Returns SubmodelObject

allReferences

Returns Reference[]

browseNode

Parameters

browseDescription: BrowseDescriptionOptions

Optional session: SessionContext

Returns ReferenceDescription[]

clone

Parameters

options: any

Optional optionalFilter: any

Optional extraInfo: any

Returns UAObject

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

findReference

Parameters

strReference: string

Optional isForward: undefined | false | true

Returns UAReference | null

findReferences

Parameters