Class UAAcknowledgeableConditionBase

Hierarchy

UAConditionBase
UAConditionBase
UAConditionBase
- UAAcknowledgeableConditionBase
  - UAAlarmConditionBase

Implements

UAObject
UAObject
UAObject
UAObject
UAObject
UAObject
UAObject
UAObject
UAObject

Constructors

constructor

Accessors

Methods

Constructors

constructor

new UAAcknowledgeableConditionBase(options: any): UAAcknowledgeableConditionBase

Inherited from UAAcknowledgeableConditionBase.constructor

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

Properties

ackedState

ackedState: UATwoStateVariable

acknowledge

acknowledge: UAMethod

addComment

addComment: UAMethod

branchId

branchId: UAVariableT<NodeId, NodeId>

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>

lastSeverity

lastSeverity: UAConditionVariable<StatusCode, StatusCode>

localTime

localTime: UAVariableT<any, ExtensionObject>

message

message: UAVariableT<LocalizedText, LocalizedText>

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.

quality

quality: UAConditionVariable<StatusCode, StatusCode>

receiveTime

receiveTime: UAVariableT<Date, DateTime>

retain

retain: UAVariableT<boolean, Boolean>

severity

severity: UAVariableT<UInt16, UInt16>

sourceName

sourceName: UAVariableT<string, String>

sourceNode

sourceNode: UAVariableT<NodeId, NodeId>

Readonly symbolicName

symbolicName: string

time

time: UAVariableT<DateTime, DateTime>

Static defaultSeverity

defaultSeverity: number = 250

Static typeDefinition

typeDefinition: NodeId = resolveNodeId("ConditionType")

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

_acknowledge_branch

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

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:178
Parameters
- conditionEventId: Buffer
- comment: string | LocalizedTextLike | LocalizedText
- branch: ConditionSnapshot
- message: string
Returns ConstantStatusCode

_assert_valid

_assert_valid(): void

Inherited from UAAcknowledgeableConditionBase._assert_valid

Overrides UAAcknowledgeableConditionBase._assert_valid
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:400
Returns void

_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

_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

_raiseAuditConditionAcknowledgeEvent

_raiseAuditConditionAcknowledgeEvent(branch: ConditionSnapshot): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:106
Parameters
- branch: ConditionSnapshot
Returns void

_raiseAuditConditionConfirmEvent

_raiseAuditConditionConfirmEvent(branch: ConditionSnapshot): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:144
Parameters
- branch: ConditionSnapshot
Returns void

_resend_conditionEvents

_resend_conditionEvents(): 1 | 0

Inherited from UAAcknowledgeableConditionBase._resend_conditionEvents

Overrides UAAcknowledgeableConditionBase._resend_conditionEvents
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:567
Returns 1 | 0

acknowledgeAndAutoConfirmBranch

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

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:285
method

acknowledgeAndAutoConfirmBranch

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

autoConfirmBranch

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

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:266
method

autoConfirmBranch

Parameters
- branch: ConditionSnapshot
- comment: LocalizedTextLike
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

conditionOfNode

conditionOfNode(): UAObject | UAVariable | null

Inherited from UAAcknowledgeableConditionBase.conditionOfNode

Overrides UAAcknowledgeableConditionBase.conditionOfNode
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:423
method

conditionOfNode

Returns UAObject | UAVariable | null

createBranch

createBranch(): ConditionSnapshot

Inherited from UAAcknowledgeableConditionBase.createBranch

Overrides UAAcknowledgeableConditionBase.createBranch
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:262
method

createBranch

Returns ConditionSnapshot

currentBranch

currentBranch(): ConditionSnapshot

Inherited from UAAcknowledgeableConditionBase.currentBranch

Overrides UAAcknowledgeableConditionBase.currentBranch
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:563
method

currentBranch

Returns ConditionSnapshot

deleteBranch

deleteBranch(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionBase.deleteBranch

Overrides UAAcknowledgeableConditionBase.deleteBranch
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:273
method

deleteBranch

Parameters
- branch: ConditionSnapshot
Returns void

getBranchCount

getBranchCount(): number

Inherited from UAAcknowledgeableConditionBase.getBranchCount

Overrides UAAcknowledgeableConditionBase.getBranchCount
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:244
Returns number

getBranchIds

getBranchIds(): NodeId[]

Inherited from UAAcknowledgeableConditionBase.getBranchIds

Overrides UAAcknowledgeableConditionBase.getBranchIds
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:254
Returns NodeId[]

getBranches

getBranches(): ConditionSnapshot[]

Inherited from UAAcknowledgeableConditionBase.getBranches

Overrides UAAcknowledgeableConditionBase.getBranches
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:248
Returns ConditionSnapshot[]

getEnabledState

getEnabledState(): boolean

Inherited from UAAcknowledgeableConditionBase.getEnabledState

Overrides UAAcknowledgeableConditionBase.getEnabledState
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:285
method

getEnabledState

Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

Inherited from UAAcknowledgeableConditionBase.getEnabledStateAsString

Overrides UAAcknowledgeableConditionBase.getEnabledStateAsString
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:293
method

getEnabledStateAsString

Returns string

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[]

on

on(eventName: string, eventHandler: function): this
on(eventName: "addComment", eventHandler: function): this
on(eventName: "branch_deleted", eventHandler: function): this
on(eventName: string, eventHandler: function): this
on(eventName: "acknowledged" | "confirmed", 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
Inherited from UAAcknowledgeableConditionBase.on

Overrides UAAcknowledgeableConditionBase.on
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:27
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_acknowledgeable_condition_base.ts:29
Parameters
- eventName: "acknowledged" | "confirmed"
- eventHandler: function
  - - (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot): void
    - Parameters
      - eventId: Buffer | null
      - comment: LocalizedText
      - branch: ConditionSnapshot
      Returns void
Returns this

raiseConditionEvent

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

Inherited from UAAcknowledgeableConditionBase.raiseConditionEvent

Overrides UAAcknowledgeableConditionBase.raiseConditionEvent
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:445
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: 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

raiseNewBranchState

raiseNewBranchState(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionBase.raiseNewBranchState

Overrides UAAcknowledgeableConditionBase.raiseNewBranchState
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:549
Parameters
- branch: ConditionSnapshot
Returns void

raiseNewCondition

raiseNewCondition(conditionInfo: ConditionInfoOptions): void

Inherited from UAAcknowledgeableConditionBase.raiseNewCondition

Overrides UAAcknowledgeableConditionBase.raiseNewCondition
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:489
method

raiseNewCondition

Parameters
- conditionInfo: ConditionInfoOptions
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

setLocalTime

setLocalTime(time: TimeZoneDataType): void

Inherited from UAAcknowledgeableConditionBase.setLocalTime

Overrides UAAcknowledgeableConditionBase.setLocalTime
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:388
method

setLocalTime (optional)

Parameters
- time: TimeZoneDataType
Returns void

setReceiveTime

setReceiveTime(time: Date): void

Inherited from UAAcknowledgeableConditionBase.setReceiveTime

Overrides UAAcknowledgeableConditionBase.setReceiveTime
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:380
method

setReceiveTime

Parameters
- time: Date
Returns void

setTime

setTime(time: Date): void

Inherited from UAAcknowledgeableConditionBase.setTime

Overrides UAAcknowledgeableConditionBase.setTime
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:396
method

setTime

Parameters
- time: Date
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

Static install_condition_refresh_handle

install_condition_refresh_handle(addressSpace: AddressSpacePrivate): void

Inherited from UAAcknowledgeableConditionBase.install_condition_refresh_handle

Overrides UAAcknowledgeableConditionBase.install_condition_refresh_handle
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:117
Parameters
- addressSpace: AddressSpacePrivate
Returns void

Static install_method_handle_on_type

install_method_handle_on_type(addressSpace: AddressSpacePrivate): void

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_acknowledgeable_condition_base.ts:99
Parameters
- addressSpace: AddressSpacePrivate
Returns void

Static instantiate

instantiate(namespace: Namespace, conditionTypeId: NodeId | string | UAEventType, options: any, data: any): UAConditionBase

Inherited from UAAcknowledgeableConditionBase.instantiate

Overrides UAAcknowledgeableConditionBase.instantiate
- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/ua_condition_base.ts:108
Parameters
- namespace: Namespace
- conditionTypeId: NodeId | string | UAEventType
- options: any
- data: any
Returns UAConditionBase

Static with_condition_method

with_condition_method(inputArguments: VariantLike[], context: SessionContext, callback: function, inner_func: function): void

Inherited from UAAcknowledgeableConditionBase.with_condition_method

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

Parameters
- inputArguments: VariantLike[]
- context: SessionContext
- callback: function
  - - (err: Error | null, result?: object): void
    - Parameters
      - err: Error | null
      - Optional result: object
        
        statusCode: StatusCode
      Returns void
- inner_func: function
  - - (eventId: ByteString, comment: LocalizedText, branch: ConditionSnapshot, conditionNode: UAConditionBase): StatusCode
    - Parameters
      - eventId: ByteString
      - comment: LocalizedText
      - branch: ConditionSnapshot
      - conditionNode: UAConditionBase
      Returns StatusCode
Returns void

Class UAAcknowledgeableConditionBase

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns UAAcknowledgeableConditionBase

Properties

ackedState

acknowledge

addComment

branchId

comment

conditionClassId

conditionClassName

conditionName

Optional confirm

Optional confirmedState

disable

enable

enabledState

eventId

Readonly eventNotifier

eventType

lastSeverity

localTime

message

Readonly nodeClass

Optional nodeVersion

quality

receiveTime

retain

severity

sourceName

sourceNode

Readonly symbolicName

time

Static defaultSeverity

Static typeDefinition

Accessors

hasMethods

Returns boolean

typeDefinitionObj

Returns UAObjectTypePublic

Methods

_acknowledge_branch

Parameters

conditionEventId: Buffer

comment: string | LocalizedTextLike | LocalizedText

branch: ConditionSnapshot

message: string

Returns ConstantStatusCode

_assert_valid

Returns void

_bubble_up_event

Parameters

eventData: any

Returns void

_conditionRefresh

Parameters

Optional _cache: any

Returns void

_raiseAuditConditionAcknowledgeEvent

Parameters

branch: ConditionSnapshot

Returns void

_raiseAuditConditionConfirmEvent

Parameters

branch: ConditionSnapshot

Returns void

_resend_conditionEvents

Returns 1 | 0

acknowledgeAndAutoConfirmBranch

Parameters

branch: ConditionSnapshot