Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UADiscreteAlarm

The DiscreteAlarmType is used to classify Types into Alarm Conditions where the input for the Alarm may take on only a certain number of possible values (e.g. true/false, running/stopped/terminating).

Hierarchy

Implements

  • UAObject

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ackedState

ackedState: UATwoStateVariable

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariable

Optional confirm

confirm: UAMethod

Optional confirmedState

confirmedState: UATwoStateVariable

Readonly eventNotifier

eventNotifier: number

inputNode

inputNode: UAVariableT<NodeId, NodeId>

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

typeDefinitionObj

  • get typeDefinitionObj(): UAObjectTypePublic

Methods

_bubble_up_event

  • _bubble_up_event(eventData: any): void

_calculateConditionInfo

  • 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

_onInputDataValueChange

  • _onInputDataValueChange(newValue: DataValue): void

_signalInitialCondition

  • _signalInitialCondition(): void

_signalNewCondition

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

  • Parameters

    • stateName: string | null
    • Optional isActive: boolean
    • Optional value: string

    Returns void

activateAlarm

  • activateAlarm(): void
  • method

    activateAlarm

    Returns void

clone

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

deactivateAlarm

  • deactivateAlarm(): void
  • method

    deactivateAlarm

    Returns void

desactivateAlarm

  • desactivateAlarm(): void
  • deprecated

    use deactivateAlarm instead

    Returns void

dispose

  • dispose(): void

  • Returns void

getCurrentConditionInfo

getInputNodeNode

  • 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
  • method

    getInputNodeValue

    Returns any | null

getMaxTimeShelved

  • getMaxTimeShelved(): number
  • method

    getMaxTimeShelved

    Returns number

getMethodByName

  • getMethodByName(methodName: string): UAMethodPublic | null

getMethods

  • getMethods(): UAMethodPublic[]

getSuppressedOrShelved

  • getSuppressedOrShelved(): boolean

isSuppressedOrShelved

  • isSuppressedOrShelved(): boolean
  • method

    isSuppressedOrShelved

    Returns boolean

on

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

  • Parameters

    • eventName: string
    • eventHandler: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • eventName: "addComment"
    • eventHandler: function

        • Parameters

          Returns void

    Returns this

  • Parameters

    • eventName: "branch_deleted"
    • eventHandler: function
        • (branchId: string): void

        • Parameters

          • branchId: string

          Returns void

    Returns this

raiseEvent

readAttribute

setMaxTimeShelved

  • setMaxTimeShelved(duration: number): void
  • 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

updateState

  • updateState(): void

  • Returns void

Static instantiate

Generated using TypeDoc