Package jmri.jmrit.display.layoutEditor

Class LevelXing

java.lang.Object

jmri.jmrit.display.layoutEditor.LayoutTrack

jmri.jmrit.display.layoutEditor.LevelXing

public class LevelXing
extends LayoutTrack

A LevelXing is two track segment on a layout that cross at an angle.

A LevelXing has four connection points, designated A, B, C, and D. At the crossing, A-C and B-D are straight segments. A train proceeds through the crossing on either of these segments.

    A   D
    \\ //
      X
    // \\
    B   C
 

Each straight segment carries Block information. A-C and B-D may be in the same or different Layout Blocks.

For drawing purposes, each LevelXing carries a center point and displacements for A and B. The displacements for C = - the displacement for A, and the displacement for D = - the displacement for B. The center point and these displacements may be adjusted by the user when in edit mode.

When LevelXings are first created, there are no connections. Block information and connections are added when available.

Signal Head names are saved here to keep track of where signals are. LevelXing only serves as a storage place for signal head names. The names are placed here by Set Signals at Level Crossing in Tools menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LevelXing.Geometry

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	active
String	connectAName
String	connectBName
String	connectCName
String	connectDName
protected NamedBeanHandle<SignalHead>	signalAHeadNamed
protected NamedBeanHandle<SignalMast>	signalAMastNamed
protected NamedBeanHandle<SignalHead>	signalBHeadNamed
protected NamedBeanHandle<SignalMast>	signalBMastNamed
protected NamedBeanHandle<SignalHead>	signalCHeadNamed
protected NamedBeanHandle<SignalMast>	signalCMastNamed
protected NamedBeanHandle<SignalHead>	signalDHeadNamed
protected NamedBeanHandle<SignalMast>	signalDMastNamed
(package private) ArrayList<SignalMast>	sml
String	tLayoutBlockNameAC
String	tLayoutBlockNameBD

Fields inherited from class jmri.jmrit.display.layoutEditor.LayoutTrack

models

Constructor Summary

Constructors

Constructor	Description
LevelXing(String id, LayoutEditor models)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addSignalMastLogic(SignalMast sm)
boolean	canRemove()	Check for active block boundaries.
List<HitPointType>	checkForFreeConnections()	return a list of the available connections for this layout track
void	checkForNonContiguousBlocks(HashMap<String,List<Set<String>>> blockNamesToTrackNameSetsMap)	check this track and its neighbors for non-contiguous blocks
boolean	checkForUnAssignedBlocks()	determine if all the appropriate blocks have been assigned to this track
void	collectContiguousTracksNamesInBlockNamed(String blockName, Set<String> TrackNameSet)	recursive routine to check for all contiguous tracks in this blockName
ArrayList<String>	getBeanReferences(String pointName)	Build a list of sensors, signal heads, and signal masts attached to a level crossing point.
String[]	getBlockBoundaries()
String	getBlockNameAC()
String	getBlockNameBD()
LayoutTrack	getConnectA()
LayoutTrack	getConnectB()
LayoutTrack	getConnectC()
LayoutTrack	getConnectD()
LayoutTrack	getConnection(HitPointType connectionType)	get the LayoutTrack connected at the specified connection type
LayoutBlock	getLayoutBlockAC()
LayoutBlock	getLayoutBlockBD()
protected ArrayList<LayoutConnectivity>	getLayoutConnectivity()	get the layout connectivity for this track
Sensor	getSensor(LevelXing.Geometry loc)
Sensor	getSensorA()
String	getSensorAName()
Sensor	getSensorB()
String	getSensorBName()
Sensor	getSensorC()
String	getSensorCName()
Sensor	getSensorD()
String	getSensorDName()
SignalMast	getSignalAMast()
String	getSignalAMastName()
String	getSignalAName()
SignalMast	getSignalBMast()
String	getSignalBMastName()
String	getSignalBName()
SignalMast	getSignalCMast()
String	getSignalCMastName()
String	getSignalCName()
SignalMast	getSignalDMast()
String	getSignalDMastName()
String	getSignalDName()
SignalHead	getSignalHead(LevelXing.Geometry loc)
SignalMast	getSignalMast(LevelXing.Geometry loc)
String	getTypeName()	Get the type of this item.
boolean	isActive()	Get if active.
boolean	isMainline()
boolean	isMainlineAC()	Test if mainline track or not.
boolean	isMainlineBD()
void	reCheckBlockBoundary()	abstract method... subclasses should implement _IF_ they need to recheck their block boundaries
void	remove()	Remove this object from display and persistance.
void	removeBeanReference(NamedBean nb)
void	removeSignalMastLogic(SignalMast sm)
(package private) void	removeSML(SignalMast signalMast)
void	setAllLayoutBlocks(LayoutBlock layoutBlock)	Assign all the layout blocks in this track
void	setConnectA(LayoutTrack o, HitPointType type)
void	setConnectB(LayoutTrack o, HitPointType type)
void	setConnectC(LayoutTrack o, HitPointType type)
void	setConnectD(LayoutTrack o, HitPointType type)
void	setConnection(HitPointType connectionType, LayoutTrack o, HitPointType type)	set the LayoutTrack connected at the specified connection type
void	setLayoutBlockAC(LayoutBlock newLayoutBlock)	Add Layout Blocks.
void	setLayoutBlockBD(LayoutBlock newLayoutBlock)
void	setObjects(LayoutEditor p)	Initialization method The above variables are initialized by PositionablePointXml, then the following method is called after the entire LayoutEditor is loaded to set the specific TrackSegment objects.
void	setSensorAName(String sensorName)
void	setSensorBName(String sensorName)
void	setSensorCName(String sensorName)
void	setSensorDName(String sensorName)
void	setSignalAMast(String signalMast)
void	setSignalAName(String signalHead)
void	setSignalBMast(String signalMast)
void	setSignalBName(String signalHead)
void	setSignalCMast(String signalMast)
void	setSignalCName(String signalHead)
void	setSignalDMast(String signalMast)
void	setSignalDName(String signalHead)
String	toString()
void	updateBlockInfo()

Methods inherited from class jmri.jmrit.display.layoutEditor.LayoutTrack

getId, getName, getTurnoutStateString, isDisconnected, setIdent

Methods inherited from class java.lang.Object

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

Field Details

signalAHeadNamed

protected NamedBeanHandle<SignalHead> signalAHeadNamed

signalBHeadNamed

protected NamedBeanHandle<SignalHead> signalBHeadNamed

signalCHeadNamed

protected NamedBeanHandle<SignalHead> signalCHeadNamed

signalDHeadNamed

protected NamedBeanHandle<SignalHead> signalDHeadNamed

signalAMastNamed

protected NamedBeanHandle<SignalMast> signalAMastNamed

signalBMastNamed

protected NamedBeanHandle<SignalMast> signalBMastNamed

signalCMastNamed

protected NamedBeanHandle<SignalMast> signalCMastNamed

signalDMastNamed

protected NamedBeanHandle<SignalMast> signalDMastNamed

connectAName

public String connectAName

connectBName

public String connectBName

connectCName

public String connectCName

connectDName

public String connectDName

tLayoutBlockNameAC

public String tLayoutBlockNameAC

tLayoutBlockNameBD

public String tLayoutBlockNameBD

active

boolean active

sml

ArrayList<SignalMast> sml

Constructor Details

LevelXing

public LevelXing(String id,
 LayoutEditor models)

Constructor.

Parameters:

id - ID string.

models - the main layout editor.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getBlockNameAC

@Nonnull
public String getBlockNameAC()

getBlockNameBD

@Nonnull
public String getBlockNameBD()

getSignalHead

public SignalHead getSignalHead(LevelXing.Geometry loc)

getSignalMast

public SignalMast getSignalMast(LevelXing.Geometry loc)

getSensor

public Sensor getSensor(LevelXing.Geometry loc)

getSignalAName

@Nonnull
public String getSignalAName()

setSignalAName

public void setSignalAName(String signalHead)

getSignalBName

@Nonnull
public String getSignalBName()

setSignalBName

public void setSignalBName(String signalHead)

getSignalCName

@Nonnull
public String getSignalCName()

setSignalCName

public void setSignalCName(String signalHead)

getSignalDName

@Nonnull
public String getSignalDName()

setSignalDName

public void setSignalDName(String signalHead)

removeBeanReference

public void removeBeanReference(NamedBean nb)

getSignalAMastName

public String getSignalAMastName()

getSignalAMast

public SignalMast getSignalAMast()

setSignalAMast

public void setSignalAMast(String signalMast)

getSignalBMastName

public String getSignalBMastName()

getSignalBMast

public SignalMast getSignalBMast()

setSignalBMast

public void setSignalBMast(String signalMast)

getSignalCMastName

public String getSignalCMastName()

getSignalCMast

public SignalMast getSignalCMast()

setSignalCMast

public void setSignalCMast(String signalMast)

getSignalDMastName

public String getSignalDMastName()

getSignalDMast

public SignalMast getSignalDMast()

setSignalDMast

public void setSignalDMast(String signalMast)

getSensorAName

public String getSensorAName()

getSensorA

public Sensor getSensorA()

setSensorAName

public void setSensorAName(String sensorName)

getSensorBName

public String getSensorBName()

getSensorB

public Sensor getSensorB()

setSensorBName

public void setSensorBName(String sensorName)

getSensorCName

public String getSensorCName()

getSensorC

public Sensor getSensorC()

setSensorCName

public void setSensorCName(String sensorName)

getSensorDName

public String getSensorDName()

getSensorD

public Sensor getSensorD()

setSensorDName

public void setSensorDName(String sensorName)

getConnection

public LayoutTrack getConnection(HitPointType connectionType)
                          throws JmriException

get the LayoutTrack connected at the specified connection type

Specified by:

getConnection in class LayoutTrack

Parameters:

connectionType - where on us to get the connection

Returns:

the LayoutTrack connected at the specified connection type

Throws:

JmriException - - if the connectionType is invalid

setConnection

public void setConnection(HitPointType connectionType,
 LayoutTrack o,
 HitPointType type)
                   throws JmriException

set the LayoutTrack connected at the specified connection type

Specified by:

setConnection in class LayoutTrack

Parameters:

connectionType - where on us to set the connection

o - the LayoutTrack that is to be connected

type - where on the LayoutTrack we are connected

Throws:

JmriException - - if connectionType or type are invalid

getConnectA

public LayoutTrack getConnectA()

getConnectB

public LayoutTrack getConnectB()

getConnectC

public LayoutTrack getConnectC()

getConnectD

public LayoutTrack getConnectD()

setConnectA

public void setConnectA(LayoutTrack o,
 HitPointType type)

setConnectB

public void setConnectB(LayoutTrack o,
 HitPointType type)

setConnectC

public void setConnectC(LayoutTrack o,
 HitPointType type)

setConnectD

public void setConnectD(LayoutTrack o,
 HitPointType type)

getLayoutBlockAC

public LayoutBlock getLayoutBlockAC()

getLayoutBlockBD

public LayoutBlock getLayoutBlockBD()

setLayoutBlockAC

public void setLayoutBlockAC(LayoutBlock newLayoutBlock)

Add Layout Blocks.

Parameters:

newLayoutBlock - the layout block to add.

setLayoutBlockBD

public void setLayoutBlockBD(LayoutBlock newLayoutBlock)

updateBlockInfo

public void updateBlockInfo()

removeSML

void removeSML(SignalMast signalMast)

isMainlineAC

public boolean isMainlineAC()

Test if mainline track or not.

Returns:

true if either connecting track segment is mainline; Defaults to not mainline if connecting track segments are missing

isMainlineBD

public boolean isMainlineBD()

isMainline

public boolean isMainline()

Specified by:

isMainline in class LayoutTrack

setObjects

public void setObjects(LayoutEditor p)

Initialization method The above variables are initialized by PositionablePointXml, then the following method is called after the entire LayoutEditor is loaded to set the specific TrackSegment objects.

Specified by:

setObjects in class LayoutTrack

Parameters:

p - the layout editor

canRemove

public boolean canRemove()

Check for active block boundaries.

If any connection point of a layout track object has attached objects, such as signal masts, signal heads or NX sensors, the layout track object cannot be deleted.

Specified by:

canRemove in class LayoutTrack

Returns:

true if the layout track object can be deleted.

getBeanReferences

public ArrayList<String> getBeanReferences(String pointName)

Build a list of sensors, signal heads, and signal masts attached to a level crossing point.

Parameters:

pointName - Specify the point (A-D) or all (All) points.

Returns:

a list of bean reference names.

getBlockBoundaries

public String[] getBlockBoundaries()

remove

public void remove()

Remove this object from display and persistance.

isActive

public boolean isActive()

Get if active. "active" means that the object is still displayed, and should be stored.

Returns:

true if still displayed, else false.

addSignalMastLogic

public void addSignalMastLogic(SignalMast sm)

removeSignalMastLogic

public void removeSignalMastLogic(SignalMast sm)

reCheckBlockBoundary

public void reCheckBlockBoundary()

Description copied from class: LayoutTrack

abstract method... subclasses should implement _IF_ they need to recheck their block boundaries

Specified by:

reCheckBlockBoundary in class LayoutTrack

getLayoutConnectivity

protected ArrayList<LayoutConnectivity> getLayoutConnectivity()

Description copied from class: LayoutTrack

get the layout connectivity for this track

Specified by:

getLayoutConnectivity in class LayoutTrack

Returns:

the list of Layout Connectivity objects

checkForFreeConnections

public List<HitPointType> checkForFreeConnections()

return a list of the available connections for this layout track

Specified by:

checkForFreeConnections in class LayoutTrack

Returns:

the list of available connections

checkForUnAssignedBlocks

public boolean checkForUnAssignedBlocks()

determine if all the appropriate blocks have been assigned to this track

Specified by:

checkForUnAssignedBlocks in class LayoutTrack

Returns:

true if all appropriate blocks have been assigned

checkForNonContiguousBlocks

public void checkForNonContiguousBlocks(@Nonnull
 HashMap<String,List<Set<String>>> blockNamesToTrackNameSetsMap)

check this track and its neighbors for non-contiguous blocks

For each (non-null) blocks of this track do: #1) If it's got an entry in the blockNamesToTrackNameSetMap then #2) If this track is not in one of the TrackNameSets for this block #3) add a new set (with this block/track) to blockNamesToTrackNameSetMap and #4) check all the connections in this block (by calling the 2nd method below)

Basically, we're maintaining contiguous track sets for each block found (in blockNamesToTrackNameSetMap)

Specified by:

checkForNonContiguousBlocks in class LayoutTrack

Parameters:

blockNamesToTrackNameSetsMap - hashmap of key:block names to lists of track name sets for those blocks

collectContiguousTracksNamesInBlockNamed

public void collectContiguousTracksNamesInBlockNamed(@Nonnull
 String blockName,
 @Nonnull
 Set<String> TrackNameSet)

recursive routine to check for all contiguous tracks in this blockName

Specified by:

collectContiguousTracksNamesInBlockNamed in class LayoutTrack

Parameters:

blockName - the block that we're checking for

TrackNameSet - the set of track names in this block

setAllLayoutBlocks

public void setAllLayoutBlocks(LayoutBlock layoutBlock)

Assign all the layout blocks in this track

Specified by:

setAllLayoutBlocks in class LayoutTrack

Parameters:

layoutBlock - to this layout block (used by the Tools menu's "Assign block to selection" item)

getTypeName

public String getTypeName()

Get the type of this item.

Specified by:

getTypeName in class LayoutTrack

Returns:

the type