Package jmri

Class TransitSectionAction

java.lang.Object

jmri.TransitSectionAction

public class TransitSectionAction
extends Object

This class holds information and options for a Action to be applied when an automated train enters, exits, or is inside of a Section in a Transit.

A TransitSection holds specified TrainsitSectionActions. A TransitSection may have as many TransitSectionActions as appropriate. Each TransitSectionAction belongs to one and only one TransitSection.

TransitSectionActions are specified in two parts: 1. The "When" part specifies when after the automated train enters the Section the action is to be initiated. Optionally, each "when" may be delayed by a specified time (in milliseconds). 2. The "What" part specified what action is to occur.

TransitSectionActions are created and edited in the Transit Table, when Transits are defined.

This class provides support for SENSORACTIVE and SENSORINACTIVE "when"'s.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLOCKENTRY
static final int	BLOCKEXIT
static final int	ENTRY
static final int	ESTOP
static final int	EXIT
static final int	FORCEALLOCATEPASSSAFESECTION
static final int	HOLDSIGNAL
static final int	LOADTRAININFO
static final int	LOCOADDRESSTYPECURRENT
static final int	LOCOADDRESSTYPEDEFAULT
static final int	LOCOADDRESSTYPENUMBER
static final int	LOCOADDRESSTYPEROSTER
static final int	LOCOFUNCTION
static final int	NUM_WHATS
static final int	NUM_WHENS	Constants representing the "when" (when the action is to be initiated) of the Action.
static final int	PAUSE
static final int	PRESTARTACTION
static final int	PRESTARTDELAY
static final int	PRESTARTRESUME
static final int	RAMPTRAINSPEED
static final int	RELEASESIGNAL
static final int	SELECTWHAT	Constants designating the "what" (the action to be taken) of the Action.
static final int	SELECTWHEN
static final int	SENSORACTIVE
static final int	SENSORINACTIVE
static final int	SETCURRENTSPEED
static final int	SETLIGHT
static final int	SETMAXSPEED
static final int	SETSENSORACTIVE
static final int	SETSENSORINACTIVE
static final int	SOUNDHORN
static final int	SOUNDHORNPATTERN
static final int	STARTBELL
static final int	STOPBELL
static final int	TERMINATETRAIN
static final int	TOMANUALMODE
static final int	TRAINSTART
static final int	TRAINSTOP

Constructor Summary

Constructors

Constructor	Description
TransitSectionAction(int when, int what)	Create a TransitSectionAction.
TransitSectionAction(int when, int what, int dataWhen, int dataWhat1, int dataWhat2, String sWhen, String sWhat)	Create a TransitSectionAction.
TransitSectionAction(int when, int what, int dataWhen, int dataWhat1, int dataWhat2, String sWhen, String sWhat, String sWhat2)	Create a TransitSectionAction.

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	disposeSensorListener()
int	getDataWhat1()
float	getDataWhat1Float()
int	getDataWhat2()
float	getDataWhat2Float()
int	getDataWhen()
PropertyChangeListener	getSensorListener()
String	getStringWhat()
String	getStringWhat2()
String	getStringWhen()
TransitSection	getTargetTransitSection()
Object	getThreadObject()
Sensor	getTriggerSensor()
boolean	getWaitingForBlock()
boolean	getWaitingForSectionExit()
boolean	getWaitingForSensor()
Thread	getWaitingThread()
int	getWhatCode()
int	getWhenCode()
void	initialize()	Initialize all operational instance variables (not saved between runs).
void	setDataWhat1(int n)
void	setDataWhat1Float(float n)
void	setDataWhat2(int n)
void	setDataWhat2Float(float n)
void	setDataWhen(int n)
void	setSensorListener(PropertyChangeListener l)
void	setStringWhat(String s)
void	setStringWhat2(String s)
void	setStringWhen(String s)
void	setTargetTransitSection(TransitSection ts)
void	setThreadObject(Object threadObj)
void	setTriggerSensor(Sensor s)
void	setWaitingForBlock(boolean w)
void	setWaitingForSectionExit(boolean w)
void	setWaitingForSensor(boolean w)
void	setWaitingThread(Thread t)
void	setWhatCode(int n)
void	setWhenCode(int n)

Methods inherited from class java.lang.Object

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

Field Details

NUM_WHENS

public static final int NUM_WHENS

Constants representing the "when" (when the action is to be initiated) of the Action. TODO: Convert to ENUM

See Also:

• Constant Field Values

SELECTWHEN

public static final int SELECTWHEN

See Also:

• Constant Field Values

ENTRY

public static final int ENTRY

See Also:

• Constant Field Values

EXIT

public static final int EXIT

See Also:

• Constant Field Values

BLOCKENTRY

public static final int BLOCKENTRY

See Also:

• Constant Field Values

BLOCKEXIT

public static final int BLOCKEXIT

See Also:

• Constant Field Values

TRAINSTOP

public static final int TRAINSTOP

See Also:

• Constant Field Values

TRAINSTART

public static final int TRAINSTART

See Also:

• Constant Field Values

SENSORACTIVE

public static final int SENSORACTIVE

See Also:

• Constant Field Values

SENSORINACTIVE

public static final int SENSORINACTIVE

See Also:

• Constant Field Values

PRESTARTDELAY

public static final int PRESTARTDELAY

See Also:

• Constant Field Values

PRESTARTACTION

public static final int PRESTARTACTION

See Also:

• Constant Field Values

SELECTWHAT

public static final int SELECTWHAT

Constants designating the "what" (the action to be taken) of the Action. TODO: Convert to ENUM

See Also:

• Constant Field Values

PAUSE

public static final int PAUSE

See Also:

• Constant Field Values

SETMAXSPEED

public static final int SETMAXSPEED

See Also:

• Constant Field Values

SETCURRENTSPEED

public static final int SETCURRENTSPEED

See Also:

• Constant Field Values

RAMPTRAINSPEED

public static final int RAMPTRAINSPEED

See Also:

• Constant Field Values

TOMANUALMODE

public static final int TOMANUALMODE

See Also:

• Constant Field Values

SETLIGHT

public static final int SETLIGHT

See Also:

• Constant Field Values

STARTBELL

public static final int STARTBELL

See Also:

• Constant Field Values

STOPBELL

public static final int STOPBELL

See Also:

• Constant Field Values

SOUNDHORN

public static final int SOUNDHORN

See Also:

• Constant Field Values

SOUNDHORNPATTERN

public static final int SOUNDHORNPATTERN

See Also:

• Constant Field Values

LOCOFUNCTION

public static final int LOCOFUNCTION

See Also:

• Constant Field Values

SETSENSORACTIVE

public static final int SETSENSORACTIVE

See Also:

• Constant Field Values

SETSENSORINACTIVE

public static final int SETSENSORINACTIVE

See Also:

• Constant Field Values

HOLDSIGNAL

public static final int HOLDSIGNAL

See Also:

• Constant Field Values

RELEASESIGNAL

public static final int RELEASESIGNAL

See Also:

• Constant Field Values

ESTOP

public static final int ESTOP

See Also:

• Constant Field Values

PRESTARTRESUME

public static final int PRESTARTRESUME

See Also:

• Constant Field Values

TERMINATETRAIN

public static final int TERMINATETRAIN

See Also:

• Constant Field Values

LOADTRAININFO

public static final int LOADTRAININFO

See Also:

• Constant Field Values

FORCEALLOCATEPASSSAFESECTION

public static final int FORCEALLOCATEPASSSAFESECTION

See Also:

• Constant Field Values

NUM_WHATS

public static final int NUM_WHATS

See Also:

• Constant Field Values

LOCOADDRESSTYPEDEFAULT

public static final int LOCOADDRESSTYPEDEFAULT

See Also:

• Constant Field Values

LOCOADDRESSTYPEROSTER

public static final int LOCOADDRESSTYPEROSTER

See Also:

• Constant Field Values

LOCOADDRESSTYPENUMBER

public static final int LOCOADDRESSTYPENUMBER

See Also:

• Constant Field Values

LOCOADDRESSTYPECURRENT

public static final int LOCOADDRESSTYPECURRENT

See Also:

• Constant Field Values

Constructor Details

TransitSectionAction

public TransitSectionAction(int when,
 int what)

Create a TransitSectionAction.

Parameters:

when - one of ENTRY, EXIT, BLOCKENTRY, BLOCKEXIT, TRAINSTOP, TRAINSTART, SENSORACTIVE, SENSORINACTIVE, PRESTARTRESUME

what - one of PAUSE, SETMAXSPEED, SETCURRENTSPEED, RAMPTRAINSPEED, TOMANUALMODE, SETLIGHT, STARTBELL, STOPBELL, SOUNDHORN, SOUNDHORNPATTERN, LOCOFUNCTION, SETSENSORACTIVE, SETSENSORINACTIVE, HOLDSIGNAL, RELEASESIGNAL

TransitSectionAction

public TransitSectionAction(int when,
 int what,
 int dataWhen,
 int dataWhat1,
 int dataWhat2,
 String sWhen,
 String sWhat)

Create a TransitSectionAction.

Parameters:

when - one of ENTRY, EXIT, BLOCKENTRY, BLOCKEXIT, TRAINSTOP, TRAINSTART, SENSORACTIVE, SENSORINACTIVE

what - one of PAUSE, SETMAXSPEED, SETCURRENTSPEED, RAMPTRAINSPEED, TOMANUALMODE, SETLIGHT, STARTBELL, STOPBELL, SOUNDHORN, SOUNDHORNPATTERN, LOCOFUNCTION, SETSENSORACTIVE, SETSENSORINACTIVE, HOLDSIGNAL, RELEASESIGNAL

dataWhen - a data element for when

dataWhat1 - a data element for what

dataWhat2 - a data element for what

sWhen - typically a readable description of when or the name of the triggering sensors

sWhat - typically a readable description of what

TransitSectionAction

public TransitSectionAction(int when,
 int what,
 int dataWhen,
 int dataWhat1,
 int dataWhat2,
 String sWhen,
 String sWhat,
 String sWhat2)

Create a TransitSectionAction.

Parameters:

when - one of ENTRY, EXIT, BLOCKENTRY, BLOCKEXIT, TRAINSTOP, TRAINSTART, SENSORACTIVE, SENSORINACTIVE

what - one of PAUSE, SETMAXSPEED, SETCURRENTSPEED, RAMPTRAINSPEED, TOMANUALMODE, SETLIGHT, STARTBELL, STOPBELL, SOUNDHORN, SOUNDHORNPATTERN, LOCOFUNCTION, SETSENSORACTIVE, SETSENSORINACTIVE, HOLDSIGNAL, RELEASESIGNAL

dataWhen - a data element for when

dataWhat1 - a data element for what

dataWhat2 - a data element for what

sWhen - typically a readable description of when or the name of the triggering sensors

sWhat - typically a readable description of what or data such as TrainInfo File Name

sWhat2 - typically a second string parameter for the action such as DCCAddress or roster entry.

Method Details

setThreadObject

public void setThreadObject(Object threadObj)

getThreadObject

public Object getThreadObject()

getWhenCode

public int getWhenCode()

setWhenCode

public void setWhenCode(int n)

getWhatCode

public int getWhatCode()

setWhatCode

public void setWhatCode(int n)

getDataWhen

public int getDataWhen()

setDataWhen

public void setDataWhen(int n)

getDataWhat1Float

public float getDataWhat1Float()

setDataWhat1Float

public void setDataWhat1Float(float n)

getDataWhat2Float

public float getDataWhat2Float()

setDataWhat2Float

public void setDataWhat2Float(float n)

getDataWhat1

public int getDataWhat1()

setDataWhat1

public void setDataWhat1(int n)

getDataWhat2

public int getDataWhat2()

setDataWhat2

public void setDataWhat2(int n)

getStringWhen

public String getStringWhen()

setStringWhen

public void setStringWhen(String s)

getStringWhat

public String getStringWhat()

setStringWhat

public void setStringWhat(String s)

getStringWhat2

public String getStringWhat2()

setStringWhat2

public void setStringWhat2(String s)

initialize

public void initialize()

Initialize all operational instance variables (not saved between runs).

getWaitingThread

public Thread getWaitingThread()

setWaitingThread

public void setWaitingThread(Thread t)

getWaitingForSectionExit

public boolean getWaitingForSectionExit()

setWaitingForSectionExit

public void setWaitingForSectionExit(boolean w)

getTargetTransitSection

public TransitSection getTargetTransitSection()

setTargetTransitSection

public void setTargetTransitSection(TransitSection ts)

getWaitingForBlock

public boolean getWaitingForBlock()

setWaitingForBlock

public void setWaitingForBlock(boolean w)

getWaitingForSensor

public boolean getWaitingForSensor()

setWaitingForSensor

public void setWaitingForSensor(boolean w)

getTriggerSensor

public Sensor getTriggerSensor()

setTriggerSensor

public void setTriggerSensor(Sensor s)

getSensorListener

public PropertyChangeListener getSensorListener()

setSensorListener

public void setSensorListener(PropertyChangeListener l)

disposeSensorListener

public void disposeSensorListener()

dispose

public void dispose()