APIs

Show:

Constructor

ConditionSnapshot

(
  • condition
  • branchId
)
private

Parameters:

  • condition Object
  • branchId Object

Methods

getEnabledState

() Boolean

Returns:

Boolean:

getEnabledStateAsString

() String

Returns:

String:

getEventId

() ByteString

Returns:

ByteString:

getLastSeverity

() UInt16

Returns:

UInt16:

getRetain

() Boolean

Returns:

Boolean:

getSeverity

() UInt16

Returns:

UInt16:

getSourceNode!~YUIDOC_LINE~!return

()

getSuppressedState

() Boolean

Returns:

Boolean:

readValue

(
  • nodeId
  • selectClause
)
Variant

Parameters:

  • nodeId NodeId
  • selectClause SelectClause

Returns:

resolveSelectClause

(
  • selectClause
)

Parameters:

  • selectClause SelectClause

setClientUserId

(
  • userIdentity
)

Parameters:

  • userIdentity String

setComment

(
  • txtMessage
)

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.

Parameters:

setEnabledState

(
  • value
)

Parameters:

  • value Boolean

Returns:

void

setLastSeverity

(
  • severity
)

Parameters:

  • severity UInt16

setLocalTime

(
  • localTime
)

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.

Parameters:

setMessage

(
  • txtMessage
)

Parameters:

setQuality

(
  • quality
)

set the condition quality

Parameters:

setReceiveTime

(
  • time
)

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.

Parameters:

  • time Date

    : UTCTime

setRetain

(
  • retainFlag
)

Parameters:

  • retainFlag Boolean

setSeverity

(
  • severity
)

Parameters:

  • severity UInt16

setSuppressedState

(
  • suppressed
)

Parameters:

  • suppressed Boolean

setTime

(
  • time
)

(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.

Parameters:

  • time Date