Package jmri.jmrit.display.layoutEditor

Class LayoutEditorFindItems

java.lang.Object

jmri.jmrit.display.layoutEditor.LayoutEditorFindItems

public final class LayoutEditorFindItems
extends Object

A collection of tools to find various objects within the layout model(s) (temporary) Consider renaming to LayoutModelFindItems, or even merge to LayoutModels

Constructor Summary

Constructors

Constructor	Description
LayoutEditorFindItems(LayoutModels models)

Method Summary

Modifier and Type	Method	Description
LayoutShape	findLayoutShapeByName(String name)
LayoutSlip	findLayoutSlipByBean(NamedBean bean)
LayoutSlip	findLayoutSlipByName(String name)
LayoutSlip	findLayoutSlipBySensor(String sensorName)
LayoutSlip	findLayoutSlipBySignalMast(String signalMastName)
LayoutTurnout	findLayoutTurnoutByBean(NamedBean bean)
LayoutTurnout	findLayoutTurnoutByName(String name)
LayoutTurnout	findLayoutTurnoutBySensor(String sensorName)
LayoutTurnout	findLayoutTurnoutBySignalMast(String signalMastName)
LayoutTurnout	findLayoutTurnoutByTurnoutName(String turnoutName)
LayoutTurntable	findLayoutTurntableByName(String name)
LevelXing	findLevelXingByBean(NamedBean bean)
LevelXing	findLevelXingByName(String name)
LevelXing	findLevelXingBySensor(String sensorName)
LevelXing	findLevelXingBySignalMast(String signalMastName)
LayoutTrack	findObjectByName(String name)	find object by name
PositionablePoint	findPositionableLinkPoint(LayoutBlock blk1)
PositionablePoint	findPositionablePointAtTrackSegments(TrackSegment tr1, TrackSegment tr2)
PositionablePoint	findPositionablePointByBean(NamedBean bean)
PositionablePoint	findPositionablePointByEastBoundBean(NamedBean bean)
PositionablePoint	findPositionablePointByEastBoundSensor(String sensorName)
PositionablePoint	findPositionablePointByEastBoundSignal(String signalName)
PositionablePoint	findPositionablePointByName(String name)
PositionablePoint	findPositionablePointByWestBoundBean(NamedBean bean)
PositionablePoint	findPositionablePointByWestBoundSensor(String sensorName)
PositionablePoint	findPositionablePointByWestBoundSignal(String signalName)
PositionablePoint	findPositionablePointByWestBoundSignalMast(String signalMastName)
ArrayList<TrackSegment>	findTrackSegmentByBlock(String name)	Returns an array list of track segments matching the block name.
TrackSegment	findTrackSegmentByName(String name)
String	uniqueName(String inPrefix)	Determine the first unused object name...
String	uniqueName(String inPrefix, int inStartIndex)	Determine the first unused object name...

Methods inherited from class java.lang.Object

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

Constructor Details

LayoutEditorFindItems

public LayoutEditorFindItems(LayoutModels models)

Method Details

findTrackSegmentByName

public TrackSegment findTrackSegmentByName(String name)

findPositionablePointByName

public PositionablePoint findPositionablePointByName(String name)

findPositionablePointAtTrackSegments

public PositionablePoint findPositionablePointAtTrackSegments(TrackSegment tr1,
 TrackSegment tr2)

findPositionableLinkPoint

public PositionablePoint findPositionableLinkPoint(LayoutBlock blk1)

findTrackSegmentByBlock

public ArrayList<TrackSegment> findTrackSegmentByBlock(String name)

Returns an array list of track segments matching the block name.

Parameters:

name - block name.

Returns:

array of segments, may be null.

findPositionablePointByEastBoundSignal

public PositionablePoint findPositionablePointByEastBoundSignal(String signalName)

findPositionablePointByWestBoundSignal

public PositionablePoint findPositionablePointByWestBoundSignal(String signalName)

findPositionablePointByWestBoundBean

public PositionablePoint findPositionablePointByWestBoundBean(NamedBean bean)

findPositionablePointByEastBoundBean

public PositionablePoint findPositionablePointByEastBoundBean(NamedBean bean)

findPositionablePointByWestBoundSignalMast

public PositionablePoint findPositionablePointByWestBoundSignalMast(String signalMastName)

findPositionablePointByBean

public PositionablePoint findPositionablePointByBean(NamedBean bean)

findLayoutTurnoutBySignalMast

@CheckReturnValue
public LayoutTurnout findLayoutTurnoutBySignalMast(String signalMastName)
                                            throws IllegalArgumentException

Throws:

IllegalArgumentException

findLayoutTurnoutByBean

@CheckReturnValue
public LayoutTurnout findLayoutTurnoutByBean(@CheckForNull
 NamedBean bean)

findLayoutTurnoutBySensor

@CheckReturnValue
public LayoutTurnout findLayoutTurnoutBySensor(String sensorName)
                                        throws IllegalArgumentException

Throws:

IllegalArgumentException

findLevelXingBySignalMast

public LevelXing findLevelXingBySignalMast(String signalMastName)
                                    throws IllegalArgumentException

Throws:

IllegalArgumentException

findLevelXingBySensor

public LevelXing findLevelXingBySensor(String sensorName)
                                throws IllegalArgumentException

Throws:

IllegalArgumentException

findLevelXingByBean

public LevelXing findLevelXingByBean(NamedBean bean)

findLayoutSlipByBean

public LayoutSlip findLayoutSlipByBean(NamedBean bean)

findLayoutSlipBySignalMast

public LayoutSlip findLayoutSlipBySignalMast(String signalMastName)
                                      throws IllegalArgumentException

Throws:

IllegalArgumentException

findLayoutSlipBySensor

public LayoutSlip findLayoutSlipBySensor(String sensorName)
                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

findPositionablePointByEastBoundSensor

public PositionablePoint findPositionablePointByEastBoundSensor(String sensorName)

findPositionablePointByWestBoundSensor

public PositionablePoint findPositionablePointByWestBoundSensor(String sensorName)

findLayoutTurnoutByName

@CheckReturnValue
public LayoutTurnout findLayoutTurnoutByName(String name)

findLayoutTurnoutByTurnoutName

@CheckReturnValue
public LayoutTurnout findLayoutTurnoutByTurnoutName(String turnoutName)

findLevelXingByName

public LevelXing findLevelXingByName(String name)

findLayoutSlipByName

public LayoutSlip findLayoutSlipByName(String name)

findLayoutTurntableByName

public LayoutTurntable findLayoutTurntableByName(String name)

findLayoutShapeByName

public LayoutShape findLayoutShapeByName(String name)

findObjectByName

public LayoutTrack findObjectByName(String name)

find object by name

Parameters:

name - the name of the object that you are looking for

Returns:

object the named object

uniqueName

public String uniqueName(String inPrefix,
 int inStartIndex)

Determine the first unused object name...

Parameters:

inPrefix - ...with this prefix...

inStartIndex - ...and this starting index...

Returns:

the first unused object name

uniqueName

public String uniqueName(String inPrefix)

Determine the first unused object name...

Parameters:

inPrefix - ...with this prefix...

Returns:

the first unused object name