Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReferenceElementObject

Hierarchy

Index

Properties

Methods

Properties

addressSpace

addressSpace: AddressSpace

browseName

browseName: QualifiedName

description

description: LocalizedText

displayName

displayName: LocalizedText[]

hasMethods

hasMethods: boolean

idShort

idShort: 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

Optional semanticId

semanticId: AASReferenceObject

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Optional value

value: AASReferenceObject

Methods

addListener

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addParent

addReference

  • addReference(options: AddReferenceOpts): void

  • Parameters

    • options: AddReferenceOpts

    Returns void

addSemanticId

allReferences

  • allReferences(): Reference[]

  • Returns Reference[]

browseNode

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

  • 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

  • Parameters

    • options: any
    • Optional optionalFilter: any
    • Optional extraInfo: any

    Returns UAObject

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

findReference

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

  • Parameters

    • strReference: string
    • Optional isForward: undefined | false | true

    Returns UAReference | null

findReferences

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

  • Parameters

    • referenceType: string | NodeId | UAReferenceType
    • Optional isForward: undefined | false | true

    Returns UAReference[]

findReferencesAsObject

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

  • Parameters

    • strReference: string
    • isForward: boolean

    Returns BaseNode[]

findReferencesEx

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

  • Parameters

    • strReference: string
    • Optional browseDirection: BrowseDirection

    Returns UAReference[]

findReferencesExAsObject

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

  • Parameters

    • strReference: string
    • Optional browseDirection: BrowseDirection

    Returns BaseNode[]

fullName

  • fullName(): string

  • return a complete name of this object by pre-pending name of its parent(s) to its own name

    Returns string

getAggregates

  • getAggregates(): BaseNode[]

  • Returns BaseNode[]

getChildByName

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

  • Parameters

    • browseName: string | QualifiedName

    Returns BaseNode | null

getComponentByName

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

  • Parameters

    • componentName: QualifiedNameLike
    • Optional namespaceIndex: undefined | number

    Returns UAObject | UAVariable | null

getComponents

  • getComponents(): BaseNode[]

  • Returns BaseNode[]

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]

  • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

    Returns BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]

  • return a array with the event source of this object. self = HasEventSource => nodes

    Returns BaseNode[]

getFolderElementByName

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

  • Parameters

    • browseName: string
    • Optional namespaceIndex: undefined | number

    Returns BaseNode | null

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getMethodById

  • getMethodById(nodeId: NodeId): UAMethod | null

  • Parameters

    • nodeId: NodeId

    Returns UAMethod | null

getMethodByName

  • getMethodByName(methodName: string): UAMethod | null

  • Parameters

    • methodName: string

    Returns UAMethod | null

getMethods

  • getMethods(): UAMethod[]

  • Returns UAMethod[]

getNotifiers

  • getNotifiers(): BaseNode[]

  • Returns BaseNode[]

getProperties

  • getProperties(): BaseNode[]

  • Returns BaseNode[]

getPropertyByName

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

  • Parameters

    • browseName: string
    • Optional namespaceIndex: undefined | number

    Returns UAVariable | null

install_extra_properties

  • install_extra_properties(): void

  • Returns void

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

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

  • Parameters

    • eventName: "event"
    • eventHandler: function
        • (eventData: IEventData): void

        • Parameters

          • eventData: IEventData

          Returns void

    Returns this

once

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

  • 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

  • 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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

propagate_back_references

  • propagate_back_references(): void

  • 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

  • Parameters

    • eventType: EventTypeLike
    • eventData: RaiseEventData

    Returns void

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

readAttribute

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

  • Parameters

    • context: SessionContext | null
    • attributeId: AttributeIds
    • Optional indexRange: NumericRange
    • Optional dataEncoding: QualifiedNameLike | null

    Returns DataValue

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeReference

  • removeReference(referenceOpts: AddReferenceOpts): void

  • Parameters

    • referenceOpts: AddReferenceOpts

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

writeAttribute

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

  • Parameters

    • context: SessionContext
    • writeValue: any
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void

        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Generated using TypeDoc