APIs

Show:

Methods

(static)UAAcknowledgeableConditionBase.instantiate

(
  • addressSpace
  • conditionTypeId
  • options
  • data
)
UAAcknowledgeableConditionBase

Parameters:

(static)UAAlarmConditionBase.instantiate

(
  • alarmConditionTypeId
  • options
  • data
)

Parameters:

  • alarmConditionTypeId Object
  • options Object
    • inputNode
    • optionals

      could be "SuppressedState" , "ShelvingState"

    • [maxTimeShelved] Number | Null optional

      max TimeShelved duration (in ms)

  • data Object

_calculateConditionInfo

(
  • stateData
  • isActive
  • value
  • oldCondition
)
ConditionInfo

Parameters:

  • stateData Object

    the new calculated state of the alarm

  • isActive Boolean
  • value Number

    the new value of the limit alarm

  • oldCondition ConditionInfo

    given for information purpose

    • severity
    • quality
    • message
    • retain

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.

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 }); };

_confirm_branch

(
  • eventId
  • comment
  • branch
  • message
)
private

Parameters:

  • eventId Object
  • comment Object
  • branch Object
  • message Object

_setEnabledState

(
  • requestedEnabledState
)
StatusCode private

Parameters:

  • requestedEnabledState Boolean

Returns:

StatusCode: StatusCodes.Good if successful or BadConditionAlreadyEnabled/BadConditionAlreadyDisabled

acknowledgeAndAutoConfirmBranch

(
  • branch
  • comment
)

Parameters:

  • branch Object
  • comment Object

autoConfirmBranch

(
  • branch
  • comment
)

Parameters:

  • branch Object
  • comment Object

getBranchCount

() Number

Returns:

Number:

getEnabledState

() Boolean

Returns:

Boolean:

getEnabledStateAsString

() String

Returns:

String:

getInputNodeNode

() BaseNode

Returns:

BaseNode:

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

getMaxTimeShelved

() Duration

Returns:

Duration:

getSuppressedOrShelved

() Boolean

Returns:

Boolean:

isSuppressedOrShelved

() Boolean

Returns:

Boolean:

post_initialize

() private

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

(
  • branch
)

Parameters:

setLocalTime

(
  • time
)

Parameters:

  • time Date

setMaxTimeShelved

(
  • duration
)

Parameters:

  • duration Object

    ( Duration in Milliseconds)

setReceiveTime

(
  • time
)

Parameters:

  • time Date

Properties

inputNode

UAVariable dataType is DataType.NodeId

The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values; it is up to the system to determine which Variable’s NodeId is used.

maxTimeShelved

UAVariable

The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved. The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve Method call. If a value that exceeds the value of this property is passed to the TimedShelve Method, than a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that an Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.

shelvingState

UAShelvingStateMachine

ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. It is quite often used to block nuisance Alarms.

suppressedState

UATwoStateVariable

SuppressState is used internally by a Server to automatically suppress Alarms due to system specific reasons. For example a system may be configured to suppress Alarms that are associated with machinery that is shutdown, such as a low level Alarm for a tank that is currently not in use.

suppressedState

UAVariable - DataType Boolean

The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.

Events

acknowledged

Event Payload:

confirmed

Event Payload:

  • eventId Object
  • comment Object
  • eventId raised Object

    when the alarm branch has been confirmed