UAAlarmConditionEx | NodeOPCUA reference documentation

Hierarchy

UAAlarmConditionHelper
UAAlarmCondition_Base
UAAcknowledgeableConditionEx
- UAAlarmConditionEx

Implemented by

UAAlarmConditionImpl

Index

Properties

Accessors

Methods

Properties

ackedState

ackedState: UATwoStateVariableEx

acknowledge

acknowledge: UAMethod

activeState

activeState: UATwoStateVariableEx

addComment

addComment: UAMethod

Optional audibleEnabled

audibleEnabled: UAProperty<boolean, Boolean>

Optional audibleSound

audibleSound: UAAudioVariable<Buffer>

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>

Readonly hasMethods

hasMethods: boolean

inputNode

inputNode: UAProperty<NodeId, NodeId>

lastSeverity

lastSeverity: UAConditionVariable<number, UInt16>

Optional latchedState

latchedState: UATwoStateVariableEx

Optional localTime

localTime: UAProperty<DTTimeZone, ExtensionObject>

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

time

time: UAProperty<Date, DateTime>

Optional unsuppress

unsuppress: UAMethod

Accessors

accessRestrictions

get accessRestrictions(): AccessRestrictionsFlag

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:64
Returns AccessRestrictionsFlag

addressSpace

get addressSpace(): IAddressSpace

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:56
Returns IAddressSpace

description

get description(): LocalizedText

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:59
Returns LocalizedText

displayName

get displayName(): LocalizedText[]

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:58
Returns LocalizedText[]

modellingRule

get modellingRule(): ModellingRuleType

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:62
Returns ModellingRuleType

namespace

get namespace(): INamespace

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:68
Returns INamespace

namespaceIndex

get namespaceIndex(): number

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:66
Returns number

namespaceUri

get namespaceUri(): string

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:67
Returns string

parent

get parent(): BaseNode

- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:110
Returns BaseNode

parentNodeId

get parentNodeId(): NodeId

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:63
Returns NodeId

rolePermissions

get rolePermissions(): RolePermissionType[]

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:65
Returns RolePermissionType[]

typeDefinition

get typeDefinition(): NodeId

- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:112
Returns NodeId

typeDefinitionObj

get typeDefinitionObj(): UAObjectType

- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:111
Returns UAObjectType

Methods

acknowledgeAndAutoConfirmBranch

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

Inherited from UAAcknowledgeableConditionEx.acknowledgeAndAutoConfirmBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:20
Parameters
- branch: ConditionSnapshot
- comment: LocalizedText | LocalizedTextLike
Returns void

activateAlarm

activateAlarm(): void

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

addReference

addReference(options: AddReferenceOpts): void

Inherited from UAAcknowledgeableConditionEx.addReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:75
Parameters
- options: AddReferenceOpts
Returns void

allReferences

allReferences(): UAReference[]

Inherited from UAAcknowledgeableConditionEx.allReferences
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:142
Returns UAReference[]

autoConfirmBranch

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

Inherited from UAAcknowledgeableConditionEx.autoConfirmBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_acknowledgeable_condition_impl.d.ts:19
Parameters
- branch: ConditionSnapshot
- comment: LocalizedTextLike
Returns void

browseNode

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

Inherited from UAAcknowledgeableConditionEx.browseNode
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:155
browse the node to extract information requested in browseDescription

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

browseNodeByTargetName

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

Inherited from UAAcknowledgeableConditionEx.browseNodeByTargetName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:98
Parameters
- relativePathElement: RelativePathElement
- isLast: boolean
Returns NodeId[]

clone

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

Inherited from UAAcknowledgeableConditionEx.clone
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:123
Parameters
- options: CloneOptions
- Optional optionalFilter: CloneFilter
- Optional extraInfo: CloneExtraInfo
Returns UAObject

conditionOfNode

conditionOfNode(): UAObject | UAVariable

Inherited from UAAcknowledgeableConditionEx.conditionOfNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:33
Returns UAObject | UAVariable

createBranch

createBranch(): ConditionSnapshot

Inherited from UAAcknowledgeableConditionEx.createBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:25
Returns ConditionSnapshot

currentBranch

currentBranch(): ConditionSnapshot

Inherited from UAAcknowledgeableConditionEx.currentBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:37
Returns ConditionSnapshot

deactivateAlarm

deactivateAlarm(): void

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

deleteBranch

deleteBranch(branch: ConditionSnapshot): void

Inherited from UAAcknowledgeableConditionEx.deleteBranch
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:26
Parameters
- branch: ConditionSnapshot
Returns void

findReference

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

Inherited from UAAcknowledgeableConditionEx.findReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:123
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
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference

findReferences

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

Inherited from UAAcknowledgeableConditionEx.findReferences
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:112
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 UAAcknowledgeableConditionEx.findReferencesAsObject
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:141
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 UAAcknowledgeableConditionEx.findReferencesEx
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:105
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 UAAcknowledgeableConditionEx.findReferencesExAsObject
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:130
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 UAAcknowledgeableConditionEx.fullName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:74
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 UAAcknowledgeableConditionEx.getAccessRestrictions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:174
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 UAAcknowledgeableConditionEx.getAggregates
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:185
Returns BaseNode[]

getBranchCount

getBranchCount(): number

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

getBranchIds

getBranchIds(): NodeId[]

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

getBranches

getBranches(): ConditionSnapshot[]

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

getChildByName

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

Inherited from UAAcknowledgeableConditionEx.getChildByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:143
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from UAAcknowledgeableConditionEx.getChildByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:144
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getComponentByName

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

Inherited from UAAcknowledgeableConditionEx.getComponentByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:39
Parameters
- componentName: QualifiedNameOptions
Returns UAObject | UAVariable
Inherited from UAAcknowledgeableConditionEx.getComponentByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:40
Parameters
- componentName: string
- Optional namespaceIndex: number
Returns UAObject | UAVariable

getComponents

getComponents(): BaseNode[]

Inherited from UAAcknowledgeableConditionEx.getComponents
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:44
Returns BaseNode[]

getCurrentConditionInfo

getCurrentConditionInfo(): ConditionInfo

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

getDisplayName

getDisplayName(locale?: string): string

Inherited from UAAcknowledgeableConditionEx.getDisplayName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:93
Parameters
- Optional locale: string
  
  the locale of the text to return (e.g. en-EN)
Returns string

getEnabledState

getEnabledState(): boolean

Inherited from UAAcknowledgeableConditionEx.getEnabledState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:27
Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

Inherited from UAAcknowledgeableConditionEx.getEnabledStateAsString
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:28
Returns string

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAAcknowledgeableConditionEx.getEventSourceOfs
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:88
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from UAAcknowledgeableConditionEx.getEventSources
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:83
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode[]

getFolderElementByName

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

Inherited from UAAcknowledgeableConditionEx.getFolderElementByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:115
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from UAAcknowledgeableConditionEx.getFolderElementByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:116
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getInputNodeNode

getInputNodeNode(): UAVariable

Inherited from UAAlarmConditionHelper.getInputNodeNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:16
Returns UAVariable

getInputNodeValue

getInputNodeValue(): any

Inherited from UAAlarmConditionHelper.getInputNodeValue
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:17
Returns any

getMaxTimeShelved

getMaxTimeShelved(): number

Inherited from UAAlarmConditionHelper.getMaxTimeShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:15
Returns number

getMethodById

getMethodById(nodeId: NodeId): UAMethod

Inherited from UAAcknowledgeableConditionEx.getMethodById
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:117
Parameters
- nodeId: NodeId
Returns UAMethod

getMethodByName

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

Inherited from UAAcknowledgeableConditionEx.getMethodByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:118
Parameters
- methodName: QualifiedNameOptions
Returns UAMethod
Inherited from UAAcknowledgeableConditionEx.getMethodByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:119
Parameters
- methodName: string
- Optional namespaceIndex: number
Returns UAMethod

getMethods

getMethods(): UAMethod[]

Inherited from UAAcknowledgeableConditionEx.getMethods
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:120
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from UAAcknowledgeableConditionEx.getNotifiers
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:46
Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from UAAcknowledgeableConditionEx.getProperties
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:45
Returns BaseNode[]

getPropertyByName

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

Inherited from UAAcknowledgeableConditionEx.getPropertyByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:41
Parameters
- propertyName: QualifiedNameOptions
Returns UAVariable
Inherited from UAAcknowledgeableConditionEx.getPropertyByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:42
Parameters
- propertyName: string
- Optional namespaceIndex: number
Returns UAVariable

getRolePermissions

getRolePermissions(inherited: boolean): RolePermissionType[]

Inherited from UAAcknowledgeableConditionEx.getRolePermissions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:161
Parameters
- inherited: boolean
Returns RolePermissionType[]

getSuppressedOrShelved

getSuppressedOrShelved(): boolean

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

installInputNodeMonitoring

installInputNodeMonitoring(inputNode: NodeId | BaseNode): void

Inherited from UAAlarmConditionHelper.installInputNodeMonitoring
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:20
Parameters
- inputNode: NodeId | BaseNode
Returns void

install_extra_properties

install_extra_properties(): void

Inherited from UAAcknowledgeableConditionEx.install_extra_properties
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:97
private

Returns void

isSuppressedOrShelved

isSuppressedOrShelved(): boolean

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

on

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

Overrides UAAcknowledgeableConditionEx.on
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:23
Parameters
- eventName: string
- eventHandler: any
Returns UAAlarmConditionEx

raiseConditionEvent

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

Inherited from UAAcknowledgeableConditionEx.raiseConditionEvent
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:34
Parameters
- branch: ConditionSnapshot
- renewEventId: boolean
Returns void

raiseEvent

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

Inherited from UAAcknowledgeableConditionEx.raiseEvent
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:121
Parameters
- eventType: BaseNode | EventTypeLike
- eventData: RaiseEventData
Returns void

raiseNewBranchState

raiseNewBranchState(branch: ConditionSnapshot): void

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

raiseNewCondition

raiseNewCondition(conditionInfo: ConditionInfoOptions): void

Inherited from UAAcknowledgeableConditionEx.raiseNewCondition
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:35
Parameters
- conditionInfo: ConditionInfoOptions
Returns void

readAttribute

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

Inherited from UAAcknowledgeableConditionEx.readAttribute
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:77
Parameters
- context: ISessionContext
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike
Returns DataValue

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from UAAcknowledgeableConditionEx.removeReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:76
Parameters
- referenceOpts: AddReferenceOpts
Returns void

setAccessRestrictions

setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void

Inherited from UAAcknowledgeableConditionEx.setAccessRestrictions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:165
setAccessRestriction

Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void

setEnabledState

setEnabledState(requestedEnabledState: boolean): StatusCode

Inherited from UAAcknowledgeableConditionEx.setEnabledState
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:29
Parameters
- requestedEnabledState: boolean
Returns StatusCode

setLocalTime

setLocalTime(time: TimeZoneDataType): void

Inherited from UAAcknowledgeableConditionEx.setLocalTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:31
Parameters
- time: TimeZoneDataType
Returns void

setMaxTimeShelved

setMaxTimeShelved(duration: number): void

Inherited from UAAlarmConditionHelper.setMaxTimeShelved
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_alarm_condition_impl.d.ts:14
Parameters
- duration: number
Returns void

setReceiveTime

setReceiveTime(time: Date): void

Inherited from UAAcknowledgeableConditionEx.setReceiveTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:30
Parameters
- time: Date
Returns void

setRolePermissions

setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void

Inherited from UAAcknowledgeableConditionEx.setRolePermissions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:160
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void

setSourceName

setSourceName(name: string): void

Inherited from UAAcknowledgeableConditionEx.setSourceName
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_base_event_impl.d.ts:6
Parameters
- name: string
Returns void

setSourceNode

setSourceNode(node: NodeId | BaseNode): void

Inherited from UAAcknowledgeableConditionEx.setSourceNode
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_base_event_impl.d.ts:7
Parameters
- node: NodeId | BaseNode
Returns void

setTime

setTime(time: Date): void

Inherited from UAAcknowledgeableConditionEx.setTime
- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/ua_condition_impl.d.ts:32
Parameters
- time: Date
Returns void

updateState

updateState(): void

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

writeAttribute

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

Inherited from UAAcknowledgeableConditionEx.writeAttribute
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:78
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

subscribe now with sterfive to access the online-user manual

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

ackedState

acknowledge

activeState

addComment

Optional audibleEnabled

Optional audibleSound

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

Readonly hasMethods

inputNode

lastSeverity

Optional latchedState

Optional localTime

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

suppressedOrShelved

Optional suppressedState

time

Optional unsuppress

Accessors

accessRestrictions

Returns AccessRestrictionsFlag

addressSpace

Returns IAddressSpace

description

Returns LocalizedText

displayName

Returns LocalizedText[]

modellingRule