org.csstudio.utility.pv.epics

Enum MonitorMask

java.lang.Object

java.lang.Enum<MonitorMask>

org.csstudio.utility.pv.epics.MonitorMask

All Implemented Interfaces:

Serializable, Comparable<MonitorMask>

public enum MonitorMask
extends Enum<MonitorMask>

MonitorMask specifies the event mask for epics events. When connecting to the PV the user always connects with one of the masks to filter out unnecessary event changes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALARM Listen to changes in alarm state
ALL Listen to all events
ARCHIVE Listen to changes in value beyond archive limit
VALUE Listen to changes in value and in alarms

Method Summary

Modifier and Type	Method and Description
int	getMask()
static MonitorMask	valueOf(String name) Returns the enum constant of this type with the specified name.
static MonitorMask[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VALUE

public static final MonitorMask VALUE

Listen to changes in value and in alarms

ARCHIVE

public static final MonitorMask ARCHIVE

Listen to changes in value beyond archive limit

ALARM

public static final MonitorMask ALARM

Listen to changes in alarm state

ALL

public static final MonitorMask ALL

Listen to all events

Method Detail

values

public static MonitorMask[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MonitorMask c : MonitorMask.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MonitorMask valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMask

public int getMask()

Returns:

Mask bits used in underlying CA call