Class ConditionSnapshot

subscribe now with sterfive to access the online-user manual

Hierarchy

EventEmitter
- ConditionSnapshot

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

branchId

branchId: NodeId

condition

condition: BaseNode

eventData

eventData: IEventData

Static normalizeName

normalizeName: (str: string) => string

Type declaration

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

Methods

_constructEventData

_constructEventData(): IEventData

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

_get_var

_get_var(varName: string): any

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

_set_var

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

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

getAckedState

getAckedState(): boolean

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

getActiveState

getActiveState(): boolean

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

getBranchId

getBranchId(): NodeId

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

getBrandId

Returns NodeId

getComment

getComment(): LocalizedText

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

getComment

Returns LocalizedText

getConfirmedState

getConfirmedState(): boolean

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

getEnabledState

getEnabledState(): boolean

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

getEnabledState

Returns boolean

getEnabledStateAsString

getEnabledStateAsString(): string

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

getEnabledStateAsString

Returns string

getEventId

getEventId(): Buffer

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

getEventId

Returns Buffer

getEventType

getEventType(): NodeId

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

getEventType return {NodeId}

Returns NodeId

getLastSeverity

getLastSeverity(): number

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

getLastSeverity

Returns number

getMessage

getMessage(): LocalizedText

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

getQuality

getQuality(): StatusCode

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

getQuality

Returns StatusCode

getRetain

getRetain(): boolean

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

getRetain

Returns boolean

getSeverity

getSeverity(): number

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

getSeverity

Returns number

getSourceName

getSourceName(): LocalizedText

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

getSourceNode

getSourceNode(): NodeId

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

getSourceNode return {NodeId}

Returns NodeId

getSuppressedState

getSuppressedState(): boolean

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

getSuppressedState

Returns boolean

isCurrentBranch

isCurrentBranch(): boolean

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

on

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

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

readValue

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

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

renewEventId

renewEventId(): void

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

renewEventId

Returns void

resolveSelectClause

resolveSelectClause(selectClause: SimpleAttributeOperand): NodeId

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

resolveSelectClause

Parameters
- selectClause: SimpleAttributeOperand
Returns NodeId

setAckedState

setAckedState(ackedState: boolean): StatusCode

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

setActiveState

setActiveState(newActiveState: boolean): StatusCode

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

setClientUserId

setClientUserId(userIdentity: string): void

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

setClientUserId

Parameters
- userIdentity: string
Returns void

setComment

setComment(txtMessage: LocalizedTextLike): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:104
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: LocalizedTextLike
Returns void

setConfirmedState

setConfirmedState(confirmedState: boolean): void

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

setConfirmedStateIfExists

setConfirmedStateIfExists(confirmedState: boolean): void

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

setEnabledState

setEnabledState(value: boolean): void

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

setEnabledState

Parameters
- value: boolean
Returns void

void

setLastSeverity

setLastSeverity(severity: number): void

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

setLastSeverity

Parameters
- severity: number
Returns void

setLocalTime

setLocalTime(localTime: TimeZoneDataType): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:187
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

setMessage

setMessage(txtMessage: LocalizedText | LocalizedTextLike): void

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

setMessage

Parameters
- txtMessage: LocalizedText | LocalizedTextLike
Returns void

setQuality

setQuality(quality: StatusCode): void

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

method

setQuality

Parameters
- quality: StatusCode
Returns void

setReceiveTime

setReceiveTime(time: DateTime): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:166
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 node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:65
method

setRetain

Parameters
- retainFlag: boolean
Returns void

setSeverity

setSeverity(severity: number): void

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

setSeverity

Parameters
- severity: number
Returns void

setShelvingState

setShelvingState(): void

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

setSuppressedState

setSuppressedState(suppressed: boolean): void

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

setSuppressedState

Parameters
- suppressed: boolean
Returns void

setTime

setTime(time: Date): void

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:176
(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 node-opcua-address-space/dist/src/alarms_and_conditions/condition_snapshot.d.ts:222
Returns string

Generated using TypeDoc