Package jmri.jmrit.ctc.ctcserialdata

Class TrafficLockingData

java.lang.Object

jmri.jmrit.ctc.ctcserialdata.TrafficLockingData

public class TrafficLockingData
extends Object

This describes one traffic locking rule.

The TRLSwitch sub-class contains switch, alignment and ID values.

The list of traffic locking rules for each OS section are in the _mTRL_LeftTrafficLockingRules and _mTRL_RightTrafficLockingRuless variable in CodeButtonHandlerData.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrafficLockingData.TRLSwitch

Field Summary

Fields

Modifier and Type	Field	Description
String	_mDestinationSignalOrComment
List<NBHSensor>	_mOccupancyExternalSensors
List<NBHSensor>	_mOptionalExternalSensors
String	_mRuleEnabled
List<TrafficLockingData.TRLSwitch>	_mSwitchAlignments
String	_mUserRuleNumber

Constructor Summary

Constructors

Constructor	Description
TrafficLockingData()
TrafficLockingData(int ruleNumber, String destinationSignalMast, TopologyInfo topologyInfo)	Constructor to take a TopologyInfo entry and create a properly formed "this".

Method Summary

Modifier and Type	Method	Description
ArrayList<String>	getAlignments()	Create a list of alignments with 5 entries.
ArrayList<NBHSensor>	getOccupancySensors()	Create a list of occupancy sensors with 9 entries.
ArrayList<NBHSensor>	getOptionalSensors()	Create a list of optional sensors with 2 entries.
ArrayList<Integer>	getUniqueIDs()	Create a list of unique ids with 5 entries.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_mUserRuleNumber

public String _mUserRuleNumber

_mRuleEnabled

public String _mRuleEnabled

_mDestinationSignalOrComment

public String _mDestinationSignalOrComment

_mSwitchAlignments

public List<TrafficLockingData.TRLSwitch> _mSwitchAlignments

_mOccupancyExternalSensors

public List<NBHSensor> _mOccupancyExternalSensors

_mOptionalExternalSensors

public List<NBHSensor> _mOptionalExternalSensors

Constructor Details

TrafficLockingData

public TrafficLockingData()

TrafficLockingData

public TrafficLockingData(int ruleNumber,
 String destinationSignalMast,
 TopologyInfo topologyInfo)

Constructor to take a TopologyInfo entry and create a properly formed "this".

Parameters:

ruleNumber - Rule # (just an integer, starting with 1)

destinationSignalMast - String representation of the destination signal mast so user can see on the form.

topologyInfo - Source of data.

Method Details

getOccupancySensors

public ArrayList<NBHSensor> getOccupancySensors()

Create a list of occupancy sensors with 9 entries. Unused entries will be set to a dummy NBHSensor.

Returns:

a list of occupancy sensors.

getOptionalSensors

public ArrayList<NBHSensor> getOptionalSensors()

Create a list of optional sensors with 2 entries. Unused entries will be set to a dummy NBHSensor.

Returns:

a list of optional sensors.

getUniqueIDs

public ArrayList<Integer> getUniqueIDs()

Create a list of unique ids with 5 entries. Unused entries are set to -1.

Returns:

a list of ids

getAlignments

public ArrayList<String> getAlignments()

Create a list of alignments with 5 entries. Unused entries are to to Normal.

Returns:

a list of alignments

toString

public String toString()

Overrides:

toString in class Object