xal.service.tripmonitor

Class TripMonitorFilter

java.lang.Object

xal.service.tripmonitor.TripMonitorFilter

public class TripMonitorFilter
extends java.lang.Object

filter to get trip monitor PVs from the optics

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_LABEL data label
protected boolean	IS_ENABLED indicates whether the monitor is enabled
protected java.lang.String	NAME name
protected java.util.regex.Pattern	NODE_KEY_PATTERN pattern for filtering the node key from the a node ID
protected java.lang.String	NODE_TYPE node type
protected PersistentStore	PERSISTENT_STORE persistent store for logging trips
protected PVNodeFormatGroup	PV_NODE_FORMAT_GROUP group of PV formats which are used to generate PVs from node names
protected java.lang.String	SEQUENCE_ID ID of the accelerator sequence from which to fetch the nodes

Constructor Summary

Constructors

Constructor and Description
TripMonitorFilter(DataAdaptor adaptor, xal.service.tripmonitor.TripFilterFactory tripFilterFactory) Constructor

Method Summary

Modifier and Type	Method and Description
protected java.util.regex.Pattern	generateNodeKeyPattern(java.lang.String nodeIDPatternString) generate the node key pattern
java.util.List<ChannelMonitor>	getChannelMonitors(AcceleratorNode node) get the channel monitors for the specified node
java.lang.String	getName() get the name of the trip monitor filter
java.lang.String	getNodeKey(java.lang.String pv) extract the node key from the specified pv
java.util.List<AcceleratorNode>	getNodes() get the list of nodes from the default accelerator
java.util.List<AcceleratorNode>	getNodes(AcceleratorSeq sequence) get the list of nodes
PersistentStore	getPersistentStore() get the persistent store
AcceleratorSeq	getSequence() get the sequence from the default accelerator
AcceleratorSeq	getSequence(Accelerator accelerator) get the accelerator sequence
java.util.List<TripChannelFilter>	getTripChannelFilters() get the trip channel filters
java.lang.String	getTripPV(TripChannelFilter channelFilter, java.lang.String nodeKey) get the trip PV for the specified channel filter and node key
java.util.List<java.lang.String>	getTripPVs(AcceleratorNode node) get the trip PVs to monitor for the specified node
boolean	isEnabled() indicates whether the corresponding trip monitor should be enabled by default
java.lang.String	toString() string representation of this instance

Methods inherited from class java.lang.Object

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

Field Detail

DATA_LABEL

public static final java.lang.String DATA_LABEL

data label

See Also:

Constant Field Values

NAME

protected final java.lang.String NAME

name

SEQUENCE_ID

protected final java.lang.String SEQUENCE_ID

ID of the accelerator sequence from which to fetch the nodes

NODE_TYPE

protected final java.lang.String NODE_TYPE

node type

NODE_KEY_PATTERN

protected final java.util.regex.Pattern NODE_KEY_PATTERN

pattern for filtering the node key from the a node ID

IS_ENABLED

protected final boolean IS_ENABLED

indicates whether the monitor is enabled

PERSISTENT_STORE

protected final PersistentStore PERSISTENT_STORE

persistent store for logging trips

PV_NODE_FORMAT_GROUP

protected final PVNodeFormatGroup PV_NODE_FORMAT_GROUP

group of PV formats which are used to generate PVs from node names

Constructor Detail

TripMonitorFilter

public TripMonitorFilter(DataAdaptor adaptor,
                         xal.service.tripmonitor.TripFilterFactory tripFilterFactory)

Constructor

Method Detail

getName

public java.lang.String getName()

get the name of the trip monitor filter

isEnabled

public boolean isEnabled()

indicates whether the corresponding trip monitor should be enabled by default

getPersistentStore

public PersistentStore getPersistentStore()

get the persistent store

generateNodeKeyPattern

protected java.util.regex.Pattern generateNodeKeyPattern(java.lang.String nodeIDPatternString)

generate the node key pattern

getSequence

public AcceleratorSeq getSequence()

get the sequence from the default accelerator

getSequence

public AcceleratorSeq getSequence(Accelerator accelerator)

get the accelerator sequence

getNodes

public java.util.List<AcceleratorNode> getNodes()

get the list of nodes from the default accelerator

getNodes

public java.util.List<AcceleratorNode> getNodes(AcceleratorSeq sequence)

get the list of nodes

getNodeKey

public java.lang.String getNodeKey(java.lang.String pv)

extract the node key from the specified pv

getChannelMonitors

public java.util.List<ChannelMonitor> getChannelMonitors(AcceleratorNode node)

get the channel monitors for the specified node

getTripPVs

public java.util.List<java.lang.String> getTripPVs(AcceleratorNode node)

get the trip PVs to monitor for the specified node

getTripPV

public java.lang.String getTripPV(TripChannelFilter channelFilter,
                                  java.lang.String nodeKey)

get the trip PV for the specified channel filter and node key

getTripChannelFilters

public java.util.List<TripChannelFilter> getTripChannelFilters()

get the trip channel filters

toString

public java.lang.String toString()

string representation of this instance

Overrides:

toString in class java.lang.Object