Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

accessRestrictions

accessRestrictions: AccessRestrictionsFlag

addressSpace

addressSpace: IAddressSpace

applyWrite

applyWrite: UAState

applyWriteToError

applyWriteToError: UATransition

applyWriteToIdle

applyWriteToIdle: UATransition

Optional availableStates

availableStates: UABaseDataVariable<NodeId[], NodeId>

Optional availableTransitions

availableTransitions: UABaseDataVariable<NodeId[], NodeId>

Readonly browseName

browseName: QualifiedName

currentState

description

description: LocalizedText

displayName

displayName: LocalizedText[]

error

error: UAState

errorToIdle

errorToIdle: UATransition

Readonly eventNotifier

eventNotifier: number

Readonly hasMethods

hasMethods: boolean

idle

idleToApplyWrite

idleToApplyWrite: UATransition

idleToReadPrepare

idleToReadPrepare: UATransition

Optional lastTransition

modellingRule

modellingRule: ModellingRuleType

namespace

namespace: INamespace

namespaceIndex

namespaceIndex: number

namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Object

Readonly nodeId

nodeId: NodeId

Optional nodeVersion

nodeVersion: UAVariableT<string, String>

NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node. The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property belongs to. Attribute value changes do not cause the NodeVersion to change. Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

parent

parent: BaseNode

parentNodeId

parentNodeId: NodeId

readPrepare

readPrepare: UAState

readPrepareToError

readPrepareToError: UATransition

readPrepareToReadTransfer

readPrepareToReadTransfer: UATransition

readTransfer

readTransfer: UAState

readTransferToError

readTransferToError: UATransition

readTransferToIdle

readTransferToIdle: UATransition

reset

reset: UAMethod

rolePermissions

rolePermissions: RolePermissionType[]

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addReference

allReferences

browseNode

browseNodeByTargetName

clone

findReference

  • find the the references that are strictly of type reference.

    The isForward boolean flag specifies the direction of the references to be looked for.

    Forward direction is implied if omitted.

    • will throw an exception if more than one reference exists with the referenceType.
    • will return null if no reference exists.

    Parameters

    Returns UAReference

findReferences

  • find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

    Forward direction is implied if omitted.

    Parameters

    Returns UAReference[]

findReferencesAsObject

  • find all the nodes that are referenced by references strictly of type reference.

    The isForward boolean flag specifies the direction of the references to be looked for.

    Forward direction is implied if omitted.

    • will throw an exception if more than one reference exists with the referenceType.
    • will return null if no reference exists.

    Parameters

    Returns BaseNode[]

findReferencesEx

  • find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection

    • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

    Parameters

    Returns UAReference[]

findReferencesExAsObject

  • find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection

    • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

    Parameters

    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

getAccessRestrictions

  • get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

    Parameters

    • inherited: boolean

    Returns AccessRestrictionsFlag

getAggregates

getChildByName

getComponentByName

getComponents

getDisplayName

  • getDisplayName(locale?: string): string
  • Parameters

    • Optional locale: string

      the locale of the text to return (e.g. en-EN)

    Returns string

getEventSourceOfs

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

    Returns BaseNode[]

getEventSources

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

    Returns BaseNode[]

getFolderElementByName

getMethodById

getMethodByName

getMethods

getNotifiers

getProperties

getPropertyByName

getRolePermissions

install_extra_properties

  • install_extra_properties(): void

on

raiseEvent

readAttribute

removeReference

setAccessRestrictions

setRolePermissions

writeAttribute

Generated using TypeDoc