Package jmri.jmrit.operations.rollingstock

Class RollingStock

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.rollingstock.RollingStock

All Implemented Interfaces:

PropertyChangeListener, EventListener, Identifiable, PropertyChangeFirer, PropertyChangeProvider

Direct Known Subclasses:

Car, Engine

public abstract class RollingStock
extends PropertyChangeSupport
implements Identifiable, PropertyChangeListener

Represents rolling stock, both powered (locomotives) and not powered (cars) on the layout.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_blocking
protected String	_built
protected boolean	_clone
protected int	_cloneOrder
protected String	_color
protected String	_comment
protected Location	_destination
protected Division	_division
protected String	_id
protected Date	_lastDate
protected String	_lastLocationId
protected String	_lastTrackId
protected Train	_lastTrain
protected String	_length
protected boolean	_lengthChange
protected Location	_location
protected boolean	_locationUnknown
protected int	_moves
protected String	_number
protected boolean	_outOfService
protected String	_owner
protected String	_pickupTime
protected String	_rfid
protected String	_road
protected RouteLocation	_routeDestination
protected String	_routeId
protected RouteLocation	_routeLocation
protected boolean	_selected
protected String	_setoutTime
protected IdTag	_tag
protected PropertyChangeListener	_tagListener
protected Track	_track
protected Track	_trackDestination
protected Train	_train
protected String	_type
protected String	_value
protected String	_weight
protected String	_weightTons
protected Date	_whenLastSeen
protected Location	_whereLastSeen
static final String	COMMENT_CHANGED_PROPERTY
static final int	COUPLERS
static final int	DEFAULT_BLOCKING_ORDER
protected static final String	DEFAULT_WEIGHT
static final String	DESTINATION_TRACK_CHANGED_PROPERTY
static final String	ERROR_TRACK
static final boolean	FORCE
static final String	LENGTH_CHANGED_PROPERTY
static final String	LOCATION_UNKNOWN
(package private) LocationManager	locationManager
static final int	MAX_BLOCKING_ORDER
static final String	NONE
protected int	number
static final String	ROUTE_DESTINATION_CHANGED_PROPERTY
static final String	ROUTE_LOCATION_CHANGED_PROPERTY
static final String	TRACK_CHANGED_PROPERTY
static final String	TRAIN_CHANGED_PROPERTY
static final String	TYPE_CHANGED_PROPERTY

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	checkDestination(Location destination, Track track)	Used to check destination track to see if it will accept rolling stock
static String	createId(String road, String number)
void	dispose()	Remove rolling stock.
int	getAdjustedWeightTons()
int	getBlocking()
String	getBuilt()
int	getCloneOrder()
String	getColor()
String	getComment()
Location	getDestination()
String	getDestinationId()
String	getDestinationName()
Track	getDestinationTrack()
String	getDestinationTrackId()
String	getDestinationTrackName()
Division	getDivision()
String	getDivisionId()
String	getDivisionName()
String	getId()	Get the identity of the object.
IdTag	getIdTag()
String	getLastDate()	Provides the last date when this rolling stock was moved
String	getLastLocationId()
String	getLastLocationName()
Date	getLastMoveDate()	Provides the last date when this rolling stock was moved
String	getLastRouteId()	Used to determine which train delivered a car to an interchange track.
String	getLastTrackId()
String	getLastTrackName()
Train	getLastTrain()
String	getLastTrainName()
String	getLength()	gets the body length of the rolling stock
int	getLengthInteger()
Location	getLocation()
String	getLocationId()	Get rolling stock's location id
String	getLocationName()	Get rolling stock's location name
int	getMoves()
String	getNumber()
String	getOwnerName()
String	getPickupTime()
String	getRfid()
String	getRoadName()
RouteLocation	getRouteDestination()
String	getRouteDestinationId()
RouteLocation	getRouteLocation()	Where in a train's route this car resides
String	getRouteLocationId()
String	getSetoutTime()
String	getSortDate()	Provides the last date when this rolling stock was moved
String	getSplitDestinationName()
String	getSplitDestinationTrackName()
String	getSplitLocationName()
String	getSplitTrackName()
String	getStatus()
int	getTotalLength()	Returns the length of the rolling stock including the couplers
Track	getTrack()
String	getTrackId()	Get rolling stock's track id
Track	getTrackLastSeen()
String	getTrackLastSeenName()
String	getTrackName()	Get rolling stock's track name
String	getTrackType()
Train	getTrain()
String	getTrainName()
String	getTypeName()
String	getValue()
String	getWeight()
String	getWeightTons()
Date	getWhenLastSeen()
String	getWhenLastSeenDate()	Provides the last date when this rolling stock was moved, or was reset from a built train, as a string.
Location	getWhereLastSeen()
String	getWhereLastSeenName()
boolean	isClone()
boolean	isLocationUnknown()
boolean	isOutOfService()
boolean	isSelected()
protected void	moveRollingStock(RouteLocation current, RouteLocation next)
void	propertyChange(PropertyChangeEvent e)
void	reset()
void	setBlocking(int number)
void	setBuilt(String built)	Set the date that the rolling stock was built.
void	setClone(boolean clone)
void	setCloneOrder(int number)
void	setColor(String color)
void	setComment(String comment)
void	setDestination(Location destination)	Sets rolling stock destination without reserving destination track space or drop count.
String	setDestination(Location destination, Track track)	Sets rolling stock destination on the layout
String	setDestination(Location destination, Track track, boolean force)	Sets rolling stock destination on the layout
void	setDestinationTrack(Track track)	Sets rolling stock destination track without reserving destination track space or drop count.
protected void	setDirtyAndFirePropertyChange(String p, Object old, Object n)
void	setDivision(Division division)
void	setIdTag(IdTag tag)	Sets the id tag for this rolling stock.
void	setLastDate(String date)	Sets the last date when this rolling stock was moved.
void	setLastDate(Date date)	Sets the last date when this rolling stock was moved
void	setLastLocationId(String id)	Used to block cars from staging
void	setLastRouteId(String id)	Sets the id of the route that was used to set out the rolling stock.
void	setLastTrackId(String id)
void	setLastTrain(Train train)	Sets the last train that serviced this rolling stock.
void	setLength(String length)	Sets the body length of the rolling stock.
String	setLocation(Location location, Track track)	Sets rolling stock location on the layout
String	setLocation(Location location, Track track, boolean force)	Sets rolling stock location on the layout
void	setLocationUnknown(boolean unknown)	Set the rolling stock location as unknown.
void	setMoves(int moves)
void	setNumber(String number)	Set the rolling stock identification or road number
void	setOutOfService(boolean outOfService)	Sets the rolling stock service state.
void	setOwnerName(String owner)
void	setPickupTime(String time)
void	setRfid(String id)	Sets the RFID for this rolling stock.
void	setRoadName(String road)
void	setRouteDestination(RouteLocation routeDestination)	Set where in a train's route this rolling stock will be set out.
void	setRouteLocation(RouteLocation routeLocation)	Sets the location where the rolling stock will be picked up by the train.
void	setSelected(boolean selected)
void	setSetoutTime(String time)
void	setTrack(Track track)	Set the rolling stock's location and track.
void	setTrain(Train train)	Sets the train that will service this rolling stock.
void	setTypeName(String type)	Sets the type of rolling stock.
void	setValue(String value)	Sets the value (cost, price) for this rolling stock.
void	setWeight(String weight)
void	setWeightTons(String weight)	Sets the full scale weight in tons.
protected org.jdom2.Element	store(org.jdom2.Element e)	Add XML elements to represent this Entry.
String	testLocation(Location location, Track track)	Used to confirm that a track is associated with a location, and that rolling stock can be placed on track.
String	toString()	For combobox and identification

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

DEFAULT_BLOCKING_ORDER

public static final int DEFAULT_BLOCKING_ORDER

See Also:

• Constant Field Values

MAX_BLOCKING_ORDER

public static final int MAX_BLOCKING_ORDER

See Also:

• Constant Field Values

FORCE

public static final boolean FORCE

See Also:

• Constant Field Values

DEFAULT_WEIGHT

protected static final String DEFAULT_WEIGHT

See Also:

• Constant Field Values

_id

protected String _id

_number

protected String _number

_road

protected String _road

_type

protected String _type

_length

protected String _length

_color

protected String _color

_weight

protected String _weight

_weightTons

protected String _weightTons

_built

protected String _built

_owner

protected String _owner

_comment

protected String _comment

_routeId

protected String _routeId

_rfid

protected String _rfid

_value

protected String _value

_lastDate

protected Date _lastDate

_locationUnknown

protected boolean _locationUnknown

_outOfService

protected boolean _outOfService

_selected

protected boolean _selected

_location

protected Location _location

_track

protected Track _track

_destination

protected Location _destination

_trackDestination

protected Track _trackDestination

_train

protected Train _train

_routeLocation

protected RouteLocation _routeLocation

_routeDestination

protected RouteLocation _routeDestination

_division

protected Division _division

_clone

protected boolean _clone

_cloneOrder

protected int _cloneOrder

_moves

protected int _moves

_lastLocationId

protected String _lastLocationId

_lastTrackId

protected String _lastTrackId

_lastTrain

protected Train _lastTrain

_blocking

protected int _blocking

_pickupTime

protected String _pickupTime

_setoutTime

protected String _setoutTime

_tag

protected IdTag _tag

_tagListener

protected PropertyChangeListener _tagListener

_whereLastSeen

protected Location _whereLastSeen

_whenLastSeen

protected Date _whenLastSeen

LOCATION_UNKNOWN

public static final String LOCATION_UNKNOWN

See Also:

• Constant Field Values

number

protected int number

ERROR_TRACK

public static final String ERROR_TRACK

See Also:

• Constant Field Values

TRACK_CHANGED_PROPERTY

public static final String TRACK_CHANGED_PROPERTY

See Also:

• Constant Field Values

DESTINATION_TRACK_CHANGED_PROPERTY

public static final String DESTINATION_TRACK_CHANGED_PROPERTY

See Also:

• Constant Field Values

TRAIN_CHANGED_PROPERTY

public static final String TRAIN_CHANGED_PROPERTY

See Also:

• Constant Field Values

LENGTH_CHANGED_PROPERTY

public static final String LENGTH_CHANGED_PROPERTY

See Also:

• Constant Field Values

TYPE_CHANGED_PROPERTY

public static final String TYPE_CHANGED_PROPERTY

See Also:

• Constant Field Values

ROUTE_LOCATION_CHANGED_PROPERTY

public static final String ROUTE_LOCATION_CHANGED_PROPERTY

See Also:

• Constant Field Values

ROUTE_DESTINATION_CHANGED_PROPERTY

public static final String ROUTE_DESTINATION_CHANGED_PROPERTY

See Also:

• Constant Field Values

COMMENT_CHANGED_PROPERTY

public static final String COMMENT_CHANGED_PROPERTY

See Also:

• Constant Field Values

COUPLERS

public static final int COUPLERS

locationManager

LocationManager locationManager

_lengthChange

protected boolean _lengthChange

Constructor Details

RollingStock

public RollingStock()

RollingStock

public RollingStock(String road,
 String number)

RollingStock

public RollingStock(org.jdom2.Element e)

Construct this Entry from XML.

Parameters:

e - RollingStock XML element

Method Details

createId

public static String createId(String road,
 String number)

getId

public String getId()

Description copied from interface: Identifiable

Get the identity of the object.

Specified by:

getId in interface Identifiable

Returns:

the identity

setNumber

public void setNumber(String number)

Set the rolling stock identification or road number

Parameters:

number - The rolling stock road number.

getNumber

public String getNumber()

setRoadName

public void setRoadName(String road)

getRoadName

public String getRoadName()

toString

public String toString()

For combobox and identification

Overrides:

toString in class Object

setTypeName

public void setTypeName(String type)

Sets the type of rolling stock. "Boxcar" for example is a type of car.

Parameters:

type - The type of rolling stock.

getTypeName

public String getTypeName()

setLength

public void setLength(String length)

Sets the body length of the rolling stock. For example, a 40' boxcar would be entered as 40 feet. Coupler length is added by the program when determining if a car could fit on a track.

Parameters:

length - the body length in feet or meters

See Also:

• getTotalLength()

getLength

public String getLength()

gets the body length of the rolling stock

Returns:

length in feet or meters

See Also:

• getTotalLength()

getLengthInteger

public int getLengthInteger()

getTotalLength

public int getTotalLength()

Returns the length of the rolling stock including the couplers

Returns:

total length of the rolling stock in feet or meters

setColor

public void setColor(String color)

getColor

public String getColor()

setWeight

public void setWeight(String weight)

Parameters:

weight - rolling stock weight in ounces.

getWeight

public String getWeight()

setWeightTons

public void setWeightTons(String weight)

Sets the full scale weight in tons.

Parameters:

weight - full scale rolling stock weight in tons.

getWeightTons

public String getWeightTons()

getAdjustedWeightTons

public int getAdjustedWeightTons()

setBuilt

public void setBuilt(String built)

Set the date that the rolling stock was built. Use 4 digits for the year, or the format MM-YY where MM is the two digit month, and YY is the last two years if the rolling stock was built in the 1900s. Use MM-YYYY for units build after 1999.

Parameters:

built - The string built date.

getBuilt

public String getBuilt()

getStatus

public String getStatus()

Returns:

location unknown symbol, out of service symbol, or none if car okay

getLocation

public Location getLocation()

getLocationName

public String getLocationName()

Get rolling stock's location name

Returns:

empty string if rolling stock isn't on layout

getSplitLocationName

public String getSplitLocationName()

getLocationId

public String getLocationId()

Get rolling stock's location id

Returns:

empty string if rolling stock isn't on the layout

getTrack

public Track getTrack()

setTrack

public void setTrack(Track track)

Set the rolling stock's location and track. Doesn't do any checking and does not fire a property change. Used exclusively by the Router code. Use setLocation(Location, Track) instead.

Parameters:

track - to place the rolling stock on.

getTrackName

public String getTrackName()

Get rolling stock's track name

Returns:

empty string if rolling stock isn't on a track

getSplitTrackName

public String getSplitTrackName()

getTrackType

public String getTrackType()

getTrackId

public String getTrackId()

Get rolling stock's track id

Returns:

empty string if rolling stock isn't on a track

setLocation

public String setLocation(Location location,
 Track track)

Sets rolling stock location on the layout

Parameters:

location - The Location.

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

Returns:

"okay" if successful, "type" if the rolling stock's type isn't acceptable, "road" if rolling stock road isn't acceptable, or "length" if the rolling stock length didn't fit.

setLocation

public String setLocation(Location location,
 Track track,
 boolean force)

Sets rolling stock location on the layout

Parameters:

location - The Location.

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

force - when true place rolling stock ignore track length, type, and road

Returns:

"okay" if successful, "type" if the rolling stock's type isn't acceptable, "road" if rolling stock road isn't acceptable, or "length" if the rolling stock length didn't fit.

testLocation

public String testLocation(Location location,
 Track track)

Used to confirm that a track is associated with a location, and that rolling stock can be placed on track.

Parameters:

location - The location

track - The track, can be null

Returns:

OKAY if track exists at location and rolling stock can be placed on track, ERROR_TRACK if track isn't at location, other if rolling stock can't be placed on track.

setDestination

public String setDestination(Location destination,
 Track track)

Sets rolling stock destination on the layout

Parameters:

destination - The Location.

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

Returns:

"okay" if successful, "type" if the rolling stock's type isn't acceptable, or "length" if the rolling stock length didn't fit.

setDestination

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

Sets rolling stock destination on the layout

Parameters:

destination - The Location.

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

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

Returns:

"okay" if successful, "type" if the rolling stock's type isn't acceptable, or "length" if the rolling stock length didn't fit.

checkDestination

public String checkDestination(Location destination,
 Track track)

Used to check destination track to see if it will accept rolling stock

Parameters:

destination - The Location.

track - The Track at destination.

Returns:

status OKAY, TYPE, ROAD, LENGTH, ERROR_TRACK

getDestination

public Location getDestination()

setDestination

public void setDestination(Location destination)

Sets rolling stock destination without reserving destination track space or drop count. Does not fire a property change. Used by car router to test destinations. Use setDestination(Location, Track) instead.

Parameters:

destination - for the rolling stock

getDestinationName

public String getDestinationName()

getSplitDestinationName

public String getSplitDestinationName()

getDestinationId

public String getDestinationId()

setDestinationTrack

public void setDestinationTrack(Track track)

Sets rolling stock destination track without reserving destination track space or drop count. Used by car router to test destinations. Does not fire a property change. Use setDestination(Location, Track) instead.

Parameters:

track - The Track for set out at destination.

getDestinationTrack

public Track getDestinationTrack()

getDestinationTrackName

public String getDestinationTrackName()

getSplitDestinationTrackName

public String getSplitDestinationTrackName()

getDestinationTrackId

public String getDestinationTrackId()

setClone

public void setClone(boolean clone)

isClone

public boolean isClone()

setCloneOrder

public void setCloneOrder(int number)

getCloneOrder

public int getCloneOrder()

setDivision

public void setDivision(Division division)

getDivision

public Division getDivision()

getDivisionName

public String getDivisionName()

getDivisionId

public String getDivisionId()

setLastLocationId

public void setLastLocationId(String id)

Used to block cars from staging

Parameters:

id - The location id from where the car came from before going into staging.

getLastLocationId

public String getLastLocationId()

getLastLocationName

public String getLastLocationName()

setLastTrackId

public void setLastTrackId(String id)

getLastTrackId

public String getLastTrackId()

getLastTrackName

public String getLastTrackName()

setMoves

public void setMoves(int moves)

getMoves

public int getMoves()

setTrain

public void setTrain(Train train)

Sets the train that will service this rolling stock.

Parameters:

train - The Train.

getTrain

public Train getTrain()

getTrainName

public String getTrainName()

setLastTrain

public void setLastTrain(Train train)

Sets the last train that serviced this rolling stock.

Parameters:

train - The last Train.

getLastTrain

public Train getLastTrain()

getLastTrainName

public String getLastTrainName()

setRouteLocation

public void setRouteLocation(RouteLocation routeLocation)

Sets the location where the rolling stock will be picked up by the train.

Parameters:

routeLocation - the pick up location for this rolling stock.

getRouteLocation

public RouteLocation getRouteLocation()

Where in a train's route this car resides

Returns:

the location in a train's route

getRouteLocationId

public String getRouteLocationId()

getLastRouteId

public String getLastRouteId()

Used to determine which train delivered a car to an interchange track.

Returns:

the route id of the last train delivering this car.

setLastRouteId

public void setLastRouteId(String id)

Sets the id of the route that was used to set out the rolling stock. Used to determine if the rolling stock can be pick ups from an interchange track.

Parameters:

id - The route id.

getValue

public String getValue()

setValue

public void setValue(String value)

Sets the value (cost, price) for this rolling stock. Currently has nothing to do with operations. But nice to have.

Parameters:

value - a string representing what this item is worth.

getRfid

public String getRfid()

setRfid

public void setRfid(String id)

Sets the RFID for this rolling stock.

Parameters:

id - 12 character RFID string.

getIdTag

public IdTag getIdTag()

setIdTag

public void setIdTag(IdTag tag)

Sets the id tag for this rolling stock. The id tag isn't saved, between session but the tag label is saved as _rfid.

Parameters:

tag - the id tag

getWhereLastSeenName

public String getWhereLastSeenName()

getWhereLastSeen

public Location getWhereLastSeen()

getTrackLastSeen

public Track getTrackLastSeen()

getTrackLastSeenName

public String getTrackLastSeenName()

getWhenLastSeen

public Date getWhenLastSeen()

getWhenLastSeenDate

public String getWhenLastSeenDate()

Provides the last date when this rolling stock was moved, or was reset from a built train, as a string.

Returns:

date

getSortDate

public String getSortDate()

Provides the last date when this rolling stock was moved

Returns:

String yyyy/MM/dd HH:mm:ss

getLastDate

public String getLastDate()

Provides the last date when this rolling stock was moved

Returns:

String MM/dd/yyyy HH:mm:ss

setLastDate

public void setLastDate(Date date)

Sets the last date when this rolling stock was moved

Parameters:

date - The Date when this rolling stock was last moved.

getLastMoveDate

public Date getLastMoveDate()

Provides the last date when this rolling stock was moved

Returns:

date

setLastDate

public void setLastDate(String date)

Sets the last date when this rolling stock was moved. This method is used only for loading data from a file. Use setLastDate(Date) instead.

Parameters:

date - yyyy/MM/dd HH:mm:ss, MM/dd/yyyy HH:mm:ss, MM/dd/yyyy hh:mmaa, or MM/dd/yyyy HH:mm

setBlocking

public void setBlocking(int number)

getBlocking

public int getBlocking()

setRouteDestination

public void setRouteDestination(RouteLocation routeDestination)

Set where in a train's route this rolling stock will be set out.

Parameters:

routeDestination - the location where the rolling stock is to leave the train.

getRouteDestination

public RouteLocation getRouteDestination()

getRouteDestinationId

public String getRouteDestinationId()

setOwnerName

public void setOwnerName(String owner)

getOwnerName

public String getOwnerName()

setLocationUnknown

public void setLocationUnknown(boolean unknown)

Set the rolling stock location as unknown.

Parameters:

unknown - when true, the rolling stock location is unknown.

isLocationUnknown

public boolean isLocationUnknown()

Returns:

true when car's location is unknown

setOutOfService

public void setOutOfService(boolean outOfService)

Sets the rolling stock service state. When true, rolling stock is out of service. Normal state is false, the rolling stock is in service and available.

Parameters:

outOfService - when true, out of service

isOutOfService

public boolean isOutOfService()

Returns:

true when rolling stock is out of service

setSelected

public void setSelected(boolean selected)

isSelected

public boolean isSelected()

Returns:

true when rolling stock is selected

setComment

public void setComment(String comment)

getComment

public String getComment()

setPickupTime

public void setPickupTime(String time)

getPickupTime

public String getPickupTime()

setSetoutTime

public void setSetoutTime(String time)

getSetoutTime

public String getSetoutTime()

moveRollingStock

protected void moveRollingStock(RouteLocation current,
 RouteLocation next)

reset

public void reset()

dispose

public void dispose()

Remove rolling stock. Releases all listeners.

store

protected org.jdom2.Element store(org.jdom2.Element e)

Add XML elements to represent this Entry.

Parameters:

e - Element for car or engine store.

Returns:

Contents in a JDOM Element

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

setDirtyAndFirePropertyChange

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