Package jmri.jmrit.operations.locations

Class Track

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.locations.Track

All Implemented Interfaces:

PropertyChangeFirer, PropertyChangeProvider

public class Track
extends PropertyChangeSupport

Represents a location (track) on the layout Can be a spur, yard, staging, or interchange track.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_alternateTrackId
protected int	_blockingOrder
protected int	_blockOptions
protected String	_comment
protected String	_commentBoth
protected String	_commentPickup
protected String	_commentSetout
protected List<String>	_destinationIdList
protected String	_destinationOption
protected List<String>	_dropList
protected String	_dropOption
protected int	_dropRS
protected boolean	_holdCustomLoads
protected String	_id
protected int	_ignoreUsedLengthPercentage
protected int	_length
protected List<String>	_loadList
protected String	_loadOption
protected int	_loadOptions
protected Location	_location
protected int	_maximumLength
protected int	_minimumLength
protected int	_mode
protected int	_moves
protected String	_name
protected int	_numberCars
protected int	_numberCarsEnRoute
protected int	_numberEngines
protected int	_numberRS
protected boolean	_onlyCarsWithFD
protected String	_order
protected List<String>	_pickupList
protected String	_pickupOption
protected int	_pickupRS
protected Pool	_pool
protected boolean	_printCommentManifest
protected boolean	_printCommentSwitchList
protected Reporter	_reader
protected int	_reservationFactor
protected int	_reserved
protected int	_reservedEnRoute
protected int	_reservedLengthPickups
protected int	_reservedLengthSetouts
protected List<String>	_roadList
protected String	_roadOption
protected int	_scheduleCount
protected String	_scheduleId
protected String	_scheduleItemId
protected String	_scheduleName
protected List<String>	_shipLoadList
protected String	_shipLoadOption
protected String	_trackPriority
protected String	_trackType
protected int	_trainDir
protected List<String>	_typeList
protected int	_usedLength
static final String	ALL
static final String	ALL_DESTINATIONS
static final String	ALL_LOADS
static final String	ALL_ROADS
static final String	ALTERNATE_TRACK_CHANGED_PROPERTY
static final String	ANY
static final String	CAPACITY
static final String	CUSTOM
static final String	DESTINATION
static final String	DESTINATION_OPTIONS_CHANGED_PROPERTY
static final String	DESTINATIONS_CHANGED_PROPERTY
static final String	DISPOSE_CHANGED_PROPERTY
static final String	DROP_CHANGED_PROPERTY
static final int	EAST
static final String	EXCLUDE_DESTINATIONS
static final String	EXCLUDE_LOADS
static final String	EXCLUDE_ROADS
static final String	EXCLUDE_ROUTES
static final String	EXCLUDE_TRAINS
static final String	FIFO
static final String	HOLD_CARS_CHANGED_PROPERTY
static final int	IGNORE_0
static final int	IGNORE_100
static final int	IGNORE_25
static final int	IGNORE_50
static final int	IGNORE_75
static final String	INCLUDE_DESTINATIONS
static final String	INCLUDE_LOADS
static final String	INCLUDE_ROADS
static final String	INTERCHANGE
static final String	LENGTH
static final String	LENGTH_CHANGED_PROPERTY
static final String	LIFO
static final String	LOAD
static final String	LOAD_OPTIONS_CHANGED_PROPERTY
static final String	LOADS_CHANGED_PROPERTY
static final int	MATCH
static final String	MAX_LENGTH_CHANGED_PROPERTY
static final String	MIN_LENGTH_CHANGED_PROPERTY
static final String	NAME_CHANGED_PROPERTY
static final String	NO_FINAL_DESTINATION
static final String	NONE
static final String	NORMAL
static final int	NORTH
static final String	OKAY
static final String	PICKUP_CHANGED_PROPERTY
static final String	PICKUP_OKAY
static final String	PLANNED_PICKUPS_CHANGED_PROPERTY
static final String	POOL_CHANGED_PROPERTY
static final String	PRIORITY_CHANGED_PROPERTY
static final String	PRIORITY_HIGH
static final String	PRIORITY_LOW
static final String	PRIORITY_MEDIUM
static final String	PRIORITY_NORMAL
static final String	ROAD
static final String	ROADS_CHANGED_PROPERTY
static final String	ROUTED_CHANGED_PROPERTY
static final String	ROUTES
static final String	SCHEDULE
static final String	SCHEDULE_CHANGED_PROPERTY
static final String	SCHEDULE_ID_CHANGED_PROPERTY
static final String	SCHEDULE_MODE_CHANGED_PROPERTY
static final int	SEQUENTIAL
static final String	SERVICE_ORDER_CHANGED_PROPERTY
static final int	SOUTH
static final String	SPUR
static final String	STAGING
static final String	TRACK_BLOCKING_ORDER_CHANGED_PROPERTY
static final String	TRACK_COMMENT_CHANGED_PROPERTY
static final String	TRACK_FACTOR_CHANGED_PROPERTY
static final String	TRACK_REPORTER_CHANGED_PROPERTY
static final String	TRACK_TYPE_CHANGED_PROPERTY
static final String	TRAIN_DIRECTION_CHANGED_PROPERTY
static final String	TRAIN_SCHEDULE
static final String	TRAINS
static final String	TYPE
static final String	TYPES_CHANGED_PROPERTY
static final int	WEST
static final String	YARD

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
Track(String id, String name, String type, Location location)
Track(org.jdom2.Element e, Location location)	Construct this Entry from XML.

Method Summary

Modifier and Type	Method	Description
void	addDestination(Location destination)	adds a location to the list of acceptable destinations for this track.
void	addDropId(String id)
void	addDropRS(RollingStock rs)
void	addLoadName(String load)	Add a receive load that the track will either service or exclude.
void	addPickupId(String id)	Add train or route id to this track.
void	addPickupRS(RollingStock rs)	Increments the number of cars and or engines that will be picked up by a train from this track.
void	addReservedInRoute(Car car)
void	addRoadName(String road)
void	addRS(RollingStock rs)	Adds rolling stock to a specific track.
void	addShipLoadName(String load)	Add a ship load that the track will either service or exclude.
void	addTypeName(String type)
void	bumpMoves()
void	bumpSchedule()	Increments the schedule count if there's a schedule and the schedule is running in sequential mode.
String	checkPickups()	Checks to see if all car types can be pulled from this track
String	checkSchedule(Car car)	Checks to see if car can be placed on this spur using this schedule.
boolean	checkScheduleAttribute(String attribute, String carType, Car car)
String	checkScheduleValid()	Check to see if schedule is valid for the track at this location.
boolean	containsDropId(String id)
boolean	containsPickupId(String id)
boolean	containsRoadName(String road)
Track	copyTrack(String newName, Location newLocation)	Creates a copy of this track.
void	deleteDestination(Location destination)
void	deleteDropId(String id)
void	deleteDropRS(RollingStock rs)
void	deleteLoadName(String load)	Delete a receive load name that the track will either service or exclude.
void	deletePickupId(String id)
void	deletePickupRS(RollingStock rs)
void	deleteReservedInRoute(Car car)
void	deleteRoadName(String road)
void	deleteRS(RollingStock rs)
void	deleteShipLoadName(String load)	Delete a ship load name that the track will either service or exclude.
void	deleteTypeName(String type)
void	dispose()
Track	getAlternateTrack()	Returns the alternate track for a spur
int	getAvailableTrackSpace()	Available track space.
int	getBlockingOrder()	Gets the blocking order for this track.
String	getComment()
String	getCommentBoth()
String	getCommentBothWithColor()
String	getCommentPickup()
String	getCommentPickupWithColor()
String	getCommentSetout()
String	getCommentSetoutWithColor()
ScheduleItem	getCurrentScheduleItem()	Get's the current schedule item for this track Protects against user deleting an item in a shared schedule.
String[]	getDestinationIds()
int	getDestinationListSize()
String	getDestinationOption()	Get destination option for interchange or staging track
Division	getDivision()
String	getDivisionName()
String[]	getDropIds()
String	getDropOption()	Gets the drop option for this track.
int	getDropRS()
String	getId()
int	getIgnoreUsedLengthPercentage()
int	getLength()
String[]	getLoadNames()	Provides a list of receive loads that the track will either service or exclude.
String	getLoadOption()	Gets the car receive load option for this track.
String	getLoadOptionString()
Location	getLocation()
int	getMoves()
String	getName()
ScheduleItem	getNextScheduleItem()
int	getNumberCars()
int	getNumberEngines()
int	getNumberOfCarsInRoute()
int	getNumberRS()
String[]	getPickupIds()
String	getPickupOption()	Gets the pickup option for this track.
int	getPickupRS()
Pool	getPool()
int	getPoolMaximumLength()
int	getPoolMinimumLength()
String	getPoolName()
Reporter	getReporter()
String	getReporterName()
int	getReservationFactor()
int	getReserved()
int	getReservedInRoute()	Used to determine how much track space is going to be consumed by cars in route to this track.
int	getReservedLengthPickups()
int	getReservedLengthSetouts()
String[]	getRoadNames()
String	getRoadOption()
String	getRoadOptionString()
Schedule	getSchedule()
int	getScheduleCount()	Returns how many times the current schedule item has been accessed.
String	getScheduleId()
String	getScheduleItemId()	Recommend getCurrentScheduleItem() to get the current schedule item for this track.
int	getScheduleMode()	Gets the mode of operation for the schedule assigned to this track.
String	getScheduleModeName()
String	getScheduleName()	Returns the name of the schedule.
String	getServiceOrder()	Get the service order for this track.
String[]	getShipLoadNames()	Provides a list of ship loads that the track will either service or exclude.
String	getShipLoadOption()	Gets the car ship load option for this track.
String	getShipLoadOptionString()
String	getSplitName()
String	getTrackPriority()	A track has four priorities: PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_NORMAL, and PRIORITY_LOW.
String	getTrackType()	Gets the track type
String	getTrackTypeName()
static String	getTrackTypeName(String trackType)
int	getTrainDirections()
String[]	getTypeNames()	Returns all of the rolling stock type names serviced by this track.
int	getUsedLength()
boolean	hasMessages()
boolean	isAddCustomLoadsAnySpurEnabled()
boolean	isAddCustomLoadsAnyStagingTrackEnabled()
boolean	isAddCustomLoadsEnabled()
boolean	isAlternate()	Used to determine if track has been assigned as an alternate
boolean	isBlockCarsEnabled()	When enabled block cars from staging.
boolean	isDestinationAccepted(Location destination)	Returns true if destination is valid from this track.
boolean	isDisableLoadChangeEnabled()
boolean	isDropRouteAccepted(Route route)
boolean	isDropTrainAccepted(Train train)	Determine if train can set out cars to this track.
boolean	isHoldCarsWithCustomLoadsEnabled()	If enabled (true), hold cars with custom loads rather than allowing them to go to staging if the spur and the alternate track were full.
boolean	isInterchange()
boolean	isLoadEmptyEnabled()
boolean	isLoadNameAccepted(String load)	Determine if track will service a specific receive load name.
boolean	isLoadNameAndCarTypeAccepted(String load, String type)	Determine if track will service a specific receive load and car type.
boolean	isLoadNameAndCarTypeShipped(String load, String type)	Determine if track will service a specific ship load and car type.
boolean	isLoadNameShipped(String load)	Determine if track will service a specific ship load name.
boolean	isLoadSwapEnabled()
boolean	isModifyLoadsEnabled()
boolean	isOnlyCarsWithFinalDestinationEnabled()	When true the track will only accept cars that have a final destination that can be serviced by the track.
boolean	isPickupRouteAccepted(Route route)
boolean	isPickupTrainAccepted(Train train)	Determine if train can pick up cars from this track.
boolean	isPrintManifestCommentEnabled()
boolean	isPrintSwitchListCommentEnabled()
boolean	isQuickServiceEnabled()
boolean	isRemoveCustomLoadsEnabled()
boolean	isRoadNameAccepted(String road)
String	isRollingStockAccepted(RollingStock rs)	Used to determine if track can service the rolling stock.
boolean	isSpaceAvailable(Car car)	Used to determine if there's space available at this track for the car.
boolean	isSpur()
boolean	isStaging()
boolean	isTypeNameAccepted(String type)
boolean	isYard()
String	scheduleNext(Car car)	Check to see if track has schedule and if it does will schedule the next item in the list.
void	setAddCustomLoadsAnySpurEnabled(boolean enable)	When enabled, add custom car loads if there's a demand by any spur/industry.
void	setAddCustomLoadsAnyStagingTrackEnabled(boolean enable)	When enabled, add custom car loads to cars in staging for new destinations that are staging.
void	setAddCustomLoadsEnabled(boolean enable)	When enabled, add custom car loads if there's a demand.
void	setAlternateTrack(Track track)
void	setBlockCarsEnabled(boolean enable)
void	setBlockingOrder(int order)
void	setComment(String comment)
void	setCommentBoth(String comment)
void	setCommentPickup(String comment)
void	setCommentSetout(String comment)
void	setDestinationIds(String[] ids)
void	setDestinationOption(String option)	Sets the destination option for this track.
protected void	setDirtyAndFirePropertyChange(String p, Object old, Object n)
void	setDisableLoadChangeEnabled(boolean enable)
void	setDropOption(String option)	Set the car drop option for this track.
void	setHoldCarsWithCustomLoadsEnabled(boolean enable)
void	setIgnoreUsedLengthPercentage(int percentage)	The amount of consumed track space to be ignored when sending new rolling stock to the track.
void	setLength(int length)
void	setLoadEmptyEnabled(boolean enable)	Enable setting the car generic load state to empty when car arrives at this track.
void	setLoadOption(String option)	Set how this track deals with receiving car loads
void	setLoadSwapEnabled(boolean enable)	Enable changing the car generic load state when car arrives at this track.
void	setMoves(int moves)
void	setName(String name)
void	setOnlyCarsWithFinalDestinationEnabled(boolean enable)
void	setPickupOption(String option)	Set the car pick up option for this track.
void	setPool(Pool pool)
void	setPoolMaximumLength(int length)	Sets the maximum length of this track when the track is in a pool.
void	setPoolMinimumLength(int length)	Sets the minimum length of this track when the track is in a pool.
void	setPrintManifestCommentEnabled(boolean enable)
void	setPrintSwitchListCommentEnabled(boolean enable)
void	setQuickServiceEnabled(boolean enable)
void	setRemoveCustomLoadsEnabled(boolean enable)	When enabled, remove Scheduled car loads.
void	setReporter(Reporter r)
void	setReservationFactor(int factor)	Set the reservation factor.
protected void	setReserved(int reserved)	The amount of track space that is reserved for car drops or pick ups.
void	setRoadOption(String option)	Set the road option for this track.
void	setSchedule(Schedule schedule)
void	setScheduleCount(int count)
void	setScheduleId(String id)
void	setScheduleItemId(String id)
void	setScheduleMode(int mode)	Sets the mode of operation for the schedule assigned to this track.
void	setServiceOrder(String order)	Set the service order for this track.
void	setShipLoadOption(String option)	Set how this track deals with shipping car loads
void	setTrackPriority(String priority)
void	setTrackType(String type)	Sets the track type, spur, interchange, yard, staging
void	setTrainDirections(int direction)	Sets the train directions that can service this track
void	setUsedLength(int length)
org.jdom2.Element	store()	Create an XML element to represent this Entry.
String	toString()

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final String NONE

See Also:

• Constant Field Values

_id

protected String _id

_name

protected String _name

_trackType

protected String _trackType

_location

protected Location _location

_trainDir

protected int _trainDir

_numberRS

protected int _numberRS

_numberCars

protected int _numberCars

_numberEngines

protected int _numberEngines

_pickupRS

protected int _pickupRS

_dropRS

protected int _dropRS

_length

protected int _length

_reserved

protected int _reserved

_reservedLengthSetouts

protected int _reservedLengthSetouts

_reservedLengthPickups

protected int _reservedLengthPickups

_numberCarsEnRoute

protected int _numberCarsEnRoute

_usedLength

protected int _usedLength

_ignoreUsedLengthPercentage

protected int _ignoreUsedLengthPercentage

IGNORE_0

public static final int IGNORE_0

See Also:

• Constant Field Values

IGNORE_25

public static final int IGNORE_25

See Also:

• Constant Field Values

IGNORE_50

public static final int IGNORE_50

See Also:

• Constant Field Values

IGNORE_75

public static final int IGNORE_75

See Also:

• Constant Field Values

IGNORE_100

public static final int IGNORE_100

See Also:

• Constant Field Values

_moves

protected int _moves

_blockingOrder

protected int _blockingOrder

_alternateTrackId

protected String _alternateTrackId

_comment

protected String _comment

_typeList

protected List<String> _typeList

_printCommentManifest

protected boolean _printCommentManifest

_printCommentSwitchList

protected boolean _printCommentSwitchList

_commentPickup

protected String _commentPickup

_commentSetout

protected String _commentSetout

_commentBoth

protected String _commentBoth

_roadOption

protected String _roadOption

_roadList

protected List<String> _roadList

_loadOption

protected String _loadOption

_loadList

protected List<String> _loadList

_shipLoadOption

protected String _shipLoadOption

_shipLoadList

protected List<String> _shipLoadList

_destinationOption

protected String _destinationOption

_destinationIdList

protected List<String> _destinationIdList

_scheduleName

protected String _scheduleName

_scheduleId

protected String _scheduleId

_scheduleItemId

protected String _scheduleItemId

_scheduleCount

protected int _scheduleCount

_reservedEnRoute

protected int _reservedEnRoute

_reservationFactor

protected int _reservationFactor

_mode

protected int _mode

_holdCustomLoads

protected boolean _holdCustomLoads

_dropOption

protected String _dropOption

_pickupOption

protected String _pickupOption

ANY

public static final String ANY

See Also:

• Constant Field Values

TRAINS

public static final String TRAINS

See Also:

• Constant Field Values

ROUTES

public static final String ROUTES

See Also:

• Constant Field Values

EXCLUDE_TRAINS

public static final String EXCLUDE_TRAINS

See Also:

• Constant Field Values

EXCLUDE_ROUTES

public static final String EXCLUDE_ROUTES

See Also:

• Constant Field Values

_dropList

protected List<String> _dropList

_pickupList

protected List<String> _pickupList

_loadOptions

protected int _loadOptions

_blockOptions

protected int _blockOptions

_order

protected String _order

NORMAL

public static final String NORMAL

FIFO

public static final String FIFO

LIFO

public static final String LIFO

_trackPriority

protected String _trackPriority

PRIORITY_HIGH

public static final String PRIORITY_HIGH

PRIORITY_MEDIUM

public static final String PRIORITY_MEDIUM

PRIORITY_NORMAL

public static final String PRIORITY_NORMAL

PRIORITY_LOW

public static final String PRIORITY_LOW

STAGING

public static final String STAGING

See Also:

• Constant Field Values

INTERCHANGE

public static final String INTERCHANGE

See Also:

• Constant Field Values

YARD

public static final String YARD

See Also:

• Constant Field Values

SPUR

public static final String SPUR

See Also:

• Constant Field Values

EAST

public static final int EAST

See Also:

• Constant Field Values

WEST

public static final int WEST

See Also:

• Constant Field Values

NORTH

public static final int NORTH

See Also:

• Constant Field Values

SOUTH

public static final int SOUTH

See Also:

• Constant Field Values

ALL_ROADS

public static final String ALL_ROADS

INCLUDE_ROADS

public static final String INCLUDE_ROADS

EXCLUDE_ROADS

public static final String EXCLUDE_ROADS

ALL_LOADS

public static final String ALL_LOADS

INCLUDE_LOADS

public static final String INCLUDE_LOADS

EXCLUDE_LOADS

public static final String EXCLUDE_LOADS

ALL_DESTINATIONS

public static final String ALL_DESTINATIONS

INCLUDE_DESTINATIONS

public static final String INCLUDE_DESTINATIONS

EXCLUDE_DESTINATIONS

public static final String EXCLUDE_DESTINATIONS

_onlyCarsWithFD

protected boolean _onlyCarsWithFD

SEQUENTIAL

public static final int SEQUENTIAL

See Also:

• Constant Field Values

MATCH

public static final int MATCH

See Also:

• Constant Field Values

PICKUP_OKAY

public static final String PICKUP_OKAY

See Also:

• Constant Field Values

_pool

protected Pool _pool

_minimumLength

protected int _minimumLength

_maximumLength

protected int _maximumLength

OKAY

public static final String OKAY

LENGTH

public static final String LENGTH

TYPE

public static final String TYPE

ROAD

public static final String ROAD

LOAD

public static final String LOAD

CAPACITY

public static final String CAPACITY

SCHEDULE

public static final String SCHEDULE

CUSTOM

public static final String CUSTOM

DESTINATION

public static final String DESTINATION

NO_FINAL_DESTINATION

public static final String NO_FINAL_DESTINATION

TYPES_CHANGED_PROPERTY

public static final String TYPES_CHANGED_PROPERTY

See Also:

• Constant Field Values

ROADS_CHANGED_PROPERTY

public static final String ROADS_CHANGED_PROPERTY

See Also:

• Constant Field Values

NAME_CHANGED_PROPERTY

public static final String NAME_CHANGED_PROPERTY

See Also:

• Constant Field Values

LENGTH_CHANGED_PROPERTY

public static final String LENGTH_CHANGED_PROPERTY

See Also:

• Constant Field Values

MIN_LENGTH_CHANGED_PROPERTY

public static final String MIN_LENGTH_CHANGED_PROPERTY

See Also:

• Constant Field Values

MAX_LENGTH_CHANGED_PROPERTY

public static final String MAX_LENGTH_CHANGED_PROPERTY

See Also:

• Constant Field Values

SCHEDULE_CHANGED_PROPERTY

public static final String SCHEDULE_CHANGED_PROPERTY

See Also:

• Constant Field Values

DISPOSE_CHANGED_PROPERTY

public static final String DISPOSE_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRAIN_DIRECTION_CHANGED_PROPERTY

public static final String TRAIN_DIRECTION_CHANGED_PROPERTY

See Also:

• Constant Field Values

DROP_CHANGED_PROPERTY

public static final String DROP_CHANGED_PROPERTY

See Also:

• Constant Field Values

PICKUP_CHANGED_PROPERTY

public static final String PICKUP_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRACK_TYPE_CHANGED_PROPERTY

public static final String TRACK_TYPE_CHANGED_PROPERTY

See Also:

• Constant Field Values

LOADS_CHANGED_PROPERTY

public static final String LOADS_CHANGED_PROPERTY

See Also:

• Constant Field Values

POOL_CHANGED_PROPERTY

public static final String POOL_CHANGED_PROPERTY

See Also:

• Constant Field Values

PLANNED_PICKUPS_CHANGED_PROPERTY

public static final String PLANNED_PICKUPS_CHANGED_PROPERTY

See Also:

• Constant Field Values

LOAD_OPTIONS_CHANGED_PROPERTY

public static final String LOAD_OPTIONS_CHANGED_PROPERTY

See Also:

• Constant Field Values

DESTINATIONS_CHANGED_PROPERTY

public static final String DESTINATIONS_CHANGED_PROPERTY

See Also:

• Constant Field Values

DESTINATION_OPTIONS_CHANGED_PROPERTY

public static final String DESTINATION_OPTIONS_CHANGED_PROPERTY

See Also:

• Constant Field Values

SCHEDULE_MODE_CHANGED_PROPERTY

public static final String SCHEDULE_MODE_CHANGED_PROPERTY

See Also:

• Constant Field Values

SCHEDULE_ID_CHANGED_PROPERTY

public static final String SCHEDULE_ID_CHANGED_PROPERTY

See Also:

• Constant Field Values

SERVICE_ORDER_CHANGED_PROPERTY

public static final String SERVICE_ORDER_CHANGED_PROPERTY

See Also:

• Constant Field Values

ALTERNATE_TRACK_CHANGED_PROPERTY

public static final String ALTERNATE_TRACK_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRACK_BLOCKING_ORDER_CHANGED_PROPERTY

public static final String TRACK_BLOCKING_ORDER_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRACK_REPORTER_CHANGED_PROPERTY

public static final String TRACK_REPORTER_CHANGED_PROPERTY

See Also:

• Constant Field Values

ROUTED_CHANGED_PROPERTY

public static final String ROUTED_CHANGED_PROPERTY

See Also:

• Constant Field Values

HOLD_CARS_CHANGED_PROPERTY

public static final String HOLD_CARS_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRACK_COMMENT_CHANGED_PROPERTY

public static final String TRACK_COMMENT_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRACK_FACTOR_CHANGED_PROPERTY

public static final String TRACK_FACTOR_CHANGED_PROPERTY

See Also:

• Constant Field Values

PRIORITY_CHANGED_PROPERTY

public static final String PRIORITY_CHANGED_PROPERTY

See Also:

• Constant Field Values

_reader

protected Reporter _reader

TRAIN_SCHEDULE

public static final String TRAIN_SCHEDULE

See Also:

• Constant Field Values

ALL

public static final String ALL

See Also:

• Constant Field Values

Constructor Details

Track

public Track(String id,
 String name,
 String type,
 Location location)

Track

public Track(org.jdom2.Element e,
 Location location)

Construct this Entry from XML. This member has to remain synchronized with the detailed DTD in operations-location.dtd.

Parameters:

e - Consist XML element

location - The Location loading this track.

Method Details

copyTrack

public Track copyTrack(String newName,
 Location newLocation)

Creates a copy of this track.

Parameters:

newName - The name of the new track.

newLocation - The location of the new track.

Returns:

Track

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

getLocation

public Location getLocation()

setName

public void setName(String name)

getName

public String getName()

getSplitName

public String getSplitName()

getDivision

public Division getDivision()

getDivisionName

public String getDivisionName()

isSpur

public boolean isSpur()

isYard

public boolean isYard()

isInterchange

public boolean isInterchange()

isStaging

public boolean isStaging()

hasMessages

public boolean hasMessages()

getTrackType

public String getTrackType()

Gets the track type

Returns:

Track.SPUR Track.YARD Track.INTERCHANGE or Track.STAGING

setTrackType

public void setTrackType(String type)

Sets the track type, spur, interchange, yard, staging

Parameters:

type - Track.SPUR Track.YARD Track.INTERCHANGE Track.STAGING

getTrackTypeName

public String getTrackTypeName()

getTrackTypeName

public static String getTrackTypeName(String trackType)

setLength

public void setLength(int length)

getLength

public int getLength()

setPoolMinimumLength

public void setPoolMinimumLength(int length)

Sets the minimum length of this track when the track is in a pool.

Parameters:

length - minimum

getPoolMinimumLength

public int getPoolMinimumLength()

setPoolMaximumLength

public void setPoolMaximumLength(int length)

Sets the maximum length of this track when the track is in a pool.

Parameters:

length - maximum

getPoolMaximumLength

public int getPoolMaximumLength()

setReserved

protected void setReserved(int reserved)

The amount of track space that is reserved for car drops or pick ups. Can be positive or negative.

Parameters:

reserved - the calculated track space

getReserved

public int getReserved()

addReservedInRoute

public void addReservedInRoute(Car car)

deleteReservedInRoute

public void deleteReservedInRoute(Car car)

getReservedInRoute

public int getReservedInRoute()

Used to determine how much track space is going to be consumed by cars in route to this track. See isSpaceAvailable().

Returns:

The length of all cars en route to this track including couplers.

getNumberOfCarsInRoute

public int getNumberOfCarsInRoute()

setReservationFactor

public void setReservationFactor(int factor)

Set the reservation factor. Default 100 (100%). Used by the program when generating car loads from staging. A factor of 100% allows the program to fill a track with car loads. Numbers over 100% can overload a track.

Parameters:

factor - A number from 0 to 10000.

getReservationFactor

public int getReservationFactor()

setScheduleMode

public void setScheduleMode(int mode)

Sets the mode of operation for the schedule assigned to this track.

Parameters:

mode - Track.SEQUENTIAL or Track.MATCH

getScheduleMode

public int getScheduleMode()

Gets the mode of operation for the schedule assigned to this track.

Returns:

Mode of operation: Track.SEQUENTIAL or Track.MATCH

getScheduleModeName

public String getScheduleModeName()

setAlternateTrack

public void setAlternateTrack(Track track)

getAlternateTrack

public Track getAlternateTrack()

Returns the alternate track for a spur

Returns:

alternate track

setHoldCarsWithCustomLoadsEnabled

public void setHoldCarsWithCustomLoadsEnabled(boolean enable)

isHoldCarsWithCustomLoadsEnabled

public boolean isHoldCarsWithCustomLoadsEnabled()

If enabled (true), hold cars with custom loads rather than allowing them to go to staging if the spur and the alternate track were full. If disabled, cars with custom loads can be forwarded to staging when this spur and all others with this option are also false.

Returns:

True if enabled

isSpaceAvailable

public boolean isSpaceAvailable(Car car)

Used to determine if there's space available at this track for the car. Considers cars en-route to this track. Used to prevent overloading the track.

Parameters:

car - The car to be set out.

Returns:

true if space available.

setUsedLength

public void setUsedLength(int length)

getUsedLength

public int getUsedLength()

setIgnoreUsedLengthPercentage

public void setIgnoreUsedLengthPercentage(int percentage)

The amount of consumed track space to be ignored when sending new rolling stock to the track. See Planned Pickups in help.

Parameters:

percentage - a number between 0 and 100

getIgnoreUsedLengthPercentage

public int getIgnoreUsedLengthPercentage()

getNumberRS

public int getNumberRS()

Returns:

The number of rolling stock (cars and engines) on this track

getNumberCars

public int getNumberCars()

Returns:

The number of cars on this track

getNumberEngines

public int getNumberEngines()

Returns:

The number of engines on this track

addRS

public void addRS(RollingStock rs)

Adds rolling stock to a specific track.

Parameters:

rs - The rolling stock to place on the track.

deleteRS

public void deleteRS(RollingStock rs)

addPickupRS

public void addPickupRS(RollingStock rs)

Increments the number of cars and or engines that will be picked up by a train from this track.

Parameters:

rs - The rolling stock.

deletePickupRS

public void deletePickupRS(RollingStock rs)

getPickupRS

public int getPickupRS()

Returns:

the number of rolling stock (cars and or locos) that are scheduled for pick up from this track.

getReservedLengthPickups

public int getReservedLengthPickups()

addDropRS

public void addDropRS(RollingStock rs)

deleteDropRS

public void deleteDropRS(RollingStock rs)

getDropRS

public int getDropRS()

getReservedLengthSetouts

public int getReservedLengthSetouts()

setComment

public void setComment(String comment)

getComment

public String getComment()

setCommentPickup

public void setCommentPickup(String comment)

getCommentPickup

public String getCommentPickup()

getCommentPickupWithColor

public String getCommentPickupWithColor()

setCommentSetout

public void setCommentSetout(String comment)

getCommentSetout

public String getCommentSetout()

getCommentSetoutWithColor

public String getCommentSetoutWithColor()

setCommentBoth

public void setCommentBoth(String comment)

getCommentBoth

public String getCommentBoth()

getCommentBothWithColor

public String getCommentBothWithColor()

isPrintManifestCommentEnabled

public boolean isPrintManifestCommentEnabled()

setPrintManifestCommentEnabled

public void setPrintManifestCommentEnabled(boolean enable)

isPrintSwitchListCommentEnabled

public boolean isPrintSwitchListCommentEnabled()

setPrintSwitchListCommentEnabled

public void setPrintSwitchListCommentEnabled(boolean enable)

getTypeNames

public String[] getTypeNames()

Returns all of the rolling stock type names serviced by this track.

Returns:

rolling stock type names

addTypeName

public void addTypeName(String type)

deleteTypeName

public void deleteTypeName(String type)

isTypeNameAccepted

public boolean isTypeNameAccepted(String type)

setTrainDirections

public void setTrainDirections(int direction)

Sets the train directions that can service this track

Parameters:

direction - EAST, WEST, NORTH, SOUTH

getTrainDirections

public int getTrainDirections()

getRoadOption

public String getRoadOption()

getRoadOptionString

public String getRoadOptionString()

setRoadOption

public void setRoadOption(String option)

Set the road option for this track.

Parameters:

option - ALLROADS, INCLUDEROADS, or EXCLUDEROADS

getRoadNames

public String[] getRoadNames()

addRoadName

public void addRoadName(String road)

deleteRoadName

public void deleteRoadName(String road)

isRoadNameAccepted

public boolean isRoadNameAccepted(String road)

containsRoadName

public boolean containsRoadName(String road)

getLoadOption

public String getLoadOption()

Gets the car receive load option for this track.

Returns:

ALL_LOADS INCLUDE_LOADS EXCLUDE_LOADS

getLoadOptionString

public String getLoadOptionString()

setLoadOption

public void setLoadOption(String option)

Set how this track deals with receiving car loads

Parameters:

option - ALL_LOADS INCLUDE_LOADS EXCLUDE_LOADS

getLoadNames

public String[] getLoadNames()

Provides a list of receive loads that the track will either service or exclude. See setLoadOption

Returns:

Array of load names as Strings

addLoadName

public void addLoadName(String load)

Add a receive load that the track will either service or exclude. See setLoadOption

Parameters:

load - The string load name.

deleteLoadName

public void deleteLoadName(String load)

Delete a receive load name that the track will either service or exclude. See setLoadOption

Parameters:

load - The string load name.

isLoadNameAccepted

public boolean isLoadNameAccepted(String load)

Determine if track will service a specific receive load name.

Parameters:

load - the load name to check.

Returns:

true if track will service this load.

isLoadNameAndCarTypeAccepted

public boolean isLoadNameAndCarTypeAccepted(String load,
 String type)

Determine if track will service a specific receive load and car type.

Parameters:

load - the load name to check.

type - the type of car used to carry the load.

Returns:

true if track will service this load.

getShipLoadOption

public String getShipLoadOption()

Gets the car ship load option for this track.

Returns:

ALL_LOADS INCLUDE_LOADS EXCLUDE_LOADS

getShipLoadOptionString

public String getShipLoadOptionString()

setShipLoadOption

public void setShipLoadOption(String option)

Set how this track deals with shipping car loads

Parameters:

option - ALL_LOADS INCLUDE_LOADS EXCLUDE_LOADS

getShipLoadNames

public String[] getShipLoadNames()

Provides a list of ship loads that the track will either service or exclude. See setShipLoadOption

Returns:

Array of load names as Strings

addShipLoadName

public void addShipLoadName(String load)

Add a ship load that the track will either service or exclude. See setShipLoadOption

Parameters:

load - The string load name.

deleteShipLoadName

public void deleteShipLoadName(String load)

Delete a ship load name that the track will either service or exclude. See setLoadOption

Parameters:

load - The string load name.

isLoadNameShipped

public boolean isLoadNameShipped(String load)

Determine if track will service a specific ship load name.

Parameters:

load - the load name to check.

Returns:

true if track will service this load.

isLoadNameAndCarTypeShipped

public boolean isLoadNameAndCarTypeShipped(String load,
 String type)

Determine if track will service a specific ship load and car type.

Parameters:

load - the load name to check.

type - the type of car used to carry the load.

Returns:

true if track will service this load.

getDropOption

public String getDropOption()

Gets the drop option for this track. ANY means that all trains and routes can drop cars to this track. The other four options are used to restrict the track to certain trains or routes.

Returns:

ANY, TRAINS, ROUTES, EXCLUDE_TRAINS, or EXCLUDE_ROUTES

setDropOption

public void setDropOption(String option)

Set the car drop option for this track.

Parameters:

option - ANY, TRAINS, ROUTES, EXCLUDE_TRAINS, or EXCLUDE_ROUTES

getPickupOption

public String getPickupOption()

Gets the pickup option for this track. ANY means that all trains and routes can pull cars from this track. The other four options are used to restrict the track to certain trains or routes.

Returns:

ANY, TRAINS, ROUTES, EXCLUDE_TRAINS, or EXCLUDE_ROUTES

setPickupOption

public void setPickupOption(String option)

Set the car pick up option for this track.

Parameters:

option - ANY, TRAINS, ROUTES, EXCLUDE_TRAINS, or EXCLUDE_ROUTES

getDropIds

public String[] getDropIds()

addDropId

public void addDropId(String id)

deleteDropId

public void deleteDropId(String id)

isDropTrainAccepted

public boolean isDropTrainAccepted(Train train)

Determine if train can set out cars to this track. Based on the train's id or train's route id. See setDropOption(option).

Parameters:

train - The Train to test.

Returns:

true if the train can set out cars to this track.

isDropRouteAccepted

public boolean isDropRouteAccepted(Route route)

containsDropId

public boolean containsDropId(String id)

getPickupIds

public String[] getPickupIds()

addPickupId

public void addPickupId(String id)

Add train or route id to this track.

Parameters:

id - The string id for the train or route.

deletePickupId

public void deletePickupId(String id)

isPickupTrainAccepted

public boolean isPickupTrainAccepted(Train train)

Determine if train can pick up cars from this track. Based on the train's id or train's route id. See setPickupOption(option).

Parameters:

train - The Train to test.

Returns:

true if the train can pick up cars from this track.

isPickupRouteAccepted

public boolean isPickupRouteAccepted(Route route)

containsPickupId

public boolean containsPickupId(String id)

checkPickups

public String checkPickups()

Checks to see if all car types can be pulled from this track

Returns:

PICKUP_OKAY if any train can pull all car types from this track

getTrackPriority

public String getTrackPriority()

A track has four priorities: PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_NORMAL, and PRIORITY_LOW. Cars are serviced from a location based on the track priority. Default is normal.

Returns:

track priority

setTrackPriority

public void setTrackPriority(String priority)

isRollingStockAccepted

public String isRollingStockAccepted(RollingStock rs)

Used to determine if track can service the rolling stock.

Parameters:

rs - the car or loco to be tested

Returns:

Error string starting with TYPE, ROAD, CAPACITY, LENGTH, DESTINATION or LOAD if there's an issue. OKAY if track can service Rolling Stock.

getAvailableTrackSpace

public int getAvailableTrackSpace()

Available track space. Adjusted when a track is using the planned pickups feature

Returns:

available track space

getMoves

public int getMoves()

setMoves

public void setMoves(int moves)

bumpMoves

public void bumpMoves()

getBlockingOrder

public int getBlockingOrder()

Gets the blocking order for this track. Default is zero, in that case, tracks are sorted by name.

Returns:

the blocking order

setBlockingOrder

public void setBlockingOrder(int order)

getServiceOrder

public String getServiceOrder()

Get the service order for this track. Yards and interchange have this feature for cars. Staging has this feature for trains.

Returns:

Service order: Track.NORMAL, Track.FIFO, Track.LIFO

setServiceOrder

public void setServiceOrder(String order)

Set the service order for this track. Only yards and interchange have this feature.

Parameters:

order - Track.NORMAL, Track.FIFO, Track.LIFO

getScheduleName

public String getScheduleName()

Returns the name of the schedule. Note that this returns the schedule name based on the schedule's id. A schedule's name can be modified by the user.

Returns:

Schedule name

getSchedule

public Schedule getSchedule()

setSchedule

public void setSchedule(Schedule schedule)

getScheduleId

public String getScheduleId()

setScheduleId

public void setScheduleId(String id)

getScheduleItemId

public String getScheduleItemId()

Recommend getCurrentScheduleItem() to get the current schedule item for this track. Protects against user deleting a schedule item from the schedule.

Returns:

schedule item id

setScheduleItemId

public void setScheduleItemId(String id)

getCurrentScheduleItem

public ScheduleItem getCurrentScheduleItem()

Get's the current schedule item for this track Protects against user deleting an item in a shared schedule. Recommend using this versus getScheduleItemId() as the id can be obsolete.

Returns:

The current ScheduleItem.

bumpSchedule

public void bumpSchedule()

Increments the schedule count if there's a schedule and the schedule is running in sequential mode. Resets the schedule count if the maximum is reached and then goes to the next item in the schedule's list.

getNextScheduleItem

public ScheduleItem getNextScheduleItem()

getScheduleCount

public int getScheduleCount()

Returns how many times the current schedule item has been accessed.

Returns:

count

setScheduleCount

public void setScheduleCount(int count)

checkScheduleValid

public String checkScheduleValid()

Check to see if schedule is valid for the track at this location.

Returns:

SCHEDULE_OKAY if schedule okay, otherwise an error message.

checkSchedule

public String checkSchedule(Car car)

Checks to see if car can be placed on this spur using this schedule. Returns OKAY if the schedule can service the car.

Parameters:

car - The Car to be tested.

Returns:

Track.OKAY track.CUSTOM track.SCHEDULE

scheduleNext

public String scheduleNext(Car car)

Check to see if track has schedule and if it does will schedule the next item in the list. Loads the car with the schedule id.

Parameters:

car - The Car to be modified.

Returns:

Track.OKAY or Track.SCHEDULE

checkScheduleAttribute

public boolean checkScheduleAttribute(String attribute,
 String carType,
 Car car)

setLoadSwapEnabled

public void setLoadSwapEnabled(boolean enable)

Enable changing the car generic load state when car arrives at this track.

Parameters:

enable - when true, swap generic car load state

isLoadSwapEnabled

public boolean isLoadSwapEnabled()

setLoadEmptyEnabled

public void setLoadEmptyEnabled(boolean enable)

Enable setting the car generic load state to empty when car arrives at this track.

Parameters:

enable - when true, set generic car load to empty

isLoadEmptyEnabled

public boolean isLoadEmptyEnabled()

setRemoveCustomLoadsEnabled

public void setRemoveCustomLoadsEnabled(boolean enable)

When enabled, remove Scheduled car loads.

Parameters:

enable - when true, remove Scheduled loads from cars

isRemoveCustomLoadsEnabled

public boolean isRemoveCustomLoadsEnabled()

setAddCustomLoadsEnabled

public void setAddCustomLoadsEnabled(boolean enable)

When enabled, add custom car loads if there's a demand.

Parameters:

enable - when true, add custom loads to cars

isAddCustomLoadsEnabled

public boolean isAddCustomLoadsEnabled()

setAddCustomLoadsAnySpurEnabled

public void setAddCustomLoadsAnySpurEnabled(boolean enable)

When enabled, add custom car loads if there's a demand by any spur/industry.

Parameters:

enable - when true, add custom loads to cars

isAddCustomLoadsAnySpurEnabled

public boolean isAddCustomLoadsAnySpurEnabled()

setAddCustomLoadsAnyStagingTrackEnabled

public void setAddCustomLoadsAnyStagingTrackEnabled(boolean enable)

When enabled, add custom car loads to cars in staging for new destinations that are staging.

Parameters:

enable - when true, add custom load to car

isAddCustomLoadsAnyStagingTrackEnabled

public boolean isAddCustomLoadsAnyStagingTrackEnabled()

isModifyLoadsEnabled

public boolean isModifyLoadsEnabled()

setDisableLoadChangeEnabled

public void setDisableLoadChangeEnabled(boolean enable)

isDisableLoadChangeEnabled

public boolean isDisableLoadChangeEnabled()

setQuickServiceEnabled

public void setQuickServiceEnabled(boolean enable)

isQuickServiceEnabled

public boolean isQuickServiceEnabled()

setBlockCarsEnabled

public void setBlockCarsEnabled(boolean enable)

isBlockCarsEnabled

public boolean isBlockCarsEnabled()

When enabled block cars from staging.

Returns:

true if blocking is enabled.

setPool

public void setPool(Pool pool)

getPool

public Pool getPool()

getPoolName

public String getPoolName()

getDestinationListSize

public int getDestinationListSize()

addDestination

public void addDestination(Location destination)

adds a location to the list of acceptable destinations for this track.

Parameters:

destination - location that is acceptable

deleteDestination

public void deleteDestination(Location destination)

isDestinationAccepted

public boolean isDestinationAccepted(Location destination)

Returns true if destination is valid from this track.

Parameters:

destination - The Location to be checked.

Returns:

true if track services the destination

setDestinationIds

public void setDestinationIds(String[] ids)

getDestinationIds

public String[] getDestinationIds()

setDestinationOption

public void setDestinationOption(String option)

Sets the destination option for this track. The three options are:

ALL_DESTINATIONS which means this track services all destinations, the default.

INCLUDE_DESTINATIONS which means this track services only certain destinations.

EXCLUDE_DESTINATIONS which means this track does not service certain destinations.

Parameters:

option - Track.ALL_DESTINATIONS, Track.INCLUDE_DESTINATIONS, or Track.EXCLUDE_DESTINATIONS

getDestinationOption

public String getDestinationOption()

Get destination option for interchange or staging track

Returns:

option

setOnlyCarsWithFinalDestinationEnabled

public void setOnlyCarsWithFinalDestinationEnabled(boolean enable)

isOnlyCarsWithFinalDestinationEnabled

public boolean isOnlyCarsWithFinalDestinationEnabled()

When true the track will only accept cars that have a final destination that can be serviced by the track. See acceptsDestination(Location).

Returns:

false if any car spotted, true if only cars with a FD.

isAlternate

public boolean isAlternate()

Used to determine if track has been assigned as an alternate

Returns:

true if track is an alternate

dispose

public void dispose()

store

public org.jdom2.Element store()

Create an XML element to represent this Entry. This member has to remain synchronized with the detailed DTD in operations-location.dtd.

Returns:

Contents in a JDOM Element

setDirtyAndFirePropertyChange

protected void setDirtyAndFirePropertyChange(String p,
 Object old,
 Object n)

setReporter

public void setReporter(Reporter r)

getReporter

public Reporter getReporter()

getReporterName

public String getReporterName()