Class AlarmEvent

java.lang.Object

neqsim.process.alarm.AlarmEvent

All Implemented Interfaces:

Serializable

public final class AlarmEvent
extends Object
implements Serializable

Represents an alarm life-cycle event such as activation, acknowledgement or clearance.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final AlarmLevel	level
private static final long	serialVersionUID
private final String	source
private final double	timestamp
private final AlarmEventType	type
private final double	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AlarmEvent(String source, AlarmLevel level, AlarmEventType type, double timestamp, double value)

Method Summary

Modifier and Type	Method	Description
static AlarmEvent	acknowledged(String source, AlarmLevel level, double timestamp, double value)	Creates an alarm acknowledgement event.
static AlarmEvent	activated(String source, AlarmLevel level, double timestamp, double value)	Creates an alarm activation event.
static AlarmEvent	cleared(String source, AlarmLevel level, double timestamp, double value)	Creates an alarm clearance event.
AlarmLevel	getLevel()
String	getSource()
double	getTimestamp()
AlarmEventType	getType()
double	getValue()
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

source

private final String source

level

private final AlarmLevel level

type

private final AlarmEventType type

timestamp

private final double timestamp

value

private final double value

Constructor Details

AlarmEvent

private AlarmEvent(String source,
 AlarmLevel level,
 AlarmEventType type,
 double timestamp,
 double value)

Method Details

activated

public static AlarmEvent activated(String source,
 AlarmLevel level,
 double timestamp,
 double value)

Creates an alarm activation event.

Parameters:

source - name of the originating measurement

level - alarm level becoming active

timestamp - simulation time of the event

value - measured value triggering the event

Returns:

activation event

cleared

public static AlarmEvent cleared(String source,
 AlarmLevel level,
 double timestamp,
 double value)

Creates an alarm clearance event.

Parameters:

source - name of the originating measurement

level - alarm level being cleared

timestamp - simulation time of the event

value - measured value when the alarm cleared

Returns:

clearance event

acknowledged

public static AlarmEvent acknowledged(String source,
 AlarmLevel level,
 double timestamp,
 double value)

Creates an alarm acknowledgement event.

Parameters:

source - name of the originating measurement

level - alarm level being acknowledged

timestamp - simulation time of the acknowledgement

value - measured value at acknowledgement time

Returns:

acknowledgement event

getSource

public String getSource()

getLevel

public AlarmLevel getLevel()

getType

public AlarmEventType getType()

getTimestamp

public double getTimestamp()

getValue

public double getValue()

toString

public String toString()

Overrides:

toString in class Object