Package jmri.jmrit.operations.trains.schedules

Class TrainSchedule

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.trains.schedules.TrainSchedule

All Implemented Interfaces:

PropertyChangeFirer, PropertyChangeProvider

public class TrainSchedule
extends PropertyChangeSupport

Represents a schedule for trains. For example, can be a day of the week. Useful when determining which trains to build and run.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_comment
protected String	_id
protected String	_name
protected List<String>	_trainIds
static final String	ANY
static final String	NAME_CHANGED_PROPERTY
static final String	NONE
static final String	SCHEDULE_CHANGED_PROPERTY

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
TrainSchedule(String id, String name)
TrainSchedule(org.jdom2.Element e)	Construct this Entry from XML.

Method Summary

Modifier and Type	Method	Description
void	addTrainId(String id)	Adds the train id for a train that needs to be built
boolean	containsTrainId(String id)	Used to determine if train is to be built using this schedule
String	getComment()
String	getId()
String	getName()
void	propertyChange(PropertyChangeEvent e)
void	removeTrainId(String id)	Removes the train id for a train that needs to be built
void	setComment(String comment)
protected void	setDirtyAndFirePropertyChange(String p, Object old, Object n)
void	setName(String name)
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

ANY

public static final String ANY

See Also:

• Constant Field Values

NAME_CHANGED_PROPERTY

public static final String NAME_CHANGED_PROPERTY

See Also:

• Constant Field Values

SCHEDULE_CHANGED_PROPERTY

public static final String SCHEDULE_CHANGED_PROPERTY

See Also:

• Constant Field Values

_id

protected String _id

_name

protected String _name

_comment

protected String _comment

_trainIds

protected List<String> _trainIds

Constructor Details

TrainSchedule

public TrainSchedule(String id,
 String name)

TrainSchedule

public TrainSchedule(org.jdom2.Element e)

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

Parameters:

e - Consist XML element

Method Details

getId

public String getId()

setName

public void setName(String name)

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

setComment

public void setComment(String comment)

getComment

public String getComment()

addTrainId

public void addTrainId(String id)

Adds the train id for a train that needs to be built

Parameters:

id - The train id

removeTrainId

public void removeTrainId(String id)

Removes the train id for a train that needs to be built

Parameters:

id - The train id

containsTrainId

public boolean containsTrainId(String id)

Used to determine if train is to be built using this schedule

Parameters:

id - the id of the train to be tested

Returns:

true if this train's build enable should be set

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-config.xml.

Returns:

Contents in a JDOM Element

propertyChange

public void propertyChange(PropertyChangeEvent e)

setDirtyAndFirePropertyChange

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