ConditionSnapshot | NodeOPCUA reference documentation

Hierarchy

EventEmitter
- ConditionSnapshot

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConditionSnapshot(condition: UAConditionBase, branchId: NodeId): ConditionSnapshot

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:25
Parameters
- condition: UAConditionBase
- branchId: NodeId
Returns ConditionSnapshot

Properties

branchId

branchId: NodeId

condition

condition: UAConditionBase

eventData

eventData: IEventData

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static normalizeName

normalizeName: (str: string) => string

Type declaration

- (str: string): string
- Parameters
  - str: string
  Returns string

Methods

_constructEventData

_constructEventData(): IEventData

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:34
Returns IEventData

_get_var

_get_var(varName: string): any

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:44
Parameters
- varName: string
Returns any

_set_var

_set_var(varName: string, dataType: DataType, value: any): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:45
Parameters
- varName: string
- dataType: DataType
- value: any
Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ConditionSnapshot

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getAckedState

getAckedState(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:202
Returns boolean

getActiveState

getActiveState(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:220
Returns boolean

getBranchId

getBranchId(): NodeId

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:50
method

getBrandId

Returns NodeId

getComment

getComment(): LocalizedText

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:92
method

getComment

Returns LocalizedText

getConfirmedState

getConfirmedState(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:204
Returns boolean

getEnabledState

getEnabledState(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:76
method

getEnabledState

Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:87
method

getEnabledStateAsString

Returns string

getEventId

getEventId(): Buffer

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:55
method

getEventId

Returns Buffer

getEventType

getEventType(): NodeId

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:199
method

getEventType return {NodeId}

Returns NodeId

getLastSeverity

getLastSeverity(): number

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:147
method

getLastSeverity

Returns number

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getMessage

getMessage(): LocalizedText

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:200
Returns LocalizedText

getQuality

getQuality(): StatusCode

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:127
method

getQuality

Returns StatusCode

getRetain

getRetain(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:60
method

getRetain

Returns boolean

getSeverity

getSeverity(): number

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:137
method

getSeverity

Returns number

getSourceName

getSourceName(): LocalizedText

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:189
Returns LocalizedText

getSourceNode

getSourceNode(): NodeId

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:194
method

getSourceNode return {NodeId}

Returns NodeId

getSuppressedState

getSuppressedState(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:214
method

getSuppressedState

Returns boolean

isCurrentBranch

isCurrentBranch(): boolean

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:201
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ConditionSnapshot

on

on(eventName: "value_changed", eventHandler: (node: UAVariable, variant: Variant) => void): ConditionSnapshot

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:16
Parameters
- eventName: "value_changed"
- eventHandler: (node: UAVariable, variant: Variant) => void
  - - (node: UAVariable, variant: Variant): void
    - Parameters
      - node: UAVariable
      - variant: Variant
      Returns void
Returns ConditionSnapshot

once

once(event: string | symbol, listener: (...args: any[]) => void): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ConditionSnapshot

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ConditionSnapshot

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ConditionSnapshot

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

readValue

readValue(sessionContext: SessionContext, nodeId: NodeId, selectClause: SimpleAttributeOperand): Variant

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:43
Parameters
- sessionContext: SessionContext
- nodeId: NodeId
- selectClause: SimpleAttributeOperand
Returns Variant

removeAllListeners

removeAllListeners(event?: string | symbol): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ConditionSnapshot

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ConditionSnapshot

renewEventId

renewEventId(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:71
method

renewEventId

Returns void

resolveSelectClause

resolveSelectClause(selectClause: SimpleAttributeOperand): NodeId

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:39
method

resolveSelectClause

Parameters
- selectClause: SimpleAttributeOperand
Returns NodeId

setAckedState

setAckedState(ackedState: boolean): ConstantStatusCode

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:203
Parameters
- ackedState: boolean
Returns ConstantStatusCode

setActiveState

setActiveState(newActiveState: boolean): StatusCode

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:221
Parameters
- newActiveState: boolean
Returns StatusCode

setClientUserId

setClientUserId(userIdentity: string): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:116
method

setClientUserId

Parameters
- userIdentity: string
Returns void

setComment

setComment(txtMessage: string | LocalizedTextOptions): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:105
Set condition comment

Comment contains the last comment provided for a certain state (ConditionBranch). It may have been provided by an AddComment Method, some other Method or in some other manner. The initial value of this Variable is null, unless it is provided in some other manner. If a Method provides as an option the ability to set a Comment, then the value of this Variable is reset to null if an optional comment is not provided.

method

setComment

Parameters
- txtMessage: string | LocalizedTextOptions
Returns void

setConfirmedState

setConfirmedState(confirmedState: boolean): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:206
Parameters
- confirmedState: boolean
Returns void

setConfirmedStateIfExists

setConfirmedStateIfExists(confirmedState: boolean): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:205
Parameters
- confirmedState: boolean
Returns void

setEnabledState

setEnabledState(value: boolean): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:82
method

setEnabledState

Parameters
- value: boolean
Returns void

void

setLastSeverity

setLastSeverity(severity: number): void

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

setLastSeverity

Parameters
- severity: number
Returns void

setLocalTime

setLocalTime(localTime: TimeZoneDataType): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:188
LocalTime is a structure containing the Offset and the DaylightSavingInOffset flag. The Offset specifies the time difference (in minutes) between the Time Property and the time at the location in which the event was issued. If DaylightSavingInOffset is TRUE, then Standard/Daylight savings time (DST) at the originating location is in effect and Offset includes the DST c orrection. If FALSE then the Offset does not include DST correction and DST may or may not have been in effect.

method

setLocalTime

Parameters
- localTime: TimeZoneDataType
Returns void

setMaxListeners

setMaxListeners(n: number): ConditionSnapshot

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ConditionSnapshot

setMessage

setMessage(txtMessage: string | LocalizedText | LocalizedTextOptions): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:111
method

setMessage

Parameters
- txtMessage: string | LocalizedText | LocalizedTextOptions
Returns void

setQuality

setQuality(quality: StatusCode): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:122
set the condition quality

method

setQuality

Parameters
- quality: StatusCode
Returns void

setReceiveTime

setReceiveTime(time: DateTime): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:167
setReceiveTime

(as per OPCUA 1.0.3 part 5)

ReceiveTime provides the time the OPC UA Server received the Event from the underlying device of another Server.

ReceiveTime is analogous to ServerTimestamp defined in Part 4, i.e. in the case where the OPC UA Server gets an Event from another OPC UA Server, each Server applies its own ReceiveTime. That implies that a Client may get the same Event, having the same EventId, from different Servers having different values of the ReceiveTime.

The ReceiveTime shall always be returned as value and the Server is not allowed to return a StatusCode for the ReceiveTime indicating an error.

method

setReceiveTime

Parameters
- time: DateTime
  
  : UTCTime
Returns void

setRetain

setRetain(retainFlag: boolean): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:66
method

setRetain

Parameters
- retainFlag: boolean
Returns void

setSeverity

setSeverity(severity: number): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:132
method

setSeverity

Parameters
- severity: number
Returns void

setShelvingState

setShelvingState(): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:222
Returns void

setSuppressedState

setSuppressedState(suppressed: boolean): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:219
method

setSuppressedState

Parameters
- suppressed: boolean
Returns void

setTime

setTime(time: Date): void

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:177
(as per OPCUA 1.0.3 part 5) Time provides the time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device. Once set, intermediate OPC UA Servers shall not alter the value.

method

setTime

Parameters
- time: Date
Returns void

toString

toString(): string

- Defined in packages/node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:223
Returns string

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

condition: UAConditionBase

branchId: NodeId

Returns ConditionSnapshot

Properties

branchId

condition

eventData

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Static normalizeName

Type declaration

Parameters

str: string

Returns string

Methods

_constructEventData

Returns IEventData

_get_var

Parameters

varName: string

Returns any

_set_var

Parameters

varName: string

dataType: DataType

value: any

Returns void

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ConditionSnapshot

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getAckedState

Returns boolean

getActiveState

Returns boolean

getBranchId

Returns NodeId

getComment

Returns LocalizedText

getConfirmedState

Returns boolean

getEnabledState

Returns boolean

getEnabledStateAsString

Returns string

getEventId

Returns Buffer

getEventType

Returns NodeId

getLastSeverity

Returns number

getMaxListeners

Returns number

getMessage

Returns LocalizedText

getQuality

Returns StatusCode

getRetain