UAAlarmConditionBase | NodeOPCUA reference documentation

Hierarchy

UAAcknowledgeableConditionBase
- UAAlarmConditionBase

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UAAlarmConditionBase(options: any): UAAlarmConditionBase

Inherited from UAAcknowledgeableConditionBase.constructor
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:10
Parameters
- options: any
Returns UAAlarmConditionBase

Properties

ackedState

ackedState: UATwoStateVariable

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariable

addComment

addComment: UAMethod

branchId

branchId: UAVariableT<NodeId, NodeId>

Readonly browseName

browseName: QualifiedName

comment

comment: UAConditionVariable<LocalizedText, LocalizedText>

conditionClassId

conditionClassId: UAVariableT<NodeId, NodeId>

conditionClassName

conditionClassName: UAVariableT<LocalizedText, LocalizedText>

conditionName

conditionName: UAVariableT<string, String>

Optional confirm

confirm: UAMethod

Optional confirmedState

confirmedState: UATwoStateVariable

disable

disable: UAMethod

enable

enable: UAMethod

enabledState

enabledState: UATwoStateVariable

eventId

eventId: UAVariable

Readonly eventNotifier

eventNotifier: number

eventType

eventType: UAVariableT<NodeId, NodeId>

inputNode

inputNode: UAVariableT<NodeId, NodeId>

lastSeverity

lastSeverity: UAConditionVariable<StatusCode, StatusCode>

localTime

localTime: UAVariableT<any, ExtensionObject>

maxTimeShelved

maxTimeShelved: UAVariable

message

message: UAVariableT<LocalizedText, LocalizedText>

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>

quality

quality: UAConditionVariable<StatusCode, StatusCode>

receiveTime

receiveTime: UAVariableT<Date, DateTime>

retain

retain: UAVariableT<boolean, Boolean>

severity

severity: UAVariableT<number, UInt16>

shelvingState

shelvingState: ShelvingStateMachine

sourceName

sourceName: UAVariableT<string, String>

sourceNode

sourceNode: UAVariableT<NodeId, NodeId>

suppressedOrShelved

suppressedOrShelved: UAVariable

suppressedState

suppressedState: UATwoStateVariable

Readonly symbolicName

symbolicName: string

time

time: UAVariableT<DateTime, DateTime>

Static MaxDuration

MaxDuration: number

static
property: MaxDuration

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static defaultSeverity

defaultSeverity: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static typeDefinition

typeDefinition: NodeId

Accessors

addressSpace

get addressSpace(): AddressSpacePrivate

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:56
Returns AddressSpacePrivate

description

get description(): LocalizedText
set description(value: LocalizedText): any

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:59
Returns LocalizedText
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:60
Parameters
- value: LocalizedText
Returns any

displayName

get displayName(): LocalizedText[]
set displayName(value: LocalizedText[]): any

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:57
Returns LocalizedText[]
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:58
Parameters
- value: LocalizedText[]
Returns any

fromStateNode

get fromStateNode(): BaseNode

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:241
Returns BaseNode

hasMethods

get hasMethods(): boolean

- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:17
returns true if the object has some opcua methods

Returns boolean

isFalseSubStateOf

get isFalseSubStateOf(): BaseNode

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:222
property

isFalseSubStateOf

Returns BaseNode

isTrueSubStateOf

get isTrueSubStateOf(): BaseNode

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:227
property

isTrueSubStateOf

Returns BaseNode

modellingRule

get modellingRule(): ModellingRuleType

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:86
property

modellingRule

Returns ModellingRuleType

namespace

get namespace(): Namespace

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:99
Returns Namespace

namespaceIndex

get namespaceIndex(): number

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:73
namespace index

Returns number

namespaceUri

get namespaceUri(): string

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:77
namespace uri

Returns string

parent

get parent(): BaseNode

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:81
the parent node

Returns BaseNode

parentNodeId

get parentNodeId(): NodeId

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:69
Returns NodeId

toStateNode

get toStateNode(): BaseNode

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:240
Returns BaseNode

typeDefinition

get typeDefinition(): NodeId

- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:64
returns the nodeId of this node's Type Definition

Returns NodeId

typeDefinitionObj

get typeDefinitionObj(): UAObjectType

- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:10
Returns UAObjectType

Methods

_acknowledge_branch

_acknowledge_branch(conditionEventId: Buffer, comment: string | LocalizedText | LocalizedTextOptions, branch: ConditionSnapshot, message: string): ConstantStatusCode

Inherited from UAAcknowledgeableConditionBase._acknowledge_branch
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:32
Parameters
- conditionEventId: Buffer
- comment: string | LocalizedText | LocalizedTextOptions
- branch: ConditionSnapshot
- message: string
Returns ConstantStatusCode

_assert_valid

_assert_valid(): void

Inherited from UAAcknowledgeableConditionBase._assert_valid
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:146
Returns void

_bubble_up_event

_bubble_up_event(eventData: any): void

Inherited from UAAcknowledgeableConditionBase._bubble_up_event
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:24
Parameters
- eventData: any
Returns void

_calculateConditionInfo

_calculateConditionInfo(stateData: string, isActive: boolean, value: string, oldCondition: ConditionInfo): ConditionInfo

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:135
method

_calculateConditionInfo

example

var myAlarm = addressSpace.instantiateExclusiveLimitAlarm({...}); myAlarm._calculateConditionInfo = function(stateName,value,oldCondition) { var percent = Math.ceil(value * 100); return new ConditionInfo({ message: "Tank is almost " + percent + "% full", severity: 100, quality: StatusCodes.Good }); };

Parameters
- stateData: string
  
  the new calculated state of the alarm
- isActive: boolean
- value: string
  
  the new value of the limit alarm
- oldCondition: ConditionInfo
  
  given for information purpose
Returns ConditionInfo

the new condition info

this method need to be overridden by the instantiate to allow custom message and severity to be set based on specific context of the alarm.

_conditionRefresh

_conditionRefresh(_cache?: any): void

Inherited from UAAcknowledgeableConditionBase._conditionRefresh
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:25
Parameters
- Optional _cache: any
Returns void

_onInputDataValueChange

_onInputDataValueChange(newValue: DataValue): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:95
Parameters
- newValue: DataValue
Returns void

_on_child_added

_on_child_added(): void

Inherited from UAAcknowledgeableConditionBase._on_child_added
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:261
Returns void

_on_child_removed

_on_child_removed(obj: BaseNode): void

Inherited from UAAcknowledgeableConditionBase._on_child_removed
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:262
Parameters
- obj: BaseNode
Returns void

_raiseAuditConditionAcknowledgeEvent

_raiseAuditConditionAcknowledgeEvent(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionBase._raiseAuditConditionAcknowledgeEvent
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:30
Parameters
- branch: ConditionSnapshot
Returns void

_raiseAuditConditionConfirmEvent

_raiseAuditConditionConfirmEvent(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionBase._raiseAuditConditionConfirmEvent
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:31
Parameters
- branch: ConditionSnapshot
Returns void

_resend_conditionEvents

_resend_conditionEvents(): 0 | 1

Inherited from UAAcknowledgeableConditionBase._resend_conditionEvents
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:173
Returns 0 | 1

_signalInitialCondition

_signalInitialCondition(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:136
Returns void

_signalNewCondition

_signalNewCondition(stateName: string, isActive?: boolean, value?: string): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:137
Parameters
- stateName: string
- Optional isActive: boolean
- Optional value: string
Returns void

acknowledgeAndAutoConfirmBranch

acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: string | LocalizedText | LocalizedTextOptions): void

Inherited from UAAcknowledgeableConditionBase.acknowledgeAndAutoConfirmBranch
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:53
method

acknowledgeAndAutoConfirmBranch

Parameters
- branch: ConditionSnapshot
- comment: string | LocalizedText | LocalizedTextOptions
Returns void

activateAlarm

activateAlarm(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:47
method

activateAlarm

Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): UAAlarmConditionBase

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

addReference

addReference(reference: AddReferenceOpts): void

Inherited from UAAcknowledgeableConditionBase.addReference
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:209
method

addReference

example
```
view.addReference({ referenceType: "Organizes", nodeId: myDevice });
```
or
```
myDevice1.addReference({ referenceType: "OrganizedBy", nodeId: view });
```
Parameters
- reference: AddReferenceOpts
Returns void

allReferences

allReferences(): Reference[]

Inherited from UAAcknowledgeableConditionBase.allReferences
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:193
Returns Reference[]

autoConfirmBranch

autoConfirmBranch(branch: ConditionSnapshot, comment: string | LocalizedTextOptions): void

Inherited from UAAcknowledgeableConditionBase.autoConfirmBranch
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:47
method

autoConfirmBranch

Parameters
- branch: ConditionSnapshot
- comment: string | LocalizedTextOptions
Returns void

browseNode

browseNode(browseDescription: BrowseDescription, context?: SessionContext): ReferenceDescription[]

Inherited from UAAcknowledgeableConditionBase.browseNode
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:192
browse the node to extract information requested in browseDescription

method

browseNode

Parameters
- browseDescription: BrowseDescription
- Optional context: SessionContext
Returns ReferenceDescription[]

an array with reference descriptions

browseNodeByTargetName

browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[]

Inherited from UAAcknowledgeableConditionBase.browseNodeByTargetName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:184
method

browseNodeByTargetName

Parameters
- relativePathElement: RelativePathElement
- isLast: boolean
Returns NodeId[]

clone

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

Inherited from UAAcknowledgeableConditionBase.clone
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:13
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAObject

conditionOfNode

conditionOfNode(): UAVariable | UAObject

Inherited from UAAcknowledgeableConditionBase.conditionOfNode
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:151
method

conditionOfNode

Returns UAVariable | UAObject

createBranch

createBranch(): ConditionSnapshot

Inherited from UAAcknowledgeableConditionBase.createBranch
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:101
method

createBranch

Returns ConditionSnapshot

currentBranch

currentBranch(): ConditionSnapshot

Inherited from UAAcknowledgeableConditionBase.currentBranch
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:172
method

currentBranch

Returns ConditionSnapshot

deactivateAlarm

deactivateAlarm(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:51
method

deactivateAlarm

Returns void

deleteBranch

deleteBranch(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionBase.deleteBranch
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:106
method

deleteBranch

Parameters
- branch: ConditionSnapshot
Returns void

desactivateAlarm

desactivateAlarm(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:55
deprecated

use deactivateAlarm instead

Returns void

dispose

dispose(): void

Overrides UAAcknowledgeableConditionBase.dispose
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:43
Returns void

dumpXML

dumpXML(xmlWriter: XmlWriter): void

Inherited from UAAcknowledgeableConditionBase.dumpXML
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:255
Parameters
- xmlWriter: XmlWriter
Returns void

emit

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

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

eventNames

eventNames(): (string | symbol)[]

Inherited from UAAcknowledgeableConditionBase.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

findHierarchicalReferences

findHierarchicalReferences(): UAReference[]

Inherited from UAAcknowledgeableConditionBase.findHierarchicalReferences
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:238
Returns UAReference[]

findReference

findReference(strReference: string, isForward?: boolean): UAReference

Inherited from UAAcknowledgeableConditionBase.findReference
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:114
method

findReference

Parameters
- strReference: string
  
  the referenceType as a string.
- Optional isForward: boolean
Returns UAReference

findReferences

findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]

Inherited from UAAcknowledgeableConditionBase.findReferences
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:107
method

findReferences

Parameters
- referenceType: string | NodeId | UAReferenceType
  
  the referenceType as a string.
- Optional isForward: boolean
Returns UAReference[]

an array with references

findReferencesAsObject

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

Inherited from UAAcknowledgeableConditionBase.findReferencesAsObject
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:116
Parameters
- strReference: string
- Optional isForward: boolean
Returns BaseNode[]

findReferencesEx

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

Inherited from UAAcknowledgeableConditionBase.findReferencesEx
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:100
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

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

Inherited from UAAcknowledgeableConditionBase.findReferencesExAsObject
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:115
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from UAAcknowledgeableConditionBase.fullName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:175
Returns string

getAggregates

getAggregates(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getAggregates
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:120
return an array with the Aggregates of this object.

Returns BaseNode[]

getBranchCount

getBranchCount(): number

Inherited from UAAcknowledgeableConditionBase.getBranchCount
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:94
Returns number

getBranchIds

getBranchIds(): NodeId[]

Inherited from UAAcknowledgeableConditionBase.getBranchIds
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:96
Returns NodeId[]

getBranches

getBranches(): ConditionSnapshot[]

Inherited from UAAcknowledgeableConditionBase.getBranches
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:95
Returns ConditionSnapshot[]

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode

Inherited from UAAcknowledgeableConditionBase.getChildByName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:239
Parameters
- browseName: string | QualifiedName
Returns BaseNode

getComponentByName

getComponentByName(browseName: QualifiedNameLike, namespaceIndex?: number): UAObject | UAVariable

Inherited from UAAcknowledgeableConditionBase.getComponentByName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:144
retrieve a component by name

Parameters
- browseName: QualifiedNameLike
- Optional namespaceIndex: number
Returns UAObject | UAVariable

getComponents

getComponents(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getComponents
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:124
return an array with the components of this object.

Returns BaseNode[]

getCurrentConditionInfo

getCurrentConditionInfo(): ConditionInfo

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:105
Returns ConditionInfo

getDisplayName

getDisplayName(locale?: string): string

Inherited from UAAcknowledgeableConditionBase.getDisplayName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:98
Parameters
- Optional locale: string
Returns string

getEnabledState

getEnabledState(): boolean

Inherited from UAAcknowledgeableConditionBase.getEnabledState
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:111
method

getEnabledState

Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

Inherited from UAAcknowledgeableConditionBase.getEnabledStateAsString
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:116
method

getEnabledStateAsString

Returns string

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getEventSourceOfs
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:140
return a array of the objects for which this node is an EventSource

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getEventSources
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:136
return a array with the event source of this object.

Returns BaseNode[]

getFalseSubStates

getFalseSubStates(): UAStateVariable[]

Inherited from UAAcknowledgeableConditionBase.getFalseSubStates
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:232
method

getFalseSubStates

Returns UAStateVariable[]

return an array with the SubStates of this object.

getFolderElementByName

getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode

Inherited from UAAcknowledgeableConditionBase.getFolderElementByName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:152
retrieve a folder by name

Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getFolderElements

getFolderElements(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getFolderElements
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:156
returns the list of nodes that this folder object organizes

Returns BaseNode[]

getInputNodeNode

getInputNodeNode(): UAVariable

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:88
method

getInputNodeNode

Returns UAVariable

return the node in the address space pointed by the inputNode value

Note: please note the difference between alarm.inputNode
- alarm.inputNode is a UAVariable property of the alarm object holding the nodeid of the input node in its value.
- getInputNodeNode() is the UAVariable that contains the value that affects the state of the alarm and whose node id is stored in alarm.inputNode

getInputNodeValue

getInputNodeValue(): any

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:93
method

getInputNodeValue

Returns any

getMaxListeners

getMaxListeners(): number

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

getMaxTimeShelved

getMaxTimeShelved(): number

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:77
method

getMaxTimeShelved

Returns number

getMethodById

getMethodById(nodeId: NodeId): UAMethod

Inherited from UAAcknowledgeableConditionBase.getMethodById
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:169
returns the method exposed by this object and with the given nodeId

Parameters
- nodeId: NodeId
Returns UAMethod

getMethodByName

getMethodByName(methodName: string): UAMethod

Inherited from UAAcknowledgeableConditionBase.getMethodByName
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:18
Parameters
- methodName: string
Returns UAMethod

getMethods

getMethods(): UAMethod[]

Inherited from UAAcknowledgeableConditionBase.getMethods
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:19
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getNotifiers
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:132
return a array with the notifiers of this object.

Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from UAAcknowledgeableConditionBase.getProperties
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:128
return a array with the properties of this object.

Returns BaseNode[]

getPropertyByName

getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable

Inherited from UAAcknowledgeableConditionBase.getPropertyByName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:148
retrieve a property by name

Parameters
- browseName: string
- Optional namespaceIndex: number
Returns UAVariable

getSuppressedOrShelved

getSuppressedOrShelved(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:65
method

getSuppressedOrShelved

Returns boolean

getTrueSubStates

getTrueSubStates(): UAStateVariable[]

Inherited from UAAcknowledgeableConditionBase.getTrueSubStates
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:237
method

getTrueSubStates

Returns UAStateVariable[]

return an array with the SubStates of this object.

getUserWriteMask

getUserWriteMask(): number

Inherited from UAAcknowledgeableConditionBase.getUserWriteMask
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:172
Returns number

getWriteMask

getWriteMask(): number

Inherited from UAAcknowledgeableConditionBase.getWriteMask
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:171
Returns number

installPostInstallFunc

installPostInstallFunc(f: any): void

Inherited from UAAcknowledgeableConditionBase.installPostInstallFunc
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:260
Parameters
- f: any
Returns void

install_extra_properties

install_extra_properties(): void

Inherited from UAAcknowledgeableConditionBase.install_extra_properties
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:215
Returns void

isSuppressedOrShelved

isSuppressedOrShelved(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:60
method

isSuppressedOrShelved

Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAAcknowledgeableConditionBase.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 UAAcknowledgeableConditionBase.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): UAAlarmConditionBase

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

on

on(eventName: string, eventHandler: (...args: any[]) => void): UAAlarmConditionBase
on(eventName: "acknowledged" | "confirmed", eventHandler: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void): UAAlarmConditionBase

Inherited from UAAcknowledgeableConditionBase.on
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:17
Parameters
- eventName: string
- eventHandler: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns UAAlarmConditionBase
Inherited from UAAcknowledgeableConditionBase.on
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:18
Parameters
- eventName: "acknowledged" | "confirmed"
- eventHandler: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot) => void
  - - (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot): void
    - Parameters
      - eventId: Buffer
      - comment: LocalizedText
      - branch: ConditionSnapshot
      Returns void
Returns UAAlarmConditionBase

once

once(event: string | symbol, listener: (...args: any[]) => void): UAAlarmConditionBase

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

ownReferences

ownReferences(): Reference[]

Inherited from UAAcknowledgeableConditionBase.ownReferences
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:176
Returns Reference[]

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): UAAlarmConditionBase

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

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): UAAlarmConditionBase

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

propagate_back_references

propagate_back_references(): void

Inherited from UAAcknowledgeableConditionBase.propagate_back_references
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:246
this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

Returns void

raiseConditionEvent

raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void

Inherited from UAAcknowledgeableConditionBase.raiseConditionEvent
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:159
method

raiseConditionEvent Raise a Instance Event (see also UAObject#raiseEvent to raise a transient event)

Parameters
- branch: ConditionSnapshot
  
  the condition branch to raise
- renewEventId: boolean
  
  true if event Id of the condition branch should be renewed
Returns void

raiseEvent

raiseEvent(eventType: string | NodeId | UAEventType | BaseNode, data: RaiseEventData): void

Inherited from UAAcknowledgeableConditionBase.raiseEvent
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:23
Raise a transient Event

Parameters
- eventType: string | NodeId | UAEventType | BaseNode
- data: RaiseEventData
Returns void

raiseNewBranchState

raiseNewBranchState(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionBase.raiseNewBranchState
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:167
Parameters
- branch: ConditionSnapshot
Returns void

raiseNewCondition

raiseNewCondition(conditionInfo: ConditionInfoOptions): void

Inherited from UAAcknowledgeableConditionBase.raiseNewCondition
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:166
method

raiseNewCondition

Parameters
- conditionInfo: ConditionInfoOptions
Returns void

rawListeners

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

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

readAttribute

readAttribute(context: SessionContext, attributeId: AttributeIds): DataValue

Inherited from UAAcknowledgeableConditionBase.readAttribute
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:12
Parameters
- context: SessionContext
- attributeId: AttributeIds
Returns DataValue

removeAllListeners

removeAllListeners(event?: string | symbol): UAAlarmConditionBase

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

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): UAAlarmConditionBase

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

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from UAAcknowledgeableConditionBase.removeReference
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:210
Parameters
- referenceOpts: AddReferenceOpts
Returns void

resolveNodeId

resolveNodeId(nodeId: NodeIdLike): NodeId

Inherited from UAAcknowledgeableConditionBase.resolveNodeId
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:214
Parameters
- nodeId: NodeIdLike
Returns NodeId

setLocalTime

setLocalTime(time: TimeZoneDataType): void

Inherited from UAAcknowledgeableConditionBase.setLocalTime
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:140
method

setLocalTime (optional)

Parameters
- time: TimeZoneDataType
Returns void

setMaxListeners

setMaxListeners(n: number): UAAlarmConditionBase

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

setMaxTimeShelved

setMaxTimeShelved(duration: number): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:72
method

setMaxTimeShelved

Parameters
- duration: number
  
  ( Duration in Milliseconds)
  
  note: duration must be greater than 10ms and lesser than 2**31 ms
Returns void

setReceiveTime

setReceiveTime(time: Date): void

Inherited from UAAcknowledgeableConditionBase.setReceiveTime
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:135
method

setReceiveTime

Parameters
- time: Date
Returns void

setSourceName

setSourceName(name: string): void

Inherited from UAAcknowledgeableConditionBase.setSourceName
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/base_event_type.d.ts:20
method

setSourceName

Parameters
- name: string
Returns void

setSourceNode

setSourceNode(node: NodeId | BaseNode): void

Inherited from UAAcknowledgeableConditionBase.setSourceNode
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/base_event_type.d.ts:25
method

setSourceNode

Parameters
- node: NodeId | BaseNode
Returns void

setTime

setTime(time: Date): void

Inherited from UAAcknowledgeableConditionBase.setTime
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:145
method

setTime

Parameters
- time: Date
Returns void

toString

toString(): string

Inherited from UAAcknowledgeableConditionBase.toString
- Defined in packages/node-opcua-address-space/dist/src/ua_object.d.ts:26
Returns string

uninstall_extra_properties

uninstall_extra_properties(reference: Reference): void

Inherited from UAAcknowledgeableConditionBase.uninstall_extra_properties
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:216
Parameters
- reference: Reference
Returns void

unpropagate_back_references

unpropagate_back_references(): void

Inherited from UAAcknowledgeableConditionBase.unpropagate_back_references
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:259
Undo the effect of propagate_back_references

Returns void

updateState

updateState(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:94
Returns void

writeAttribute

writeAttribute(context: SessionContext, writeValue: any, callback: (err: Error, statusCode?: StatusCode) => void): void

Inherited from UAAcknowledgeableConditionBase.writeAttribute
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:174
Parameters
- context: SessionContext
- writeValue: any
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
Returns void

Static install_condition_refresh_handle

install_condition_refresh_handle(addressSpace: AddressSpacePrivate): void

Inherited from UAAcknowledgeableConditionBase.install_condition_refresh_handle
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:72
Parameters
- addressSpace: AddressSpacePrivate
Returns void

Static install_method_handle_on_type

install_method_handle_on_type(addressSpace: AddressSpacePrivate): void

Inherited from UAAcknowledgeableConditionBase.install_method_handle_on_type
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_base.d.ts:29
Parameters
- addressSpace: AddressSpacePrivate
Returns void

Static instantiate

instantiate(namespace: Namespace, alarmConditionTypeId: EventTypeLike, options: any, data: any): UAAlarmConditionBase

Overrides UAAcknowledgeableConditionBase.instantiate
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_base.d.ts:42
method

(static)UAAlarmConditionBase.instantiate

Parameters
- namespace: Namespace
- alarmConditionTypeId: EventTypeLike
- options: any
- data: any
Returns UAAlarmConditionBase

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from UAAcknowledgeableConditionBase.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static makeAttributeEventName

makeAttributeEventName(attributeId: AttributeIds): string

Inherited from UAAcknowledgeableConditionBase.makeAttributeEventName
- Defined in packages/node-opcua-address-space/dist/src/base_node.d.ts:87
Parameters
- attributeId: AttributeIds
Returns string

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from UAAcknowledgeableConditionBase.on
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

Inherited from UAAcknowledgeableConditionBase.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from UAAcknowledgeableConditionBase.once
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Static with_condition_method

with_condition_method(inputArguments: VariantOptions[], context: SessionContext, callback: (err: Error, result?: { statusCode: StatusCode }) => void, inner_func: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionBase) => StatusCode): void

Inherited from UAAcknowledgeableConditionBase.with_condition_method
- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_base.d.ts:78
Helper method to handle condition methods that takes a branchId and a comment

Parameters
- inputArguments: VariantOptions[]
- context: SessionContext
- callback: (err: Error, result?: { statusCode: StatusCode }) => void
  - - (err: Error, result?: { statusCode: StatusCode }): void
    - Parameters
      - err: Error
      - Optional result: { statusCode: StatusCode }
        
        statusCode: StatusCode
      Returns void
- inner_func: (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionBase) => StatusCode
  - - (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionBase): StatusCode
    - Parameters
      - eventId: Buffer
      - comment: LocalizedText
      - branch: ConditionSnapshot
      - conditionNode: UAConditionBase
      Returns StatusCode
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns UAAlarmConditionBase

Properties

ackedState

acknowledge

activeState

addComment

branchId

Readonly browseName

comment

conditionClassId

conditionClassName

conditionName

Optional confirm

Optional confirmedState

disable

enable

enabledState

eventId

Readonly eventNotifier

eventType

inputNode

lastSeverity

localTime

maxTimeShelved

message

Readonly nodeClass

Readonly nodeId

Optional nodeVersion

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

quality

receiveTime

retain

severity

shelvingState

sourceName

sourceNode

suppressedOrShelved

suppressedState

Readonly symbolicName

time

Static MaxDuration

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static defaultSeverity

Readonly Static errorMonitor

Static typeDefinition

Accessors

addressSpace

Returns AddressSpacePrivate

description

Returns LocalizedText

Parameters

value: LocalizedText

Returns any

displayName

Returns LocalizedText[]

Parameters

value: LocalizedText[]

Returns any

fromStateNode

Returns BaseNode

hasMethods

Returns boolean

isFalseSubStateOf

Returns BaseNode

isTrueSubStateOf