UAExclusiveLimitAlarmImpl | NodeOPCUA reference documentation

Hierarchy

UAExclusiveLimitAlarmEx
UALimitAlarmImpl
- UAExclusiveLimitAlarmImpl
  - UAExclusiveDeviationAlarmImpl
  - UAExclusiveLevelAlarmImpl

Implements

UAExclusiveLimitAlarmEx

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UAExclusiveLimitAlarmImpl(options: InternalBaseNodeOptions & { eventNotifier?: number; symbolicName?: string }): UAExclusiveLimitAlarmImpl

Inherited from UALimitAlarmImpl.constructor
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:13
Parameters
- options: InternalBaseNodeOptions & { eventNotifier?: number; symbolicName?: string }
Returns UAExclusiveLimitAlarmImpl

Properties

ackedState

ackedState: UATwoStateVariableEx

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariableEx

addComment

addComment: UAMethod

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

branchId: UAProperty<NodeId, NodeId>

Readonly browseName

browseName: QualifiedName

clientUserId

clientUserId: UAProperty<string, String>

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

confirmedState: UATwoStateVariableEx

disable

disable: UAMethod

enable

enable: UAMethod

enabledState

enabledState: UATwoStateVariableEx

eventId

eventId: UAProperty<Buffer, ByteString>

Readonly eventNotifier

eventNotifier: number

eventType

eventType: UAProperty<NodeId, NodeId>

Optional firstInGroup

firstInGroup: UAAlarmGroup

Optional firstInGroupFlag

firstInGroupFlag: UABaseDataVariable<boolean, Boolean>

Optional highHighLimit

highHighLimit: UAProperty<number, Double>

Optional highLimit

highLimit: UAProperty<number, Double>

inputNode

inputNode: UAProperty<NodeId, NodeId>

lastSeverity

lastSeverity: UAConditionVariable<number, UInt16>

Optional latchedState

latchedState: UATwoStateVariableEx

limitState

limitState: UAExclusiveLimitStateMachineEx

Optional localTime

localTime: UAProperty<DTTimeZone, ExtensionObject>

Optional lowLimit

lowLimit: UAProperty<number, Double>

Optional lowLowLimit

lowLowLimit: UAProperty<number, Double>

Optional maxTimeShelved

maxTimeShelved: UAProperty<number, Double>

message

message: UAProperty<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 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: UATwoStateVariableEx

Optional placeInService

placeInService: UAMethod

quality

quality: UAConditionVariable<StatusCode, StatusCode>

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>

severity

severity: UAProperty<number, UInt16>

Optional shelvingState

shelvingState: UAShelvedStateMachineEx

Optional silence

silence: UAMethod

Optional silenceState

silenceState: UATwoStateVariableEx

sourceName

sourceName: UAProperty<string, String>

sourceNode

sourceNode: UAProperty<NodeId, NodeId>

Optional suppress

suppress: UAMethod

suppressedOrShelved

suppressedOrShelved: UAProperty<boolean, Boolean>

Optional suppressedState

suppressedState: UATwoStateVariableEx

Readonly symbolicName

symbolicName: string

time

time: UAProperty<Date, DateTime>

Optional unsuppress

unsuppress: UAMethod

Static MaxDuration

MaxDuration: number

Static defaultSeverity

defaultSeverity: number

Static typeDefinition

typeDefinition: NodeId

Accessors

accessRestrictions

get accessRestrictions(): AccessRestrictionsFlag

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:278
Returns AccessRestrictionsFlag

addressSpace

get addressSpace(): IAddressSpace

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:57
Returns IAddressSpace

description

get description(): LocalizedText

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:61
Returns LocalizedText

displayName

get displayName(): LocalizedText[]

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:59
Returns LocalizedText[]

fromStateNode

get fromStateNode(): BaseNode

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:234
Returns BaseNode

hasMethods

get hasMethods(): boolean

Implementation of UAExclusiveLimitAlarmEx.hasMethods
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:22
returns true if the object has some opcua methods

Returns boolean

isFalseSubStateOf

get isFalseSubStateOf(): BaseNode

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:214
property

isFalseSubStateOf

Returns BaseNode

isTrueSubStateOf

get isTrueSubStateOf(): BaseNode

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:219
property

isTrueSubStateOf

Returns BaseNode

modellingRule

get modellingRule(): ModellingRuleType

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:88
property

modellingRule

Returns ModellingRuleType

namespace

get namespace(): INamespace

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:99
Returns INamespace

namespaceIndex

get namespaceIndex(): number

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:75
namespace index

Returns number

namespaceUri

get namespaceUri(): string

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:79
namespace uri

Returns string

parent

get parent(): BaseNode

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:83
the parent node

Returns BaseNode

parentNodeId

get parentNodeId(): NodeId

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:71
Returns NodeId

rolePermissions

get rolePermissions(): RolePermissionType[]

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:276
Returns RolePermissionType[]

toStateNode

get toStateNode(): BaseNode

- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:233
Returns BaseNode

typeDefinition

get typeDefinition(): NodeId

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

Returns NodeId

typeDefinitionObj

get typeDefinitionObj(): UAObjectType

- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:12
Returns UAObjectType

Methods

_acknowledge_branch

_acknowledge_branch(conditionEventId: Buffer, comment: LocalizedText | LocalizedTextLike, branch: ConditionSnapshot, message: string): StatusCode

Inherited from UALimitAlarmImpl._acknowledge_branch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:40
Parameters
- conditionEventId: Buffer
- comment: LocalizedText | LocalizedTextLike
- branch: ConditionSnapshot
- message: string
Returns StatusCode

_assert_valid

_assert_valid(): void

Inherited from UALimitAlarmImpl._assert_valid
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:144
Returns void

_bubble_up_event

_bubble_up_event(eventData: IEventData): void

Inherited from UALimitAlarmImpl._bubble_up_event
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:30
Parameters
- eventData: IEventData
Returns void

_calculateConditionInfo

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

Inherited from UALimitAlarmImpl._calculateConditionInfo
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:115
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?: ConditionRefreshCache): void

Inherited from UALimitAlarmImpl._conditionRefresh
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:31
Parameters
- Optional _cache: ConditionRefreshCache
Returns void

_onInputDataValueChange

_onInputDataValueChange(dataValue: DataValue): void

Inherited from UALimitAlarmImpl._onInputDataValueChange
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:93
Parameters
- dataValue: DataValue
Returns void

_on_child_added

_on_child_added(): void

Inherited from UALimitAlarmImpl._on_child_added
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:254
Returns void

_on_child_removed

_on_child_removed(obj: BaseNode): void

Inherited from UALimitAlarmImpl._on_child_removed
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:255
Parameters
- obj: BaseNode
Returns void

_raiseAuditConditionAcknowledgeEvent

_raiseAuditConditionAcknowledgeEvent(branch: ConditionSnapshot): void

Inherited from UALimitAlarmImpl._raiseAuditConditionAcknowledgeEvent
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:38
Parameters
- branch: ConditionSnapshot
Returns void

_raiseAuditConditionConfirmEvent

_raiseAuditConditionConfirmEvent(branch: ConditionSnapshot): void

Inherited from UALimitAlarmImpl._raiseAuditConditionConfirmEvent
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:39
Parameters
- branch: ConditionSnapshot
Returns void

_resend_conditionEvents

_resend_conditionEvents(): 0 | 1

Inherited from UALimitAlarmImpl._resend_conditionEvents
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:171
Returns 0 | 1

_setStateBasedOnInputValue

_setStateBasedOnInputValue(value: number): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_exclusive_limit_alarm_impl.d.ts:37
Parameters
- value: number
Returns void

_signalInitialCondition

_signalInitialCondition(): void

Inherited from UALimitAlarmImpl._signalInitialCondition
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:116
Returns void

_signalNewCondition

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

Inherited from UALimitAlarmImpl._signalNewCondition
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_exclusive_limit_alarm_impl.d.ts:36
Parameters
- stateName: string
- isActive: boolean
- value: string
Returns void

acknowledgeAndAutoConfirmBranch

acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedText | LocalizedTextLike): void

Inherited from UALimitAlarmImpl.acknowledgeAndAutoConfirmBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:61
method

acknowledgeAndAutoConfirmBranch

Parameters
- branch: ConditionSnapshot
- comment: LocalizedText | LocalizedTextLike
Returns void

activateAlarm

activateAlarm(): void

Inherited from UALimitAlarmImpl.activateAlarm
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:41
Returns void

addReference

addReference(reference: AddReferenceOpts): void

Inherited from UALimitAlarmImpl.addReference
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:201
method

addReference

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

allReferences

allReferences(): UAReference[]

Inherited from UALimitAlarmImpl.allReferences
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:185
Returns UAReference[]

autoConfirmBranch

autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void

Inherited from UALimitAlarmImpl.autoConfirmBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:55
method

autoConfirmBranch

Parameters
- branch: ConditionSnapshot
- comment: LocalizedTextLike
Returns void

browseNode

browseNode(browseDescription: BrowseDescriptionOptions2, context?: ISessionContext): ReferenceDescription[]

Inherited from UALimitAlarmImpl.browseNode
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:184
browse the node to extract information requested in browseDescription and returns an array with reference descriptions

Parameters
- browseDescription: BrowseDescriptionOptions2
- Optional context: ISessionContext
Returns ReferenceDescription[]

browseNodeByTargetName

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

Inherited from UALimitAlarmImpl.browseNodeByTargetName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:176
method

browseNodeByTargetName

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

clone

clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAObject

Inherited from UALimitAlarmImpl.clone
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:18
Parameters
- options: CloneOptions
- Optional optionalFilter: CloneFilter
- Optional extraInfo: CloneExtraInfo
Returns UAObject

conditionOfNode

conditionOfNode(): UAObject | UAVariable

Inherited from UALimitAlarmImpl.conditionOfNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:149
method

conditionOfNode

Returns UAObject | UAVariable

createBranch

createBranch(): ConditionSnapshot

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

createBranch

Returns ConditionSnapshot

currentBranch

currentBranch(): ConditionSnapshot

Inherited from UALimitAlarmImpl.currentBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:170
method

currentBranch

Returns ConditionSnapshot

deactivateAlarm

deactivateAlarm(): void

Inherited from UALimitAlarmImpl.deactivateAlarm
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:42
Returns void

deleteBranch

deleteBranch(branch: ConditionSnapshot): void

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

deleteBranch

Parameters
- branch: ConditionSnapshot
Returns void

desactivateAlarm

desactivateAlarm(): void

Inherited from UALimitAlarmImpl.desactivateAlarm
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:46
deprecated

use deactivateAlarm instead (with no s after de-activate)

Returns void

dispose

dispose(): void

Inherited from UALimitAlarmImpl.dispose
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:40
the dispose method should be called when the node is no longer used, to release back pointer to the address space and clear caches.

Returns void

dumpXML

dumpXML(xmlWriter: XmlWriter): void

Inherited from UALimitAlarmImpl.dumpXML
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:248
Parameters
- xmlWriter: XmlWriter
Returns void

findHierarchicalReferences

findHierarchicalReferences(): UAReference[]

Inherited from UALimitAlarmImpl.findHierarchicalReferences
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:230
Returns UAReference[]

findReference

findReference(strReference: string | NodeId | UAReferenceType, isForward?: boolean): UAReference

Inherited from UALimitAlarmImpl.findReference
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:102
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
- strReference: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference

findReferences

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

Inherited from UALimitAlarmImpl.findReferences
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:101
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
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference[]

findReferencesAsObject

findReferencesAsObject(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): BaseNode[]

Inherited from UALimitAlarmImpl.findReferencesAsObject
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:104
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
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns BaseNode[]

findReferencesEx

findReferencesEx(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): UAReference[]

Inherited from UALimitAlarmImpl.findReferencesEx
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:100
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
- referenceType: string | NodeId | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

findReferencesExAsObject(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): BaseNode[]

Inherited from UALimitAlarmImpl.findReferencesExAsObject
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:103
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
- referenceType: string | NodeId | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from UALimitAlarmImpl.fullName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:167
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string

getAccessRestrictions

getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag

Inherited from UALimitAlarmImpl.getAccessRestrictions
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:279
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

getAggregates(): BaseNode[]

Inherited from UALimitAlarmImpl.getAggregates
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:108
return an array with the Aggregates of this object.

Returns BaseNode[]

getBranchCount

getBranchCount(): number

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

getBranchIds

getBranchIds(): NodeId[]

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

getBranches

getBranches(): ConditionSnapshot[]

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

getChildByName

getChildByName(browseName: QualifiedNameOptions): BaseNode
getChildByName(browseName: string, namespaceIndex?: number): BaseNode

Inherited from UALimitAlarmImpl.getChildByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:231
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from UALimitAlarmImpl.getChildByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:232
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getComponentByName

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

Inherited from UALimitAlarmImpl.getComponentByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:132
retrieve a component by name

Parameters
- browseName: QualifiedNameOptions
Returns UAObject | UAVariable
Inherited from UALimitAlarmImpl.getComponentByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:133
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns UAObject | UAVariable

getComponents

getComponents(): BaseNode[]

Inherited from UALimitAlarmImpl.getComponents
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:112
return an array with the components of this object.

Returns BaseNode[]

getCurrentConditionInfo

getCurrentConditionInfo(): ConditionInfo

Inherited from UALimitAlarmImpl.getCurrentConditionInfo
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:85
Returns ConditionInfo

getDisplayName

getDisplayName(locale?: string): string

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

getEnabledState

getEnabledState(): boolean

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

getEnabledState

Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

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

getEnabledStateAsString

Returns string

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

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

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from UALimitAlarmImpl.getEventSources
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:124
return a array with the event source of this object.

Returns BaseNode[]

getFalseSubStates

getFalseSubStates(): UAStateVariable<LocalizedText>[]

Inherited from UALimitAlarmImpl.getFalseSubStates
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:224
method

getFalseSubStates

Returns UAStateVariable<LocalizedText>[]

return an array with the SubStates of this object.

getFolderElementByName

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

Inherited from UALimitAlarmImpl.getFolderElementByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:142
retrieve a folder element by name

Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from UALimitAlarmImpl.getFolderElementByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:143
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getFolderElements

getFolderElements(): BaseNodeImpl[]

Inherited from UALimitAlarmImpl.getFolderElements
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:147
returns the list of nodes that this folder object organizes

Returns BaseNodeImpl[]

getHighHighLimit

getHighHighLimit(): number

Inherited from UALimitAlarmImpl.getHighHighLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:57
method

getHighHighLimit

Returns number

getHighLimit

getHighLimit(): number

Inherited from UALimitAlarmImpl.getHighLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:62
method

getHighLimit

Returns number

getInputNodeNode

getInputNodeNode(): UAVariable

Inherited from UALimitAlarmImpl.getInputNodeNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:68
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

Inherited from UALimitAlarmImpl.getInputNodeValue
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:73
method

getInputNodeValue

Returns any

getLowLimit

getLowLimit(): number

Inherited from UALimitAlarmImpl.getLowLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:67
method

getLowLimit

Returns number

getLowLowLimit

getLowLowLimit(): number

Inherited from UALimitAlarmImpl.getLowLowLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:72
method

getLowLowLimit

Returns number

getMaxTimeShelved

getMaxTimeShelved(): number

Inherited from UALimitAlarmImpl.getMaxTimeShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:57
note: return a Duration

Returns number

getMethodById

getMethodById(nodeId: NodeId): UAMethod

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

Parameters
- nodeId: NodeId
Returns UAMethod

getMethodByName

getMethodByName(methodName: QualifiedNameOptions): UAMethod
getMethodByName(methodName: string, namespaceIndex?: number): UAMethod

Inherited from UALimitAlarmImpl.getMethodByName
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:23
Parameters
- methodName: QualifiedNameOptions
Returns UAMethod
Inherited from UALimitAlarmImpl.getMethodByName
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:24
Parameters
- methodName: string
- Optional namespaceIndex: number
Returns UAMethod

getMethods

getMethods(): UAMethod[]

Inherited from UALimitAlarmImpl.getMethods
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:25
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from UALimitAlarmImpl.getNotifiers
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:120
return a array with the notifiers of this object.

Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from UALimitAlarmImpl.getProperties
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:116
return a array with the properties of this object.

Returns BaseNode[]

getPropertyByName

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

Inherited from UALimitAlarmImpl.getPropertyByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:137
retrieve a property by name

Parameters
- browseName: QualifiedNameOptions
Returns UAVariable
Inherited from UALimitAlarmImpl.getPropertyByName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:138
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns UAVariable

getRolePermissions

getRolePermissions(inherited: boolean): RolePermissionType[]

Inherited from UALimitAlarmImpl.getRolePermissions
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:275
Parameters
- inherited: boolean
Returns RolePermissionType[]

getSuppressedOrShelved

getSuppressedOrShelved(): boolean

Inherited from UALimitAlarmImpl.getSuppressedOrShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:48
Returns boolean

getTrueSubStates

getTrueSubStates(): UAStateVariable<LocalizedText>[]

Inherited from UALimitAlarmImpl.getTrueSubStates
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:229
method

getTrueSubStates

Returns UAStateVariable<LocalizedText>[]

return an array with the SubStates of this object.

getUserWriteMask

getUserWriteMask(): number

Inherited from UALimitAlarmImpl.getUserWriteMask
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:164
Returns number

getWriteMask

getWriteMask(): number

Inherited from UALimitAlarmImpl.getWriteMask
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:163
Returns number

installPostInstallFunc

installPostInstallFunc(f: () => void): void

Inherited from UALimitAlarmImpl.installPostInstallFunc
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:253
Parameters
- f: () => void
  - - (): void
    - Returns void
Returns void

install_extra_properties

install_extra_properties(): void

Inherited from UALimitAlarmImpl.install_extra_properties
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:207
private

Returns void

isSuppressedOrShelved

isSuppressedOrShelved(): boolean

Inherited from UALimitAlarmImpl.isSuppressedOrShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:47
Returns boolean

on

on(eventName: string, eventHandler: any): UAExclusiveLimitAlarmImpl

Inherited from UALimitAlarmImpl.on
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:35
Parameters
- eventName: string
- eventHandler: any
Returns UAExclusiveLimitAlarmImpl

ownReferences

ownReferences(): UAReference[]

Inherited from UALimitAlarmImpl.ownReferences
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:168
Returns UAReference[]

propagate_back_references

propagate_back_references(): void

Inherited from UALimitAlarmImpl.propagate_back_references
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:239
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 UALimitAlarmImpl.raiseConditionEvent
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:157
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: BaseNode | EventTypeLike, data: RaiseEventData): void

Inherited from UALimitAlarmImpl.raiseEvent
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:29
Raise a transient Event

Parameters
- eventType: BaseNode | EventTypeLike
- data: RaiseEventData
Returns void

raiseNewBranchState

raiseNewBranchState(branch: ConditionSnapshot): void

Inherited from UALimitAlarmImpl.raiseNewBranchState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:165
Parameters
- branch: ConditionSnapshot
Returns void

raiseNewCondition

raiseNewCondition(conditionInfo: ConditionInfoOptions): void

Inherited from UALimitAlarmImpl.raiseNewCondition
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:164
method

raiseNewCondition

Parameters
- conditionInfo: ConditionInfoOptions
Returns void

readAttribute

readAttribute(context: ISessionContext, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike): DataValue

Inherited from UALimitAlarmImpl.readAttribute
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:17
Parameters
- context: ISessionContext
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike
Returns DataValue

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from UALimitAlarmImpl.removeReference
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:202
Parameters
- referenceOpts: AddReferenceOpts
Returns void

resolveNodeId

resolveNodeId(nodeId: NodeIdLike): NodeId

Inherited from UALimitAlarmImpl.resolveNodeId
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:206
Parameters
- nodeId: NodeIdLike
Returns NodeId

setAccessRestrictions

setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void

Inherited from UALimitAlarmImpl.setAccessRestrictions
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:277
setAccessRestriction

Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void

setDescription

setDescription(value: LocalizedText): void

Inherited from UALimitAlarmImpl.setDescription
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:62
Parameters
- value: LocalizedText
Returns void

setDisplayName

setDisplayName(value: LocalizedText[]): void

Inherited from UALimitAlarmImpl.setDisplayName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:60
Parameters
- value: LocalizedText[]
Returns void

setHighHighLimit

setHighHighLimit(value: number): void

Inherited from UALimitAlarmImpl.setHighHighLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:77
method

setHighHighLimit

Parameters
- value: number
Returns void

setHighLimit

setHighLimit(value: number): void

Inherited from UALimitAlarmImpl.setHighLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:82
method

setHighLimit

Parameters
- value: number
Returns void

setLocalTime

setLocalTime(time: TimeZoneDataType): void

Inherited from UALimitAlarmImpl.setLocalTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:138
method

setLocalTime (optional)

Parameters
- time: TimeZoneDataType
Returns void

setLowLimit

setLowLimit(value: number): void

Inherited from UALimitAlarmImpl.setLowLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:87
method

setLowLimit

Parameters
- value: number
Returns void

setLowLowLimit

setLowLowLimit(value: number): void

Inherited from UALimitAlarmImpl.setLowLowLimit
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_limit_alarm_impl.d.ts:92
method

setLowLowLimit

Parameters
- value: number
Returns void

setMaxTimeShelved

setMaxTimeShelved(duration: number): void

Inherited from UALimitAlarmImpl.setMaxTimeShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:53
note: duration must be greater than 10ms and lesser than 2**31 ms

Parameters
- duration: number
Returns void

setReceiveTime

setReceiveTime(time: Date): void

Inherited from UALimitAlarmImpl.setReceiveTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:133
method

setReceiveTime

Parameters
- time: Date
Returns void

setRolePermissions

setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void

Inherited from UALimitAlarmImpl.setRolePermissions
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:274
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void

setSourceName

setSourceName(name: string): void

Inherited from UALimitAlarmImpl.setSourceName
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_base_event_impl.d.ts:23
method

setSourceName

Parameters
- name: string
Returns void

setSourceNode

setSourceNode(node: NodeId | BaseNode): void

Inherited from UALimitAlarmImpl.setSourceNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_base_event_impl.d.ts:28
method

setSourceNode

Parameters
- node: NodeId | BaseNode
Returns void

setTime

setTime(time: Date): void

Inherited from UALimitAlarmImpl.setTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:143
method

setTime

Parameters
- time: Date
Returns void

toString

toString(): string

Inherited from UALimitAlarmImpl.toString
- Defined in node-opcua-address-space/dist/src/ua_object_impl.d.ts:32
Returns string

uninstall_extra_properties

uninstall_extra_properties(reference: UAReference): void

Inherited from UALimitAlarmImpl.uninstall_extra_properties
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:208
Parameters
- reference: UAReference
Returns void

unpropagate_back_references

unpropagate_back_references(): void

Inherited from UALimitAlarmImpl.unpropagate_back_references
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:252
Undo the effect of propagate_back_references

Returns void

updateState

updateState(): void

Inherited from UALimitAlarmImpl.updateState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:74
Returns void

writeAttribute

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

Inherited from UALimitAlarmImpl.writeAttribute
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:166
Parameters
- context: ISessionContext
- writeValue: WriteValueOptions
- 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 UALimitAlarmImpl.install_condition_refresh_handle
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:72
Parameters
- addressSpace: AddressSpacePrivate
Returns void

Static install_method_handle_on_type

install_method_handle_on_type(addressSpace: AddressSpacePrivate): void

Inherited from UALimitAlarmImpl.install_method_handle_on_type
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:37
Parameters
- addressSpace: AddressSpacePrivate
Returns void

Static instantiate

instantiate(namespace: NamespacePrivate, type: string | NodeId | UAEventType, options: any, data: any): UAExclusiveLimitAlarmImpl

Inherited from UALimitAlarmImpl.instantiate
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_exclusive_limit_alarm_impl.d.ts:35
method

(static)instantiate

Parameters
- namespace: NamespacePrivate
- type: string | NodeId | UAEventType
- options: any
- data: any
Returns UAExclusiveLimitAlarmImpl

Static makeAttributeEventName

makeAttributeEventName(attributeId: AttributeIds): string

Inherited from UALimitAlarmImpl.makeAttributeEventName
- Defined in node-opcua-address-space/dist/src/base_node_impl.d.ts:53
Parameters
- attributeId: AttributeIds
Returns string

Static with_condition_method

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

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

Parameters
- inputArguments: VariantOptions[]
- context: ISessionContext
- 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: UAConditionImpl) => StatusCode
  - - (eventId: Buffer, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionImpl): StatusCode
    - Parameters
      - eventId: Buffer
      - comment: LocalizedText
      - branch: ConditionSnapshot
      - conditionNode: UAConditionImpl
      Returns StatusCode
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: InternalBaseNodeOptions & { eventNotifier?: number; symbolicName?: string }

Returns UAExclusiveLimitAlarmImpl

Properties

ackedState

acknowledge

activeState

addComment

Optional audibleEnabled

Optional audibleSound

Optional baseHighHighLimit

Optional baseHighLimit

Optional baseLowLimit

Optional baseLowLowLimit

branchId

Readonly browseName

clientUserId

comment

conditionClassId

conditionClassName

conditionName

conditionRefresh

conditionRefresh2

Optional conditionSubClassId

Optional conditionSubClassName

Optional confirm

Optional confirmedState

disable

enable

enabledState

eventId

Readonly eventNotifier

eventType

Optional firstInGroup

Optional firstInGroupFlag

Optional highHighLimit

Optional highLimit

inputNode

lastSeverity

Optional latchedState

limitState

Optional localTime

Optional lowLimit

Optional lowLowLimit

Optional maxTimeShelved

message

Readonly nodeClass

Readonly nodeId

Optional nodeVersion

Optional offDelay

Optional onDelay

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

Optional outOfServiceState

Optional placeInService

quality

Optional reAlarmRepeatCount

Optional reAlarmTime

receiveTime

Optional removeFromService

Optional reset

retain

severity

Optional shelvingState

Optional silence

Optional silenceState

sourceName

sourceNode

Optional suppress