Package jmri.jmrit.dispatcher

Class TrainInfo

java.lang.Object

jmri.jmrit.dispatcher.TrainInfo

public class TrainInfo
extends Object

TrainInfo is a temporary object specifying New Train information just read from disk, or to be written to disk

Used in conjunction with TrainInfoFile.java to save and retrieve New Train information

When adding a new item of New Train information, modifications need to be made to TrainInfoFile.java and dispatcher-traininfo.DTD as well as this module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TrainInfo.StopReference

Constructor Summary

Constructors

Constructor	Description
TrainInfo()

Method Summary

Modifier and Type	Method	Description
float	getAdditionalTrainWeightMetricTonnes()
boolean	getAllocateAllTheWay()
int	getAllocationMethod()
boolean	getAutoRun()
String	getBlockName()
String	getDccAddress()
int	getDelayedRestart()	return restart code for this train, only used for continuous running
int	getDelayedStart()	delayed start code for this train
Sensor	getDelaySensor()	retrieve the startup delay sensor using the delay sensor name
String	getDelaySensorName()
int	getDepartureTimeHr()
int	getDepartureTimeMin()
String	getDestinationBlockId()
String	getDestinationBlockName()
int	getDestinationBlockSeq()
float	getDriverPowerPercent()	Gets the driver's applied power/regulator during acceleration (0.0..1.0).
boolean	getDynamicTransit()
boolean	getDynamicTransitCloseLoopIfPossible()
int	getFNumberBell()	returns the F number for the Bell
int	getFNumberHorn()	returns the F number for the Horn
int	getFNumberLight()	returns the F number for the Light
boolean	getLoadAtStartup()
Float	getMaxSpeed()
float	getMaxSpeedScaleKmh()	Gets the maximum speed in scale km/h. 0.0f means "disabled".
float	getMaxTrainLength()	Deprecated, for removal: This API element is subject to removal in a future version. use getMaxTrainLengthScaleMeters() or getMaxTrainLengthScaleFeet()
float	getMaxTrainLengthScaleFeet()	Gets the Max train length expected during route
float	getMaxTrainLengthScaleMeters()	Gets the Max train length expected during run
float	getMinReliableOperatingSpeed()
String	getNextTrain()
int	getPriority()
String	getRampRate()
boolean	getResetRestartSensor()
boolean	getResetStartSensor()
boolean	getResetWhenDone()
boolean	getResistanceWheels()	Deprecated, for removal: This API element is subject to removal in a future version. use getTrainDetection()
int	getRestartDelayMin()
Sensor	getRestartSensor()	retrieve the restart sensor using the restart sensor name
String	getRestartSensorName()
boolean	getReverseAtEnd()
int	getReverseDelayedRestart()	return restart code for this train, only used for continuous running
boolean	getReverseResetRestartSensor()
int	getReverseRestartDelayMin()
Sensor	getReverseRestartSensor()
String	getReverseRestartSensorName()
float	getRollingResistanceCoeff()
String	getRosterId()
boolean	getRunInReverse()
boolean	getSoundDecoder()
Float	getSpeedFactor()
String	getStartBlockId()
String	getStartBlockName()
int	getStartBlockSeq()
float	getStopByDistanceMm()
TrainInfo.StopReference	getStopByDistanceRef()
boolean	getStopBySpeedProfile()
float	getStopBySpeedProfileAdjust()
boolean	getTerminateWhenDone()
ActiveTrain.TrainDetection	getTrainDetection()	Get the detection type
boolean	getTrainFromRoster()
boolean	getTrainFromSetLater()
boolean	getTrainFromTrains()
boolean	getTrainFromUser()
boolean	getTrainInTransit()
ActiveTrain.TrainLengthUnits	getTrainLengthUnits()	Get the GUI units entered (The data is held in scale Meters)
String	getTrainName()
DispatcherFrame.TrainsFrom	getTrainsFrom()
String	getTrainType()
String	getTrainUserName()
String	getTransitId()
String	getTransitName()
boolean	getUseSpeedProfile()
boolean	getUseStopSensor()
int	getVersion()
String	getViaBlockName()
float	getWaitTime()
void	setAdditionalTrainWeightMetricTonnes(float value)
void	setAllocateAllTheWay(boolean b)
void	setAllocationMethod(int i)
void	setAutoRun(boolean b)
void	setBlockName(String s)
void	setDccAddress(String s)
void	setDelayedRestart(int ds)
void	setDelayedStart(int ds)
void	setDelaySensorName(String sen)
void	setDepartureTimeHr(int hr)
void	setDepartureTimeMin(int min)
void	setDestinationBlockId(String s)
void	setDestinationBlockName(String s)
void	setDestinationBlockSeq(int i)
void	setDriverPowerPercent(float value)	Sets the driver's applied power/regulator during acceleration (0.0..1.0).
void	setDynamicTransit(boolean b)
void	setDynamicTransitCloseLoopIfPossible(boolean b)
void	setFNumberBell(int value)	Sets F number for the Bell
void	setFNumberHorn(int value)	Sets F number for the Horn
void	setFNumberLight(int value)	Sets F number for the Light
void	setLoadAtStartup(boolean loadAtStartup)
void	setMaxSpeed(float f)
void	setMaxSpeedScaleKmh(float kmh)	Sets the maximum speed in scale km/h.
void	setMaxTrainLength(float f)	Deprecated, for removal: This API element is subject to removal in a future version. use setMaxTrainLengthScaleMeters(float) or setMaxTrainLengthScaleMeters(float)
void	setMaxTrainLengthScaleFeet(float f)	Sets the max train length expected
void	setMaxTrainLengthScaleMeters(float f)	Sets the max train length expected during run
void	setMinReliableOperatingSpeed(float f)
void	setNextTrain(String s)
void	setPriority(int pri)
void	setRampRate(String s)
void	setResetRestartSensor(boolean b)
void	setResetStartSensor(boolean b)
void	setResetWhenDone(boolean b)
void	setResistanceWheels(boolean b)	Deprecated, for removal: This API element is subject to removal in a future version. use setTrainDetection(jmri.jmrit.dispatcher.ActiveTrain.TrainDetection)
void	setRestartDelayMin(int s)	number of minutes to delay between restarting for continuous runs
void	setRestartSensorName(String sen)
void	setReverseAtEnd(boolean b)
void	setReverseDelayedRestart(int ds)
void	setReverseResetRestartSensor(boolean value)
void	setReverseRestartDelayMin(int value)
void	setReverseRestartSensorName(String value)
void	setRollingResistanceCoeff(float value)
void	setRosterId(String s)
void	setRunInReverse(boolean b)
void	setSoundDecoder(boolean b)
void	setSpeedFactor(float f)
void	setStartBlockId(String s)
void	setStartBlockName(String s)
void	setStartBlockSeq(int i)
void	setStopByDistanceMm(float value)
void	setStopByDistanceRef(TrainInfo.StopReference value)
void	setStopBySpeedProfile(boolean b)
void	setStopBySpeedProfileAdjust(float f)
void	setTerminateWhenDone(boolean b)
void	setTrainDetection(ActiveTrain.TrainDetection b)	Set the detection get
void	setTrainFromRoster(boolean b)
void	setTrainFromSetLater(boolean b)
void	setTrainFromTrains(boolean b)
void	setTrainFromUser(boolean b)
void	setTrainInTransit(boolean b)
void	setTrainLengthUnits(ActiveTrain.TrainLengthUnits value)	Sets the gui units used to enter or display (The units are always held in scale meters)
void	setTrainName(String s)
void	setTrainsFrom(DispatcherFrame.TrainsFrom value)
void	setTrainType(String s)
void	setTrainUserName(String s)
void	setTransitId(String s)
void	setTransitName(String s)
void	setUseSpeedProfile(boolean b)
void	setUseStopSensor(boolean value)
void	setVersion(int ver)
void	setViaBlockName(String s)
void	setWaitTime(float f)

Methods inherited from class java.lang.Object

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

Constructor Details

TrainInfo

public TrainInfo()

Method Details

setVersion

public void setVersion(int ver)

getVersion

public int getVersion()

setTransitName

public void setTransitName(String s)

getTransitName

public String getTransitName()

setTransitId

public void setTransitId(String s)

getTransitId

public String getTransitId()

setDynamicTransit

public void setDynamicTransit(boolean b)

getDynamicTransit

public boolean getDynamicTransit()

setDynamicTransitCloseLoopIfPossible

public void setDynamicTransitCloseLoopIfPossible(boolean b)

getDynamicTransitCloseLoopIfPossible

public boolean getDynamicTransitCloseLoopIfPossible()

setTrainName

public void setTrainName(String s)

getTrainName

public String getTrainName()

setRosterId

public void setRosterId(String s)

getRosterId

public String getRosterId()

getUseStopSensor

public boolean getUseStopSensor()

setUseStopSensor

public void setUseStopSensor(boolean value)

setTrainUserName

public void setTrainUserName(String s)

getTrainUserName

public String getTrainUserName()

setDccAddress

public void setDccAddress(String s)

getDccAddress

public String getDccAddress()

setTrainInTransit

public void setTrainInTransit(boolean b)

getTrainInTransit

public boolean getTrainInTransit()

setStartBlockName

public void setStartBlockName(String s)

getStartBlockName

public String getStartBlockName()

setViaBlockName

public void setViaBlockName(String s)

getViaBlockName

public String getViaBlockName()

setStartBlockId

public void setStartBlockId(String s)

getStartBlockId

public String getStartBlockId()

setStartBlockSeq

public void setStartBlockSeq(int i)

getStartBlockSeq

public int getStartBlockSeq()

setDestinationBlockName

public void setDestinationBlockName(String s)

getDestinationBlockName

public String getDestinationBlockName()

setDestinationBlockId

public void setDestinationBlockId(String s)

setStopByDistanceMm

public void setStopByDistanceMm(float value)

setStopByDistanceRef

public void setStopByDistanceRef(TrainInfo.StopReference value)

getStopByDistanceMm

public float getStopByDistanceMm()

getStopByDistanceRef

public TrainInfo.StopReference getStopByDistanceRef()

getDestinationBlockId

public String getDestinationBlockId()

setDestinationBlockSeq

public void setDestinationBlockSeq(int i)

getDestinationBlockSeq

public int getDestinationBlockSeq()

setTrainsFrom

public void setTrainsFrom(DispatcherFrame.TrainsFrom value)

getTrainsFrom

public DispatcherFrame.TrainsFrom getTrainsFrom()

setTrainFromRoster

public void setTrainFromRoster(boolean b)

getTrainFromRoster

public boolean getTrainFromRoster()

setTrainFromTrains

public void setTrainFromTrains(boolean b)

getTrainFromTrains

public boolean getTrainFromTrains()

setTrainFromUser

public void setTrainFromUser(boolean b)

getTrainFromUser

public boolean getTrainFromUser()

setTrainFromSetLater

public void setTrainFromSetLater(boolean b)

getTrainFromSetLater

public boolean getTrainFromSetLater()

setTerminateWhenDone

public void setTerminateWhenDone(boolean b)

getTerminateWhenDone

public boolean getTerminateWhenDone()

setNextTrain

public void setNextTrain(String s)

getNextTrain

public String getNextTrain()

setPriority

public void setPriority(int pri)

getPriority

public int getPriority()

setAutoRun

public void setAutoRun(boolean b)

getAutoRun

public boolean getAutoRun()

setResetWhenDone

public void setResetWhenDone(boolean b)

getResetWhenDone

public boolean getResetWhenDone()

setAllocateAllTheWay

public void setAllocateAllTheWay(boolean b)

getAllocateAllTheWay

public boolean getAllocateAllTheWay()

setAllocationMethod

public void setAllocationMethod(int i)

getAllocationMethod

public int getAllocationMethod()

setUseSpeedProfile

public void setUseSpeedProfile(boolean b)

getUseSpeedProfile

public boolean getUseSpeedProfile()

setStopBySpeedProfile

public void setStopBySpeedProfile(boolean b)

getStopBySpeedProfile

public boolean getStopBySpeedProfile()

setStopBySpeedProfileAdjust

public void setStopBySpeedProfileAdjust(float f)

getStopBySpeedProfileAdjust

public float getStopBySpeedProfileAdjust()

setReverseAtEnd

public void setReverseAtEnd(boolean b)

getReverseAtEnd

public boolean getReverseAtEnd()

setDelayedStart

public void setDelayedStart(int ds)

getDelayedStart

public int getDelayedStart()

delayed start code for this train

Returns:

one of ActiveTrain.NODELAY,TIMEDDELAY,SENSORDELAY

setDepartureTimeHr

public void setDepartureTimeHr(int hr)

getDepartureTimeHr

public int getDepartureTimeHr()

setDepartureTimeMin

public void setDepartureTimeMin(int min)

getDepartureTimeMin

public int getDepartureTimeMin()

setDelaySensorName

public void setDelaySensorName(String sen)

getDelaySensorName

public String getDelaySensorName()

setReverseDelayedRestart

public void setReverseDelayedRestart(int ds)

getReverseDelayedRestart

public int getReverseDelayedRestart()

return restart code for this train, only used for continuous running

Returns:

one of ActiveTrain.NODELAY,TIMEDDELAY,SENSORDELAY

setReverseRestartSensorName

public void setReverseRestartSensorName(String value)

getReverseRestartSensorName

public String getReverseRestartSensorName()

setReverseResetRestartSensor

public void setReverseResetRestartSensor(boolean value)

getReverseResetRestartSensor

public boolean getReverseResetRestartSensor()

getReverseRestartSensor

public Sensor getReverseRestartSensor()

setReverseRestartDelayMin

public void setReverseRestartDelayMin(int value)

getReverseRestartDelayMin

public int getReverseRestartDelayMin()

getDelaySensor

public Sensor getDelaySensor()

retrieve the startup delay sensor using the delay sensor name

Returns:

delay sensor, or null if delay sensor name not set

getResetStartSensor

public boolean getResetStartSensor()

setResetStartSensor

public void setResetStartSensor(boolean b)

setTrainType

public void setTrainType(String s)

getTrainType

public String getTrainType()

setDelayedRestart

public void setDelayedRestart(int ds)

getDelayedRestart

public int getDelayedRestart()

return restart code for this train, only used for continuous running

Returns:

one of ActiveTrain.NODELAY,TIMEDDELAY,SENSORDELAY

setRestartSensorName

public void setRestartSensorName(String sen)

getRestartSensorName

public String getRestartSensorName()

getRestartSensor

public Sensor getRestartSensor()

retrieve the restart sensor using the restart sensor name

Returns:

restart sensor, or null if the restart sensor name not set

getResetRestartSensor

public boolean getResetRestartSensor()

setResetRestartSensor

public void setResetRestartSensor(boolean b)

setRestartDelayMin

public void setRestartDelayMin(int s)

number of minutes to delay between restarting for continuous runs

Parameters:

s - number of minutes to delay

getRestartDelayMin

public int getRestartDelayMin()

getLoadAtStartup

public boolean getLoadAtStartup()

setLoadAtStartup

public void setLoadAtStartup(boolean loadAtStartup)

setSpeedFactor

public void setSpeedFactor(float f)

getSpeedFactor

public Float getSpeedFactor()

setMaxSpeed

public void setMaxSpeed(float f)

getMaxSpeed

public Float getMaxSpeed()

setMaxSpeedScaleKmh

public void setMaxSpeedScaleKmh(float kmh)

Sets the maximum speed in scale km/h. Use 0.0f to disable and fall back to throttle percent.

Parameters:

kmh - scale kilometers per hour

getMaxSpeedScaleKmh

public float getMaxSpeedScaleKmh()

Gets the maximum speed in scale km/h. 0.0f means "disabled".

Returns:

scale km/h

setMinReliableOperatingSpeed

public void setMinReliableOperatingSpeed(float f)

getMinReliableOperatingSpeed

public float getMinReliableOperatingSpeed()

setRampRate

public void setRampRate(String s)

getRampRate

public String getRampRate()

setTrainDetection

public void setTrainDetection(ActiveTrain.TrainDetection b)

Set the detection get

Parameters:

b - ActiveTrain.TrainDetection

getTrainDetection

public ActiveTrain.TrainDetection getTrainDetection()

Get the detection type

Returns:

ActiveTrain.TrainDetection

setResistanceWheels

@Deprecated(since="5.7.6",
            forRemoval=true)
public void setResistanceWheels(boolean b)

Deprecated, for removal: This API element is subject to removal in a future version.

use setTrainDetection(jmri.jmrit.dispatcher.ActiveTrain.TrainDetection)

Parameters:

b - true or false

getResistanceWheels

@Deprecated(since="5.7.6",
            forRemoval=true)
public boolean getResistanceWheels()

Deprecated, for removal: This API element is subject to removal in a future version.

use getTrainDetection()

Returns:

true or false

setRunInReverse

public void setRunInReverse(boolean b)

getRunInReverse

public boolean getRunInReverse()

setSoundDecoder

public void setSoundDecoder(boolean b)

getSoundDecoder

public boolean getSoundDecoder()

setFNumberLight

public void setFNumberLight(int value)

Sets F number for the Light

Parameters:

value - F Number.

getFNumberLight

public int getFNumberLight()

returns the F number for the Light

Returns:

F Number

setFNumberBell

public void setFNumberBell(int value)

Sets F number for the Bell

Parameters:

value - F Number.

getFNumberBell

public int getFNumberBell()

returns the F number for the Bell

Returns:

F Number

setFNumberHorn

public void setFNumberHorn(int value)

Sets F number for the Horn

Parameters:

value - F Number.

getFNumberHorn

public int getFNumberHorn()

returns the F number for the Horn

Returns:

F Number

setMaxTrainLength

@Deprecated(since="5.9.7",
            forRemoval=true)
public void setMaxTrainLength(float f)

Deprecated, for removal: This API element is subject to removal in a future version.

use setMaxTrainLengthScaleMeters(float) or setMaxTrainLengthScaleMeters(float)

Parameters:

f - train length

getMaxTrainLength

@Deprecated(since="5.9.7",
            forRemoval=true)
public float getMaxTrainLength()

Deprecated, for removal: This API element is subject to removal in a future version.

use getMaxTrainLengthScaleMeters() or getMaxTrainLengthScaleFeet()

Returns:

train length of in units of the writing application

setMaxTrainLengthScaleMeters

public void setMaxTrainLengthScaleMeters(float f)

Sets the max train length expected during run

Parameters:

f - scale Meters.

getMaxTrainLengthScaleMeters

public float getMaxTrainLengthScaleMeters()

Gets the Max train length expected during run

Returns:

scale meters

setMaxTrainLengthScaleFeet

public void setMaxTrainLengthScaleFeet(float f)

Sets the max train length expected

Parameters:

f - scale Meters.

getMaxTrainLengthScaleFeet

public float getMaxTrainLengthScaleFeet()

Gets the Max train length expected during route

Returns:

scale meters

setTrainLengthUnits

public void setTrainLengthUnits(ActiveTrain.TrainLengthUnits value)

Sets the gui units used to enter or display (The units are always held in scale meters)

Parameters:

value - ActiveTrain.TrainLengthUnits

getTrainLengthUnits

public ActiveTrain.TrainLengthUnits getTrainLengthUnits()

Get the GUI units entered (The data is held in scale Meters)

Returns:

ActiveTrain.TrainLengthUnits

setWaitTime

public void setWaitTime(float f)

getWaitTime

public float getWaitTime()

setBlockName

public void setBlockName(String s)

getBlockName

public String getBlockName()

setAdditionalTrainWeightMetricTonnes

public void setAdditionalTrainWeightMetricTonnes(float value)

getAdditionalTrainWeightMetricTonnes

public float getAdditionalTrainWeightMetricTonnes()

setRollingResistanceCoeff

public void setRollingResistanceCoeff(float value)

getRollingResistanceCoeff

public float getRollingResistanceCoeff()

setDriverPowerPercent

public void setDriverPowerPercent(float value)

Sets the driver's applied power/regulator during acceleration (0.0..1.0).

getDriverPowerPercent

public float getDriverPowerPercent()

Gets the driver's applied power/regulator during acceleration (0.0..1.0).