Class UALimitAlarm

Hierarchy

UAAlarmConditionBase
UAAlarmConditionBase
- UALimitAlarm

Implements

UAObject
UAObject

Constructors

constructor

Accessors

Methods

Constructors

constructor

new UALimitAlarm(options: any): UALimitAlarm

Inherited from UAAcknowledgeableConditionBase.constructor

Overrides UAAcknowledgeableConditionBase.constructor
- Defined in packages/node-opcua-address-space/src/ua_object.ts:34
Parameters
- options: any
Returns UALimitAlarm

Properties

_dataType

_dataType: any

ackedState

ackedState: UATwoStateVariable

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariable

Optional confirm

confirm: UAMethod

Optional confirmedState

confirmedState: UATwoStateVariable

Readonly eventNotifier

eventNotifier: number

Optional highHighLimit

highHighLimit: UAVariable

Optional highLimit

highLimit: UAVariable

inputNode

inputNode: UAVariableT<NodeId, NodeId>

Optional lowLimit

lowLimit: UAVariable

Optional lowLowLimit

lowLowLimit: UAVariable

maxTimeShelved

maxTimeShelved: UAVariable

Readonly nodeClass

nodeClass: Object = NodeClass.Object

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.

shelvingState

shelvingState: ShelvingStateMachine

sourceName

sourceName: UAVariableT<string, String>

sourceNode

sourceNode: UAVariableT<NodeId, NodeId>

suppressedOrShelved

suppressedOrShelved: UAVariable

suppressedState

suppressedState: UATwoStateVariable

Readonly symbolicName

symbolicName: string

Static MaxDuration

MaxDuration: number = Math.pow(2, 31)

static
property: MaxDuration

Accessors

hasMethods

get hasMethods(): boolean

Inherited from UAAcknowledgeableConditionBase.hasMethods

Overrides UAAcknowledgeableConditionBase.hasMethods
- Defined in packages/node-opcua-address-space/src/ua_object.ts:77
returns true if the object has some opcua methods

Returns boolean

typeDefinitionObj

get typeDefinitionObj(): UAObjectTypePublic

Inherited from UAAcknowledgeableConditionBase.typeDefinitionObj

Overrides UAAcknowledgeableConditionBase.typeDefinitionObj
- Defined in packages/node-opcua-address-space/src/ua_object.ts:32
Returns UAObjectTypePublic

Methods

_bubble_up_event

_bubble_up_event(eventData: any): void

Inherited from UAAcknowledgeableConditionBase._bubble_up_event

Overrides UAAcknowledgeableConditionBase._bubble_up_event
- Defined in packages/node-opcua-address-space/src/ua_object.ts:136
Parameters
- eventData: any
Returns void

_calculateConditionInfo

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

Inherited from UAAlarmConditionBase._calculateConditionInfo

Overrides UAAlarmConditionBase._calculateConditionInfo
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:445
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 | null
  
  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

Overrides UAAcknowledgeableConditionBase._conditionRefresh
- Defined in packages/node-opcua-address-space/src/ua_object.ts:182
Parameters
- Optional _cache: any
Returns void

_onInputDataValueChange

_onInputDataValueChange(newValue: DataValue): void

Inherited from UAAlarmConditionBase._onInputDataValueChange

Overrides UAAlarmConditionBase._onInputDataValueChange
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:331
Parameters
- newValue: DataValue
Returns void

_signalInitialCondition

_signalInitialCondition(): void

Inherited from UAAlarmConditionBase._signalInitialCondition

Overrides UAAlarmConditionBase._signalInitialCondition
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:468
Returns void

_signalNewCondition

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

Inherited from UAAlarmConditionBase._signalNewCondition

Overrides UAAlarmConditionBase._signalNewCondition
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:473
Parameters
- stateName: string | null
- Optional isActive: boolean
- Optional value: string
Returns void

activateAlarm

activateAlarm(): void

Inherited from UAAlarmConditionBase.activateAlarm

Overrides UAAlarmConditionBase.activateAlarm
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:211
method

activateAlarm

Returns void

clone

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

Inherited from UAAcknowledgeableConditionBase.clone

Overrides UAAcknowledgeableConditionBase.clone
- Defined in packages/node-opcua-address-space/src/ua_object.ts:60
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAObject

deactivateAlarm

deactivateAlarm(): void

Inherited from UAAlarmConditionBase.deactivateAlarm

Overrides UAAlarmConditionBase.deactivateAlarm
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:222
method

deactivateAlarm

Returns void

desactivateAlarm

desactivateAlarm(): void

Inherited from UAAlarmConditionBase.desactivateAlarm

Overrides UAAlarmConditionBase.desactivateAlarm
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:231
deprecated

use deactivateAlarm instead

Returns void

dispose

dispose(): void

Inherited from UAAlarmConditionBase.dispose

Overrides UAAlarmConditionBase.dispose
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:201
Returns void

getCurrentConditionInfo

getCurrentConditionInfo(): ConditionInfo

Inherited from UAAlarmConditionBase.getCurrentConditionInfo

Overrides UAAlarmConditionBase.getCurrentConditionInfo
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:399
Returns ConditionInfo

getHighHighLimit

getHighHighLimit(): number

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:142
method

getHighHighLimit

Returns number

getHighLimit

getHighLimit(): number

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:153
method

getHighLimit

Returns number

getInputNodeNode

getInputNodeNode(): UAVariable | null

Inherited from UAAlarmConditionBase.getInputNodeNode

Overrides UAAlarmConditionBase.getInputNodeNode
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:307
method

getInputNodeNode

Returns UAVariable | null

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 | null

Inherited from UAAlarmConditionBase.getInputNodeValue

Overrides UAAlarmConditionBase.getInputNodeValue
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:316
method

getInputNodeValue

Returns any | null

getLowLimit

getLowLimit(): number

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:164
method

getLowLimit

Returns number

getLowLowLimit

getLowLowLimit(): number

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:175
method

getLowLowLimit

Returns number

getMaxTimeShelved

getMaxTimeShelved(): number

Inherited from UAAlarmConditionBase.getMaxTimeShelved

Overrides UAAlarmConditionBase.getMaxTimeShelved
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:285
method

getMaxTimeShelved

Returns number

getMethodByName

getMethodByName(methodName: string): UAMethodPublic | null

Inherited from UAAcknowledgeableConditionBase.getMethodByName

Overrides UAAcknowledgeableConditionBase.getMethodByName
- Defined in packages/node-opcua-address-space/src/ua_object.ts:81
Parameters
- methodName: string
Returns UAMethodPublic | null

getMethods

getMethods(): UAMethodPublic[]

Inherited from UAAcknowledgeableConditionBase.getMethods

Overrides UAAcknowledgeableConditionBase.getMethods
- Defined in packages/node-opcua-address-space/src/ua_object.ts:85
Returns UAMethodPublic[]

getSuppressedOrShelved

getSuppressedOrShelved(): boolean

Inherited from UAAlarmConditionBase.getSuppressedOrShelved

Overrides UAAlarmConditionBase.getSuppressedOrShelved
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:260
method

getSuppressedOrShelved

Returns boolean

isSuppressedOrShelved

isSuppressedOrShelved(): boolean

Inherited from UAAlarmConditionBase.isSuppressedOrShelved

Overrides UAAlarmConditionBase.isSuppressedOrShelved
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:239
method

isSuppressedOrShelved

Returns boolean

on

on(eventName: string, eventHandler: function): this
on(eventName: "addComment", eventHandler: function): this
on(eventName: "branch_deleted", eventHandler: function): this

Inherited from UAAcknowledgeableConditionBase.on

Overrides UAAcknowledgeableConditionBase.on
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:44
Parameters
- eventName: string
- eventHandler: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from UAAcknowledgeableConditionBase.on

Overrides UAAcknowledgeableConditionBase.on
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:47
Parameters
- eventName: "addComment"
- eventHandler: function
  - - (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot): void
    - Parameters
      - eventId: Buffer | null
      - comment: LocalizedText
      - branch: ConditionSnapshot
      Returns void
Returns this
Inherited from UAAcknowledgeableConditionBase.on

Overrides UAAcknowledgeableConditionBase.on
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:52
Parameters
- eventName: "branch_deleted"
- eventHandler: function
  - - (branchId: string): void
    - Parameters
      - branchId: string
      Returns void
Returns this

raiseEvent

raiseEvent(eventType: EventTypeLike | BaseNode, data: RaiseEventData): void

Inherited from UAAcknowledgeableConditionBase.raiseEvent

Overrides UAAcknowledgeableConditionBase.raiseEvent
- Defined in packages/node-opcua-address-space/src/ua_object.ts:92
Raise a transient Event

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

readAttribute

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

Inherited from UAAcknowledgeableConditionBase.readAttribute

Overrides UAAcknowledgeableConditionBase.readAttribute
- Defined in packages/node-opcua-address-space/src/ua_object.ts:43
Parameters
- context: SessionContext
- attributeId: AttributeIds
Returns DataValue

setHighHighLimit

setHighHighLimit(value: number): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:186
method

setHighHighLimit

Parameters
- value: number
Returns void

setHighLimit

setHighLimit(value: number): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:198
method

setHighLimit

Parameters
- value: number
Returns void

setLowLimit

setLowLimit(value: number): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:209
method

setLowLimit

Parameters
- value: number
Returns void

setLowLowLimit

setLowLowLimit(value: number): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_limit_alarm.ts:220
method

setLowLowLimit

Parameters
- value: number
Returns void

setMaxTimeShelved

setMaxTimeShelved(duration: number): void

Inherited from UAAlarmConditionBase.setMaxTimeShelved

Overrides UAAlarmConditionBase.setMaxTimeShelved
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:271
method

setMaxTimeShelved

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

toString

toString(): string

Inherited from UAAcknowledgeableConditionBase.toString

Overrides UAAcknowledgeableConditionBase.toString
- Defined in packages/node-opcua-address-space/src/ua_object.ts:186
Returns string

updateState

updateState(): void

Inherited from UAAlarmConditionBase.updateState

Overrides UAAlarmConditionBase.updateState
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:325
Returns void

Static instantiate

instantiate(namespace: Namespace, alarmConditionTypeId: UAEventType | string | NodeId, options: any, data: any): UAAlarmConditionBase

Inherited from UAAlarmConditionBase.instantiate

Overrides UAAlarmConditionBase.instantiate
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_alarm_condition_base.ts:59
method

(static)UAAlarmConditionBase.instantiate

Parameters
- namespace: Namespace
- alarmConditionTypeId: UAEventType | string | NodeId
- options: any
- data: any
Returns UAAlarmConditionBase

Class UALimitAlarm

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns UALimitAlarm

Properties

_dataType

ackedState

acknowledge

activeState

Optional confirm

Optional confirmedState

Readonly eventNotifier

Optional highHighLimit

Optional highLimit

inputNode

Optional lowLimit

Optional lowLowLimit

maxTimeShelved

Readonly nodeClass

Optional nodeVersion

shelvingState

sourceName

sourceNode

suppressedOrShelved

suppressedState

Readonly symbolicName

Static MaxDuration

Accessors

hasMethods

Returns boolean

typeDefinitionObj

Returns UAObjectTypePublic

Methods

_bubble_up_event

Parameters

eventData: any

Returns void

_calculateConditionInfo

Parameters

stateData: string | null

isActive: boolean

value: string

oldCondition: ConditionInfo

Returns ConditionInfo

_conditionRefresh

Parameters

Optional _cache: any

Returns void

_onInputDataValueChange

Parameters

newValue: DataValue

Returns void

_signalInitialCondition

Returns void

_signalNewCondition

Parameters

stateName: string | null

Optional isActive: boolean

Optional value: string

Returns void

activateAlarm

Returns void

clone

Parameters

options: any

Optional optionalFilter: any

Optional extraInfo: any

Returns UAObject

deactivateAlarm

Returns void

desactivateAlarm

Returns void