Package jmri
Class TransitSectionAction
- java.lang.Object
- 
- jmri.TransitSectionAction
 
- 
 public class TransitSectionAction extends java.lang.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 SummaryFields Modifier and Type Field Description static intBLOCKENTRYstatic intBLOCKEXITstatic intENTRYstatic intESTOPstatic intEXITstatic intFORCEALLOCATEPASSSAFESECTIONstatic intHOLDSIGNALstatic intLOADTRAININFOstatic intLOCOADDRESSTYPECURRENTstatic intLOCOADDRESSTYPEDEFAULTstatic intLOCOADDRESSTYPENUMBERstatic intLOCOADDRESSTYPEROSTERstatic intLOCOFUNCTIONstatic intNUM_WHATSstatic intNUM_WHENSConstants representing the "when" (when the action is to be initiated) of the Action.static intPAUSEstatic intPRESTARTACTIONstatic intPRESTARTDELAYstatic intPRESTARTRESUMEstatic intRAMPTRAINSPEEDstatic intRELEASESIGNALstatic intSELECTWHATConstants designating the "what" (the action to be taken) of the Action.static intSELECTWHENstatic intSENSORACTIVEstatic intSENSORINACTIVEstatic intSETCURRENTSPEEDstatic intSETLIGHTstatic intSETMAXSPEEDstatic intSETSENSORACTIVEstatic intSETSENSORINACTIVEstatic intSOUNDHORNstatic intSOUNDHORNPATTERNstatic intSTARTBELLstatic intSTOPBELLstatic intTERMINATETRAINstatic intTOMANUALMODEstatic intTRAINSTARTstatic intTRAINSTOP
 - 
Constructor SummaryConstructors Constructor Description TransitSectionAction(int when, int what)Create a TransitSectionAction.TransitSectionAction(int when, int what, int dataWhen, int dataWhat1, int dataWhat2, java.lang.String sWhen, java.lang.String sWhat)Create a TransitSectionAction.TransitSectionAction(int when, int what, int dataWhen, int dataWhat1, int dataWhat2, java.lang.String sWhen, java.lang.String sWhat, java.lang.String sWhat2)Create a TransitSectionAction.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddispose()voiddisposeSensorListener()intgetDataWhat1()floatgetDataWhat1Float()intgetDataWhat2()floatgetDataWhat2Float()intgetDataWhen()java.beans.PropertyChangeListenergetSensorListener()java.lang.StringgetStringWhat()java.lang.StringgetStringWhat2()java.lang.StringgetStringWhen()TransitSectiongetTargetTransitSection()java.lang.ObjectgetThreadObject()SensorgetTriggerSensor()booleangetWaitingForBlock()booleangetWaitingForSectionExit()booleangetWaitingForSensor()java.lang.ThreadgetWaitingThread()intgetWhatCode()intgetWhenCode()voidinitialize()Initialize all operational instance variables (not saved between runs).voidsetDataWhat1(int n)voidsetDataWhat1Float(float n)voidsetDataWhat2(int n)voidsetDataWhat2Float(float n)voidsetDataWhen(int n)voidsetSensorListener(java.beans.PropertyChangeListener l)voidsetStringWhat(java.lang.String s)voidsetStringWhat2(java.lang.String s)voidsetStringWhen(java.lang.String s)voidsetTargetTransitSection(TransitSection ts)voidsetThreadObject(java.lang.Object threadObj)voidsetTriggerSensor(Sensor s)voidsetWaitingForBlock(boolean w)voidsetWaitingForSectionExit(boolean w)voidsetWaitingForSensor(boolean w)voidsetWaitingThread(java.lang.Thread t)voidsetWhatCode(int n)voidsetWhenCode(int n)
 
- 
- 
- 
Field Detail- 
NUM_WHENSpublic 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
 
 - 
SELECTWHENpublic static final int SELECTWHEN - See Also:
- Constant Field Values
 
 - 
ENTRYpublic static final int ENTRY - See Also:
- Constant Field Values
 
 - 
EXITpublic static final int EXIT - See Also:
- Constant Field Values
 
 - 
BLOCKENTRYpublic static final int BLOCKENTRY - See Also:
- Constant Field Values
 
 - 
BLOCKEXITpublic static final int BLOCKEXIT - See Also:
- Constant Field Values
 
 - 
TRAINSTOPpublic static final int TRAINSTOP - See Also:
- Constant Field Values
 
 - 
TRAINSTARTpublic static final int TRAINSTART - See Also:
- Constant Field Values
 
 - 
SENSORACTIVEpublic static final int SENSORACTIVE - See Also:
- Constant Field Values
 
 - 
SENSORINACTIVEpublic static final int SENSORINACTIVE - See Also:
- Constant Field Values
 
 - 
PRESTARTDELAYpublic static final int PRESTARTDELAY - See Also:
- Constant Field Values
 
 - 
PRESTARTACTIONpublic static final int PRESTARTACTION - See Also:
- Constant Field Values
 
 - 
SELECTWHATpublic 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
 
 - 
PAUSEpublic static final int PAUSE - See Also:
- Constant Field Values
 
 - 
SETMAXSPEEDpublic static final int SETMAXSPEED - See Also:
- Constant Field Values
 
 - 
SETCURRENTSPEEDpublic static final int SETCURRENTSPEED - See Also:
- Constant Field Values
 
 - 
RAMPTRAINSPEEDpublic static final int RAMPTRAINSPEED - See Also:
- Constant Field Values
 
 - 
TOMANUALMODEpublic static final int TOMANUALMODE - See Also:
- Constant Field Values
 
 - 
SETLIGHTpublic static final int SETLIGHT - See Also:
- Constant Field Values
 
 - 
STARTBELLpublic static final int STARTBELL - See Also:
- Constant Field Values
 
 - 
STOPBELLpublic static final int STOPBELL - See Also:
- Constant Field Values
 
 - 
SOUNDHORNpublic static final int SOUNDHORN - See Also:
- Constant Field Values
 
 - 
SOUNDHORNPATTERNpublic static final int SOUNDHORNPATTERN - See Also:
- Constant Field Values
 
 - 
LOCOFUNCTIONpublic static final int LOCOFUNCTION - See Also:
- Constant Field Values
 
 - 
SETSENSORACTIVEpublic static final int SETSENSORACTIVE - See Also:
- Constant Field Values
 
 - 
SETSENSORINACTIVEpublic static final int SETSENSORINACTIVE - See Also:
- Constant Field Values
 
 - 
HOLDSIGNALpublic static final int HOLDSIGNAL - See Also:
- Constant Field Values
 
 - 
RELEASESIGNALpublic static final int RELEASESIGNAL - See Also:
- Constant Field Values
 
 - 
ESTOPpublic static final int ESTOP - See Also:
- Constant Field Values
 
 - 
PRESTARTRESUMEpublic static final int PRESTARTRESUME - See Also:
- Constant Field Values
 
 - 
TERMINATETRAINpublic static final int TERMINATETRAIN - See Also:
- Constant Field Values
 
 - 
LOADTRAININFOpublic static final int LOADTRAININFO - See Also:
- Constant Field Values
 
 - 
FORCEALLOCATEPASSSAFESECTIONpublic static final int FORCEALLOCATEPASSSAFESECTION - See Also:
- Constant Field Values
 
 - 
NUM_WHATSpublic static final int NUM_WHATS - See Also:
- Constant Field Values
 
 - 
LOCOADDRESSTYPEDEFAULTpublic static final int LOCOADDRESSTYPEDEFAULT - See Also:
- Constant Field Values
 
 - 
LOCOADDRESSTYPEROSTERpublic static final int LOCOADDRESSTYPEROSTER - See Also:
- Constant Field Values
 
 - 
LOCOADDRESSTYPENUMBERpublic static final int LOCOADDRESSTYPENUMBER - See Also:
- Constant Field Values
 
 - 
LOCOADDRESSTYPECURRENTpublic static final int LOCOADDRESSTYPECURRENT - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
TransitSectionActionpublic 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
 
 - 
TransitSectionActionpublic TransitSectionAction(int when, int what, int dataWhen, int dataWhat1, int dataWhat2, java.lang.String sWhen, java.lang.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
 
 - 
TransitSectionActionpublic TransitSectionAction(int when, int what, int dataWhen, int dataWhat1, int dataWhat2, java.lang.String sWhen, java.lang.String sWhat, java.lang.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 Detail- 
setThreadObjectpublic void setThreadObject(java.lang.Object threadObj) 
 - 
getThreadObjectpublic java.lang.Object getThreadObject() 
 - 
getWhenCodepublic int getWhenCode() 
 - 
setWhenCodepublic void setWhenCode(int n) 
 - 
getWhatCodepublic int getWhatCode() 
 - 
setWhatCodepublic void setWhatCode(int n) 
 - 
getDataWhenpublic int getDataWhen() 
 - 
setDataWhenpublic void setDataWhen(int n) 
 - 
getDataWhat1Floatpublic float getDataWhat1Float() 
 - 
setDataWhat1Floatpublic void setDataWhat1Float(float n) 
 - 
getDataWhat2Floatpublic float getDataWhat2Float() 
 - 
setDataWhat2Floatpublic void setDataWhat2Float(float n) 
 - 
getDataWhat1public int getDataWhat1() 
 - 
setDataWhat1public void setDataWhat1(int n) 
 - 
getDataWhat2public int getDataWhat2() 
 - 
setDataWhat2public void setDataWhat2(int n) 
 - 
getStringWhenpublic java.lang.String getStringWhen() 
 - 
setStringWhenpublic void setStringWhen(java.lang.String s) 
 - 
getStringWhatpublic java.lang.String getStringWhat() 
 - 
setStringWhatpublic void setStringWhat(java.lang.String s) 
 - 
getStringWhat2public java.lang.String getStringWhat2() 
 - 
setStringWhat2public void setStringWhat2(java.lang.String s) 
 - 
initializepublic void initialize() Initialize all operational instance variables (not saved between runs).
 - 
getWaitingThreadpublic java.lang.Thread getWaitingThread() 
 - 
setWaitingThreadpublic void setWaitingThread(java.lang.Thread t) 
 - 
getWaitingForSectionExitpublic boolean getWaitingForSectionExit() 
 - 
setWaitingForSectionExitpublic void setWaitingForSectionExit(boolean w) 
 - 
getTargetTransitSectionpublic TransitSection getTargetTransitSection() 
 - 
setTargetTransitSectionpublic void setTargetTransitSection(TransitSection ts) 
 - 
getWaitingForBlockpublic boolean getWaitingForBlock() 
 - 
setWaitingForBlockpublic void setWaitingForBlock(boolean w) 
 - 
getWaitingForSensorpublic boolean getWaitingForSensor() 
 - 
setWaitingForSensorpublic void setWaitingForSensor(boolean w) 
 - 
getTriggerSensorpublic Sensor getTriggerSensor() 
 - 
setTriggerSensorpublic void setTriggerSensor(Sensor s) 
 - 
getSensorListenerpublic java.beans.PropertyChangeListener getSensorListener() 
 - 
setSensorListenerpublic void setSensorListener(java.beans.PropertyChangeListener l) 
 - 
disposeSensorListenerpublic void disposeSensorListener() 
 - 
disposepublic void dispose() 
 
- 
 
-