Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

accessRestrictions

accessRestrictions: AccessRestrictionsFlag

ackedState

acknowledge

acknowledge: UAMethod

activeState

addComment

addComment: UAMethod

addressSpace

addressSpace: IAddressSpace

Optional audibleEnabled

audibleEnabled: UAProperty<boolean, Boolean>

Optional audibleSound

audibleSound: UAAudioVariable<Buffer>

Optional baseHighHighLimit

baseHighHighLimit: UAProperty<number, Double>

Optional baseHighLimit

baseHighLimit: UAProperty<number, Double>

Optional baseLowLimit

baseLowLimit: UAProperty<number, Double>

Optional baseLowLowLimit

baseLowLowLimit: UAProperty<number, Double>

branchId

Readonly browseName

browseName: QualifiedName

clientUserId

clientUserId: UAProperty<string, String>

comment

conditionClassId

conditionClassId: UAProperty<NodeId, NodeId>

conditionClassName

conditionClassName: UAProperty<LocalizedText, LocalizedText>

conditionName

conditionName: UAProperty<string, String>

conditionRefresh

conditionRefresh: UAMethod

conditionRefresh2

conditionRefresh2: UAMethod

Optional conditionSubClassId

conditionSubClassId: UAProperty<NodeId[], NodeId>

Optional conditionSubClassName

conditionSubClassName: UAProperty<LocalizedText[], LocalizedText>

Optional confirm

confirm: UAMethod

Optional confirmedState

description

description: LocalizedText

disable

disable: UAMethod

displayName

displayName: LocalizedText[]

enable

enable: UAMethod

enabledState

eventId

eventId: UAProperty<Buffer, ByteString>

Readonly eventNotifier

eventNotifier: number

eventType

eventType: UAProperty<NodeId, NodeId>

Optional firstInGroup

firstInGroup: UAAlarmGroup

Optional firstInGroupFlag

firstInGroupFlag: UABaseDataVariable<boolean, Boolean>

Readonly hasMethods

hasMethods: boolean

Optional highHighLimit

highHighLimit: UAProperty<number, Double>

Optional highHighState

Optional highLimit

highLimit: UAProperty<number, Double>

Optional highState

inputNode

inputNode: UAProperty<NodeId, NodeId>

lastSeverity

lastSeverity: UAConditionVariable<number, UInt16>

Optional latchedState

Optional localTime

Optional lowLimit

lowLimit: UAProperty<number, Double>

Optional lowLowLimit

lowLowLimit: UAProperty<number, Double>

Optional lowLowState

Optional lowState

Optional maxTimeShelved

maxTimeShelved: UAProperty<number, Double>

message

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 offDelay

offDelay: UAProperty<number, Double>

Optional onDelay

onDelay: UAProperty<number, Double>

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

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

Optional outOfServiceState

outOfServiceState: UATwoStateVariable<LocalizedText>

parent

parent: BaseNode

parentNodeId

parentNodeId: NodeId

Optional placeInService

placeInService: UAMethod

quality

Optional reAlarmRepeatCount

reAlarmRepeatCount: UABaseDataVariable<number, Int16>

Optional reAlarmTime

reAlarmTime: UAProperty<number, Double>

receiveTime

receiveTime: UAProperty<Date, DateTime>

Optional removeFromService

removeFromService: UAMethod

Optional reset

reset: UAMethod

retain

retain: UAProperty<boolean, Boolean>

rolePermissions

rolePermissions: RolePermissionType[]

severity

severity: UAProperty<number, UInt16>

Optional shelvingState

shelvingState: UAShelvedStateMachine

Optional silence

silence: UAMethod

Optional silenceState

sourceName

sourceName: UAProperty<string, String>

sourceNode

sourceNode: UAProperty<NodeId, NodeId>

Optional suppress

suppress: UAMethod

suppressedOrShelved

suppressedOrShelved: UAProperty<boolean, Boolean>

Optional suppressedState

time

time: UAProperty<Date, DateTime>

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Optional unsuppress

unsuppress: UAMethod

Methods

addReference

  • Parameters

    Returns void

allReferences

  • Returns UAReference[]

browseNode

browseNodeByTargetName

  • Parameters

    Returns NodeId[]

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

  • Returns BaseNode[]

getChildByName

  • Parameters

    Returns BaseNode

  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns BaseNode

getComponentByName

  • Parameters

    Returns UAObject | UAVariable

  • Parameters

    • componentName: string
    • Optional namespaceIndex: number

    Returns UAObject | UAVariable

getComponents

  • Returns BaseNode[]

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

  • Parameters

    Returns BaseNode

  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns BaseNode

getMethodById

  • Parameters

    Returns UAMethod

getMethodByName

  • Parameters

    Returns UAMethod

  • Parameters

    • methodName: string
    • Optional namespaceIndex: number

    Returns UAMethod

getMethods

  • Returns UAMethod[]

getNotifiers

  • Returns BaseNode[]

getProperties

  • Returns BaseNode[]

getPropertyByName

  • Parameters

    Returns UAVariable

  • Parameters

    • propertyName: string
    • Optional namespaceIndex: number

    Returns UAVariable

getRolePermissions

  • Parameters

    • inherited: boolean

    Returns RolePermissionType[]

install_extra_properties

  • install_extra_properties(): void
  • private

    Returns void

on

  • Parameters

    Returns UACondition

raiseEvent

  • Parameters

    Returns void

readAttribute

removeReference

  • Parameters

    Returns void

setAccessRestrictions

  • setAccessRestriction

    Parameters

    Returns void

setRolePermissions

  • Parameters

    Returns void

writeAttribute

  • Parameters

    Returns void

Generated using TypeDoc