Package jmri.jmrit.operations.rollingstock.cars

Class Car

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.rollingstock.RollingStock

jmri.jmrit.operations.rollingstock.cars.Car

All Implemented Interfaces:

PropertyChangeListener, EventListener, Identifiable, PropertyChangeFirer, PropertyChangeProvider

public class Car
extends RollingStock

Represents a car on the layout

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_caboose
protected Location	_finalDestination
protected Track	_finalDestTrack
protected boolean	_fred
protected boolean	_hazardous
protected Kernel	_kernel
protected boolean	_loadGeneratedByStaging
protected String	_loadName
protected String	_nextLoadName
protected boolean	_passenger
protected String	_pickupScheduleId
protected Location	_previousFinalDestination
protected Track	_previousFinalDestTrack
protected String	_previousScheduleId
protected String	_routePath
protected Location	_rweDestination
protected Track	_rweDestTrack
protected String	_rweLoadName
protected Location	_rwlDestination
protected Track	_rwlDestTrack
protected String	_rwlLoadName
protected String	_scheduleId
protected boolean	_utility
protected int	_wait
static final String	CABOOSE_EXTENSION
(package private) CarLoads	carLoads
static final String	CLONE
static final String	CLONE_REGEX
static final String	EXTENSION_REGEX
static final String	FINAL_DESTINATION_CHANGED_PROPERTY
static final String	FINAL_DESTINATION_TRACK_CHANGED_PROPERTY
static final String	FRED_EXTENSION
static final String	HAZARDOUS_EXTENSION
static final String	KERNEL_NAME_CHANGED_PROPERTY
static final String	LOAD_CHANGED_PROPERTY
static final String	PASSENGER_EXTENSION
static final String	RETURN_WHEN_EMPTY_CHANGED_PROPERTY
static final String	RETURN_WHEN_LOADED_CHANGED_PROPERTY
static final String	RWE_LOAD_CHANGED_PROPERTY
static final String	RWL_LOAD_CHANGED_PROPERTY
static final String	SCHEDULE_ID_CHANGED_PROPERTY
static final String	UTILITY_EXTENSION
static final String	WAIT_CHANGED_PROPERTY

Fields inherited from class jmri.jmrit.operations.rollingstock.RollingStock

_blocking, _built, _clone, _cloneOrder, _color, _comment, _destination, _division, _id, _lastDate, _lastLocationId, _lastTrackId, _lastTrain, _length, _lengthChange, _location, _locationUnknown, _moves, _number, _outOfService, _owner, _pickupTime, _rfid, _road, _routeDestination, _routeId, _routeLocation, _selected, _setoutTime, _tag, _tagListener, _track, _trackDestination, _train, _type, _value, _weight, _weightTons, _whenLastSeen, _whereLastSeen, COMMENT_CHANGED_PROPERTY, COUPLERS, DEFAULT_BLOCKING_ORDER, DEFAULT_WEIGHT, DESTINATION_TRACK_CHANGED_PROPERTY, ERROR_TRACK, FORCE, LENGTH_CHANGED_PROPERTY, LOCATION_UNKNOWN, MAX_BLOCKING_ORDER, NONE, number, ROUTE_DESTINATION_CHANGED_PROPERTY, ROUTE_LOCATION_CHANGED_PROPERTY, TRACK_CHANGED_PROPERTY, TRAIN_CHANGED_PROPERTY, TYPE_CHANGED_PROPERTY

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
Car()
Car(String road, String number)
Car(org.jdom2.Element e)	Construct this Entry from XML.

Method Summary

Modifier and Type	Method	Description
String	checkDestination(Location destination, Track track)	Used to determine if a car can be set out at a destination (location).
Car	copy()
void	dispose()	Remove rolling stock.
int	getAdjustedWeightTons()	Returns a car's weight adjusted for load.
String	getDropComment()
Location	getFinalDestination()
String	getFinalDestinationName()
Track	getFinalDestinationTrack()
String	getFinalDestinationTrackName()
Kernel	getKernel()
String	getKernelName()
String	getLoadName()	The load name assigned to this car.
String	getLoadPriority()	Gets the car's load's priority.
String	getLoadType()	Gets the car load's type, empty or load.
String	getNextLoadName()
String	getPickupComment()
String	getPickupScheduleId()
String	getPickupScheduleName()
Location	getPreviousFinalDestination()
String	getPreviousFinalDestinationName()
Track	getPreviousFinalDestinationTrack()
String	getPreviousFinalDestinationTrackName()
String	getPreviousScheduleId()
Location	getReturnWhenEmptyDestination()
String	getReturnWhenEmptyDestinationName()
Track	getReturnWhenEmptyDestTrack()
String	getReturnWhenEmptyDestTrackName()
String	getReturnWhenEmptyLoadName()
Location	getReturnWhenLoadedDestination()
String	getReturnWhenLoadedDestinationName()
Track	getReturnWhenLoadedDestTrack()
String	getReturnWhenLoadedDestTrackName()
String	getReturnWhenLoadedLoadName()
String	getRoutePath()
ScheduleItem	getScheduleItem(Track track)
String	getScheduleItemId()
String	getSplitFinalDestinationName()
String	getSplitFinalDestinationTrackName()
String	getSplitReturnWhenEmptyDestinationName()
String	getSplitReturnWhenEmptyDestinationTrackName()
int	getTotalKernelLength()	Returns the car length or the length of the car's kernel including couplers.
String	getTypeExtensions()
int	getWait()
String	getWeightTons()
boolean	hasFred()	Used to determine if car has FRED (Flashing Rear End Device).
boolean	isCaboose()
boolean	isCarHazardous()
boolean	isCarLoadHazardous()
boolean	isHazardous()	Used to determine if the car is hazardous or the car's load is hazardous.
boolean	isLead()	Used to determine if car is lead car in a kernel
boolean	isLoadGeneratedFromStaging()
boolean	isLocalMove()	Used to determine if car is performing a local move.
boolean	isPassenger()
protected boolean	isRwlEnabled()	Used to determine is car has been given a Return When Loaded (RWL) address or custom load
boolean	isUtility()
void	loadCarFinalDestination(ScheduleItem scheduleItem)	Called when setting a car's destination to this spur.
void	loadNext(Track track)	Called when car is delivered to track.
void	propertyChange(PropertyChangeEvent e)
void	reset()
void	setCaboose(boolean caboose)
void	setCarHazardous(boolean hazardous)
String	setDestination(Location destination, Track track)	Sets the car's destination on the layout
String	setDestination(Location destination, Track track, boolean force)	Sets the car's destination on the layout
protected void	setDirtyAndFirePropertyChange(String p, Object old, Object n)
void	setFinalDestination(Location destination)	Sets the final destination for a car.
void	setFinalDestinationTrack(Track track)
void	setFred(boolean fred)
void	setKernel(Kernel kernel)	A kernel is a group of cars that are switched as a unit.
void	setLoadGeneratedFromStaging(boolean fromStaging)
void	setLoadName(String load)
void	setNextLoadName(String load)	Only here for backwards compatibility before version 5.1.4.
void	setPassenger(boolean passenger)
void	setPickupScheduleId(String id)	Sets when this car will be picked up (day of the week)
void	setPreviousFinalDestination(Location location)
void	setPreviousFinalDestinationTrack(Track track)
void	setPreviousScheduleId(String id)
void	setReturnWhenEmptyDestination(Location destination)
void	setReturnWhenEmptyDestTrack(Track track)
void	setReturnWhenEmptyLoadName(String load)
void	setReturnWhenLoadedDestination(Location destination)
void	setReturnWhenLoadedDestTrack(Track track)
void	setReturnWhenLoadedLoadName(String load)
void	setRoutePath(String routePath)
void	setScheduleItemId(String id)	Used to keep track of which item in a schedule was used for this car.
void	setUtility(boolean utility)
void	setWait(int count)
org.jdom2.Element	store()	Create an XML element to represent this Entry.
void	updateKernel()	Updates all cars in a kernel.
void	updateLoad(Track track)	Updates a car's load when placed at a spur.

Methods inherited from class jmri.jmrit.operations.rollingstock.RollingStock

createId, getBlocking, getBuilt, getCloneOrder, getColor, getComment, getDestination, getDestinationId, getDestinationName, getDestinationTrack, getDestinationTrackId, getDestinationTrackName, getDivision, getDivisionId, getDivisionName, getId, getIdTag, getLastDate, getLastLocationId, getLastLocationName, getLastMoveDate, getLastRouteId, getLastTrackId, getLastTrackName, getLastTrain, getLastTrainName, getLength, getLengthInteger, getLocation, getLocationId, getLocationName, getMoves, getNumber, getOwnerName, getPickupTime, getRfid, getRoadName, getRouteDestination, getRouteDestinationId, getRouteLocation, getRouteLocationId, getSetoutTime, getSortDate, getSplitDestinationName, getSplitDestinationTrackName, getSplitLocationName, getSplitTrackName, getStatus, getTotalLength, getTrack, getTrackId, getTrackLastSeen, getTrackLastSeenName, getTrackName, getTrackType, getTrain, getTrainName, getTypeName, getValue, getWeight, getWhenLastSeen, getWhenLastSeenDate, getWhereLastSeen, getWhereLastSeenName, isClone, isLocationUnknown, isOutOfService, isSelected, moveRollingStock, setBlocking, setBuilt, setClone, setCloneOrder, setColor, setComment, setDestination, setDestinationTrack, setDivision, setIdTag, setLastDate, setLastDate, setLastLocationId, setLastRouteId, setLastTrackId, setLastTrain, setLength, setLocation, setLocation, setLocationUnknown, setMoves, setNumber, setOutOfService, setOwnerName, setPickupTime, setRfid, setRoadName, setRouteDestination, setRouteLocation, setSelected, setSetoutTime, setTrack, setTrain, setTypeName, setValue, setWeight, setWeightTons, store, testLocation, 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

carLoads

CarLoads carLoads

_passenger

protected boolean _passenger

_hazardous

protected boolean _hazardous

_caboose

protected boolean _caboose

_fred

protected boolean _fred

_utility

protected boolean _utility

_loadGeneratedByStaging

protected boolean _loadGeneratedByStaging

_kernel

protected Kernel _kernel

_loadName

protected String _loadName

_wait

protected int _wait

_rweDestination

protected Location _rweDestination

_rweDestTrack

protected Track _rweDestTrack

_rweLoadName

protected String _rweLoadName

_rwlDestination

protected Location _rwlDestination

_rwlDestTrack

protected Track _rwlDestTrack

_rwlLoadName

protected String _rwlLoadName

_scheduleId

protected String _scheduleId

_nextLoadName

protected String _nextLoadName

_finalDestination

protected Location _finalDestination

_finalDestTrack

protected Track _finalDestTrack

_previousFinalDestination

protected Location _previousFinalDestination

_previousFinalDestTrack

protected Track _previousFinalDestTrack

_previousScheduleId

protected String _previousScheduleId

_pickupScheduleId

protected String _pickupScheduleId

_routePath

protected String _routePath

EXTENSION_REGEX

public static final String EXTENSION_REGEX

See Also:

• Constant Field Values

CABOOSE_EXTENSION

public static final String CABOOSE_EXTENSION

FRED_EXTENSION

public static final String FRED_EXTENSION

PASSENGER_EXTENSION

public static final String PASSENGER_EXTENSION

UTILITY_EXTENSION

public static final String UTILITY_EXTENSION

HAZARDOUS_EXTENSION

public static final String HAZARDOUS_EXTENSION

CLONE

public static final String CLONE

See Also:

• Constant Field Values

CLONE_REGEX

public static final String CLONE_REGEX

See Also:

• Constant Field Values

LOAD_CHANGED_PROPERTY

public static final String LOAD_CHANGED_PROPERTY

See Also:

• Constant Field Values

RWE_LOAD_CHANGED_PROPERTY

public static final String RWE_LOAD_CHANGED_PROPERTY

See Also:

• Constant Field Values

RWL_LOAD_CHANGED_PROPERTY

public static final String RWL_LOAD_CHANGED_PROPERTY

See Also:

• Constant Field Values

WAIT_CHANGED_PROPERTY

public static final String WAIT_CHANGED_PROPERTY

See Also:

• Constant Field Values

FINAL_DESTINATION_CHANGED_PROPERTY

public static final String FINAL_DESTINATION_CHANGED_PROPERTY

See Also:

• Constant Field Values

FINAL_DESTINATION_TRACK_CHANGED_PROPERTY

public static final String FINAL_DESTINATION_TRACK_CHANGED_PROPERTY

See Also:

• Constant Field Values

RETURN_WHEN_EMPTY_CHANGED_PROPERTY

public static final String RETURN_WHEN_EMPTY_CHANGED_PROPERTY

See Also:

• Constant Field Values

RETURN_WHEN_LOADED_CHANGED_PROPERTY

public static final String RETURN_WHEN_LOADED_CHANGED_PROPERTY

See Also:

• Constant Field Values

SCHEDULE_ID_CHANGED_PROPERTY

public static final String SCHEDULE_ID_CHANGED_PROPERTY

See Also:

• Constant Field Values

KERNEL_NAME_CHANGED_PROPERTY

public static final String KERNEL_NAME_CHANGED_PROPERTY

See Also:

• Constant Field Values

Constructor Details

Car

public Car()

Car

public Car(String road,
 String number)

Car

public Car(org.jdom2.Element e)

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

Parameters:

e - Car XML element

Method Details

copy

public Car copy()

setCarHazardous

public void setCarHazardous(boolean hazardous)

isCarHazardous

public boolean isCarHazardous()

isCarLoadHazardous

public boolean isCarLoadHazardous()

isHazardous

public boolean isHazardous()

Used to determine if the car is hazardous or the car's load is hazardous.

Returns:

true if the car or car's load is hazardous.

setPassenger

public void setPassenger(boolean passenger)

isPassenger

public boolean isPassenger()

setFred

public void setFred(boolean fred)

hasFred

public boolean hasFred()

Used to determine if car has FRED (Flashing Rear End Device).

Returns:

true if car has FRED.

setLoadName

public void setLoadName(String load)

getLoadName

public String getLoadName()

The load name assigned to this car.

Returns:

The load name assigned to this car.

setReturnWhenEmptyLoadName

public void setReturnWhenEmptyLoadName(String load)

getReturnWhenEmptyLoadName

public String getReturnWhenEmptyLoadName()

setReturnWhenLoadedLoadName

public void setReturnWhenLoadedLoadName(String load)

getReturnWhenLoadedLoadName

public String getReturnWhenLoadedLoadName()

getLoadPriority

public String getLoadPriority()

Gets the car's load's priority.

Returns:

The car's load priority.

getLoadType

public String getLoadType()

Gets the car load's type, empty or load.

Returns:

type empty or type load

getPickupComment

public String getPickupComment()

getDropComment

public String getDropComment()

setLoadGeneratedFromStaging

public void setLoadGeneratedFromStaging(boolean fromStaging)

isLoadGeneratedFromStaging

public boolean isLoadGeneratedFromStaging()

setScheduleItemId

public void setScheduleItemId(String id)

Used to keep track of which item in a schedule was used for this car.

Parameters:

id - The ScheduleItem id for this car.

getScheduleItemId

public String getScheduleItemId()

getScheduleItem

public ScheduleItem getScheduleItem(Track track)

setNextLoadName

public void setNextLoadName(String load)

Only here for backwards compatibility before version 5.1.4. The next load name for this car. Normally set by a schedule.

Parameters:

load - the next load name.

getNextLoadName

public String getNextLoadName()

getWeightTons

public String getWeightTons()

Overrides:

getWeightTons in class RollingStock

getAdjustedWeightTons

public int getAdjustedWeightTons()

Returns a car's weight adjusted for load. An empty car's weight is 1/3 the car's loaded weight.

Overrides:

getAdjustedWeightTons in class RollingStock

setWait

public void setWait(int count)

getWait

public int getWait()

setPickupScheduleId

public void setPickupScheduleId(String id)

Sets when this car will be picked up (day of the week)

Parameters:

id - See TrainSchedule.java

getPickupScheduleId

public String getPickupScheduleId()

getPickupScheduleName

public String getPickupScheduleName()

setFinalDestination

public void setFinalDestination(Location destination)

Sets the final destination for a car.

Parameters:

destination - The final destination for this car.

getFinalDestination

public Location getFinalDestination()

getFinalDestinationName

public String getFinalDestinationName()

getSplitFinalDestinationName

public String getSplitFinalDestinationName()

setFinalDestinationTrack

public void setFinalDestinationTrack(Track track)

getFinalDestinationTrack

public Track getFinalDestinationTrack()

getFinalDestinationTrackName

public String getFinalDestinationTrackName()

getSplitFinalDestinationTrackName

public String getSplitFinalDestinationTrackName()

setPreviousFinalDestination

public void setPreviousFinalDestination(Location location)

getPreviousFinalDestination

public Location getPreviousFinalDestination()

getPreviousFinalDestinationName

public String getPreviousFinalDestinationName()

setPreviousFinalDestinationTrack

public void setPreviousFinalDestinationTrack(Track track)

getPreviousFinalDestinationTrack

public Track getPreviousFinalDestinationTrack()

getPreviousFinalDestinationTrackName

public String getPreviousFinalDestinationTrackName()

setPreviousScheduleId

public void setPreviousScheduleId(String id)

getPreviousScheduleId

public String getPreviousScheduleId()

setReturnWhenEmptyDestination

public void setReturnWhenEmptyDestination(Location destination)

getReturnWhenEmptyDestination

public Location getReturnWhenEmptyDestination()

getReturnWhenEmptyDestinationName

public String getReturnWhenEmptyDestinationName()

getSplitReturnWhenEmptyDestinationName

public String getSplitReturnWhenEmptyDestinationName()

setReturnWhenEmptyDestTrack

public void setReturnWhenEmptyDestTrack(Track track)

getReturnWhenEmptyDestTrack

public Track getReturnWhenEmptyDestTrack()

getReturnWhenEmptyDestTrackName

public String getReturnWhenEmptyDestTrackName()

getSplitReturnWhenEmptyDestinationTrackName

public String getSplitReturnWhenEmptyDestinationTrackName()

setReturnWhenLoadedDestination

public void setReturnWhenLoadedDestination(Location destination)

getReturnWhenLoadedDestination

public Location getReturnWhenLoadedDestination()

getReturnWhenLoadedDestinationName

public String getReturnWhenLoadedDestinationName()

setReturnWhenLoadedDestTrack

public void setReturnWhenLoadedDestTrack(Track track)

getReturnWhenLoadedDestTrack

public Track getReturnWhenLoadedDestTrack()

getReturnWhenLoadedDestTrackName

public String getReturnWhenLoadedDestTrackName()

isRwlEnabled

protected boolean isRwlEnabled()

Used to determine is car has been given a Return When Loaded (RWL) address or custom load

Returns:

true if car has RWL

setRoutePath

public void setRoutePath(String routePath)

getRoutePath

public String getRoutePath()

setCaboose

public void setCaboose(boolean caboose)

isCaboose

public boolean isCaboose()

setUtility

public void setUtility(boolean utility)

isUtility

public boolean isUtility()

isLocalMove

public boolean isLocalMove()

Used to determine if car is performing a local move. A local move is when a car is moved to a different track at the same location.

Returns:

true if local move

setKernel

public void setKernel(Kernel kernel)

A kernel is a group of cars that are switched as a unit.

Parameters:

kernel - The assigned Kernel for this car.

getKernel

public Kernel getKernel()

getKernelName

public String getKernelName()

isLead

public boolean isLead()

Used to determine if car is lead car in a kernel

Returns:

true if lead car in a kernel

updateKernel

public void updateKernel()

Updates all cars in a kernel. After the update, the cars will all have the same final destination, load, and route path.

getTotalKernelLength

public int getTotalKernelLength()

Returns the car length or the length of the car's kernel including couplers.

Returns:

length of car or kernel

checkDestination

public String checkDestination(Location destination,
 Track track)

Used to determine if a car can be set out at a destination (location). Track is optional. In addition to all of the tests that checkDestination performs, spurs with schedules are also checked.

Overrides:

checkDestination in class RollingStock

Parameters:

destination - The Location.

track - The Track at destination.

Returns:

status OKAY, TYPE, ROAD, LENGTH, ERROR_TRACK, CAPACITY, SCHEDULE, CUSTOM

setDestination

public String setDestination(Location destination,
 Track track)

Sets the car's destination on the layout

Overrides:

setDestination in class RollingStock

Parameters:

track - (yard, spur, staging, or interchange track)

destination - The Location.

Returns:

"okay" if successful, "type" if the rolling stock's type isn't acceptable, or "length" if the rolling stock length didn't fit, or Schedule if the destination will not accept the car because the spur has a schedule and the car doesn't meet the schedule requirements. Also changes the car load status when the car reaches its destination.

setDestination

public String setDestination(Location destination,
 Track track,
 boolean force)

Sets the car's destination on the layout

Overrides:

setDestination in class RollingStock

Parameters:

track - (yard, spur, staging, or interchange track)

force - when true ignore track length, type, and road when setting destination

destination - The Location.

Returns:

"okay" if successful, "type" if the rolling stock's type isn't acceptable, or "length" if the rolling stock length didn't fit, or Schedule if the destination will not accept the car because the spur has a schedule and the car doesn't meet the schedule requirements. Also changes the car load status when the car reaches its destination. Removes car if clone.

loadCarFinalDestination

public void loadCarFinalDestination(ScheduleItem scheduleItem)

Called when setting a car's destination to this spur. Loads the car with a final destination which is the ship address for the schedule item.

Parameters:

scheduleItem - The schedule item to be applied this this car

loadNext

public void loadNext(Track track)

Called when car is delivered to track. Updates the car's wait, pickup day, and load if spur. If staging, can swap default loads, force load to default empty, or replace custom loads with the default empty load. Can trigger RWE or RWL.

Parameters:

track - the destination track for this car

updateLoad

public void updateLoad(Track track)

Updates a car's load when placed at a spur. Load change delayed if wait count is greater than zero.

Parameters:

track - The spur the car is sitting on

getTypeExtensions

public String getTypeExtensions()

reset

public void reset()

Overrides:

reset in class RollingStock

dispose

public void dispose()

Description copied from class: RollingStock

Remove rolling stock. Releases all listeners.

Overrides:

dispose in class RollingStock

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-cars.dtd.

Returns:

Contents in a JDOM Element

setDirtyAndFirePropertyChange

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

Overrides:

setDirtyAndFirePropertyChange in class RollingStock

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

Overrides:

propertyChange in class RollingStock