Skip to content

Commit

Permalink
enum update
Browse files Browse the repository at this point in the history
  • Loading branch information
@bobjacobsen
bobjacobsen committed May 4, 2020
1 parent 99fb239 commit 0d4e07e
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 74 deletions.
10 changes: 5 additions & 5 deletions java/src/jmri/implementation/DefaultSignalMastLogic.java
View file
Expand Up @@ -2114,10 +2114,10 @@ void setupLayoutEditorDetails() throws jmri.JmriException {
StringBuffer lBlksNamesBuf = new StringBuffer();
for (LayoutBlock pBlk : protectingBlocks) {
log.debug("checking layoutBlock {}", pBlk.getDisplayName());
pBlkNames = pBlkNames + pBlk.getDisplayName() + " (" + lbm.getLayoutBlockConnectivityTools().checkValidDest(facingBlock, pBlk, destinationBlock, remoteProtectingBlock, LayoutBlockConnectivityTools.MASTTOMAST) + "), ";
if (lbm.getLayoutBlockConnectivityTools().checkValidDest(facingBlock, pBlk, destinationBlock, remoteProtectingBlock, LayoutBlockConnectivityTools.MASTTOMAST)) {
pBlkNames = pBlkNames + pBlk.getDisplayName() + " (" + lbm.getLayoutBlockConnectivityTools().checkValidDest(facingBlock, pBlk, destinationBlock, remoteProtectingBlock, LayoutBlockConnectivityTools.Routing.MASTTOMAST) + "), ";
if (lbm.getLayoutBlockConnectivityTools().checkValidDest(facingBlock, pBlk, destinationBlock, remoteProtectingBlock, LayoutBlockConnectivityTools.Routing.MASTTOMAST)) {
try {
lblks = lbm.getLayoutBlockConnectivityTools().getLayoutBlocks(facingBlock, destinationBlock, pBlk, true, jmri.jmrit.display.layoutEditor.LayoutBlockConnectivityTools.MASTTOMAST);
lblks = lbm.getLayoutBlockConnectivityTools().getLayoutBlocks(facingBlock, destinationBlock, pBlk, true, jmri.jmrit.display.layoutEditor.LayoutBlockConnectivityTools.Routing.MASTTOMAST);
protectingBlock = pBlk;
log.debug("building path names...");
for (LayoutBlock lBlk : lblks) {
Expand All @@ -2137,7 +2137,7 @@ void setupLayoutEditorDetails() throws jmri.JmriException {
}
}
try {
if (!lbm.getLayoutBlockConnectivityTools().checkValidDest(facingBlock, protectingBlock, destinationBlock, remoteProtectingBlock, LayoutBlockConnectivityTools.MASTTOMAST)) {
if (!lbm.getLayoutBlockConnectivityTools().checkValidDest(facingBlock, protectingBlock, destinationBlock, remoteProtectingBlock, LayoutBlockConnectivityTools.Routing.MASTTOMAST)) {
throw new jmri.JmriException("Path not valid, destination check failed.");
}
} catch (jmri.JmriException e) {
Expand All @@ -2158,7 +2158,7 @@ void setupLayoutEditorDetails() throws jmri.JmriException {
}

try {
lblks = lbm.getLayoutBlockConnectivityTools().getLayoutBlocks(facingBlock, destinationBlock, protectingBlock, true, jmri.jmrit.display.layoutEditor.LayoutBlockConnectivityTools.MASTTOMAST);
lblks = lbm.getLayoutBlockConnectivityTools().getLayoutBlocks(facingBlock, destinationBlock, protectingBlock, true, jmri.jmrit.display.layoutEditor.LayoutBlockConnectivityTools.Routing.MASTTOMAST);
} catch (jmri.JmriException ee) {
log.error("No blocks found by the layout editor for pair {}-{}", source.getDisplayName(), destination.getDisplayName());
}
Expand Down
8 changes: 4 additions & 4 deletions java/src/jmri/jmrit/display/layoutEditor/LayoutBlock.java
View file
Expand Up @@ -2949,7 +2949,7 @@ public int getNextBlockByIndex(Block previousBlock, Block destBlock, int offSet)
* @param routingMethod value to match metric
* @return next block
*/
public int getNextBestBlock(Block previousBlock, Block destBlock, List<Integer> excludeBlock, int routingMethod) {
public int getNextBestBlock(Block previousBlock, Block destBlock, List<Integer> excludeBlock, LayoutBlockConnectivityTools.Metric routingMethod) {
if (enableSearchRouteLogging) {
log.info("From {} find best route from {} to {} index {} routingMethod {}", this.getDisplayName(), previousBlock.getDisplayName(), destBlock.getDisplayName(), excludeBlock, routingMethod);
}
Expand All @@ -2958,7 +2958,7 @@ public int getNextBestBlock(Block previousBlock, Block destBlock, List<Integer>
int lastValue = 0;
List<Block> nextBlocks = new ArrayList<>(5);
if (!excludeBlock.isEmpty() && (excludeBlock.get(excludeBlock.size() - 1) < routes.size())) {
if (routingMethod == LayoutBlockConnectivityTools.METRIC) {
if (routingMethod == LayoutBlockConnectivityTools.Metric.METRIC) {
lastValue = routes.get(excludeBlock.get(excludeBlock.size() - 1)).getMetric();
} else /* if (routingMethod==LayoutBlockManager.HOPCOUNT)*/ {
lastValue = routes.get(excludeBlock.get(excludeBlock.size() - 1)).getHopCount();
Expand All @@ -2980,7 +2980,7 @@ public int getNextBestBlock(Block previousBlock, Block destBlock, List<Integer>
if (!nextBlocks.contains(ro.getNextBlock())) {
// if(ro.getNextBlock()!=nextBlock){
int currentValue;
if (routingMethod == LayoutBlockConnectivityTools.METRIC) {
if (routingMethod == LayoutBlockConnectivityTools.Metric.METRIC) {
currentValue = routes.get(i).getMetric();
} else /*if (routingMethod==InstanceManager.getDefault(
LayoutBlockManager.class).HOPCOUNT)*/ {
Expand All @@ -3000,7 +3000,7 @@ public int getNextBestBlock(Block previousBlock, Block destBlock, List<Integer>
log.info("valid through path");
}

if (routingMethod == LayoutBlockConnectivityTools.METRIC) {
if (routingMethod == LayoutBlockConnectivityTools.Metric.METRIC) {
if (ro.getMetric() < bestCount) {
bestIndex = i;
bestCount = ro.getMetric();
Expand Down
98 changes: 52 additions & 46 deletions java/src/jmri/jmrit/display/layoutEditor/LayoutBlockConnectivityTools.java
View file
Expand Up @@ -28,41 +28,47 @@ public class LayoutBlockConnectivityTools {
public LayoutBlockConnectivityTools() {
}

/**
* Constant used in the getLayoutBlocks to represent a path from one Signal
* Mast to another and that no mast should be in the path.
*/
public final static int MASTTOMAST = 0x01;

/**
* Constant used in the getLayoutBlocks to represent a path from one Signal
* Head to another and that no head should be in the path.
*/
public final static int HEADTOHEAD = 0x02;

/**
* Constant used in the getLayoutBlocks to represent a path from one Sensor
* to another and that no sensor should be in the path.
*/
public final static int SENSORTOSENSOR = 0x04;

/**
* Constant used in the getLayoutBlocks to represent a path from either a
* Signal Mast or Head to another Signal Mast or Head and that no mast of
* head should be in the path.
*/
public final static int ANY = 0x08;

/**
* Constant used in the getLayoutBlocks to indicate that the system
* should not check for signal masts or heads on the path.
*/
public final static int NONE = 0x00;
public enum Routing {
/**
* Constant used in the getLayoutBlocks to represent a path from one Signal
* Mast to another and that no mast should be in the path.
*/
MASTTOMAST,

/**
* Constant used in the getLayoutBlocks to represent a path from one Signal
* Head to another and that no head should be in the path.
*/
HEADTOHEAD,

/**
* Constant used in the getLayoutBlocks to represent a path from one Sensor
* to another and that no sensor should be in the path.
*/
SENSORTOSENSOR,

/**
* Constant used in the getLayoutBlocks to represent a path from either a
* Signal Mast or Head to another Signal Mast or Head and that no mast of
* head should be in the path.
*/
ANY,

/**
* Constant used in the getLayoutBlocks to indicate that the system
* should not check for signal masts or heads on the path.
*/
NONE
}

public final static int HOPCOUNT = 0x00;
public final static int METRIC = 0x01;
public final static int DISTANCE = 0x02;
public enum Metric {
HOPCOUNT,
METRIC,
DISTANCE
}

private static final int ttlSize = 50;


/**
* Determines if a pair of NamedBeans (Signalhead, Signalmast or Sensor)
Expand All @@ -79,7 +85,7 @@ public LayoutBlockConnectivityTools() {
* @throws jmri.JmriException if no blocks can be found that related to the
* named beans.
*/
public boolean checkValidDest(NamedBean sourceBean, NamedBean destBean, int pathMethod) throws jmri.JmriException {
public boolean checkValidDest(NamedBean sourceBean, NamedBean destBean, Routing pathMethod) throws jmri.JmriException {
if (log.isDebugEnabled()) {
log.debug("check valid des with source/dest bean {} {}", sourceBean.getDisplayName(), destBean.getDisplayName());
}
Expand Down Expand Up @@ -148,7 +154,7 @@ public boolean checkValidDest(NamedBean sourceBean, NamedBean destBean, int path
* @throws jmri.JmriException if it can not find a valid path or the routing
* has not been enabled.
*/
public List<LayoutBlock> getLayoutBlocks(NamedBean sourceBean, NamedBean destBean, boolean validateOnly, int pathMethod) throws jmri.JmriException {
public List<LayoutBlock> getLayoutBlocks(NamedBean sourceBean, NamedBean destBean, boolean validateOnly, Routing pathMethod) throws jmri.JmriException {
List<LayoutEditor> layout = InstanceManager.getDefault(PanelMenu.class).getLayoutEditorPanelList();
LayoutBlockManager lbm = InstanceManager.getDefault(LayoutBlockManager.class);
LayoutBlock facingBlock = null;
Expand Down Expand Up @@ -239,7 +245,7 @@ public List<NamedBean> getBeansInPath(List<LayoutBlock> blocklist, LayoutEditor
* @return true if a path to the destination is valid.
* @throws jmri.JmriException if any Block is null;
*/
public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, LayoutBlock destBlock, LayoutBlock destProBlock, int pathMethod) throws jmri.JmriException {
public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, LayoutBlock destBlock, LayoutBlock destProBlock, Routing pathMethod) throws jmri.JmriException {

List<LayoutBlock> destList = new ArrayList<>();
if (destProBlock != null) {
Expand Down Expand Up @@ -282,7 +288,7 @@ public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, L
* @throws jmri.JmriException if any layout block is null or advanced
* routing is not enabled.
*/
public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, LayoutBlock destBlock, List<LayoutBlock> destBlockn1, int pathMethod) throws jmri.JmriException {
public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, LayoutBlock destBlock, List<LayoutBlock> destBlockn1, Routing pathMethod) throws jmri.JmriException {
LayoutBlockManager lbm = InstanceManager.getDefault(LayoutBlockManager.class);
if (!lbm.isAdvancedRoutingEnabled()) {
log.debug("Advanced routing has not been enabled therefore we cannot use this function");
Expand Down Expand Up @@ -347,9 +353,9 @@ public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, L
is null as this indicates that the destination signal mast is assigned
on an end bumper*/

if (pathMethod == SENSORTOSENSOR && destBlockn1.size() == 0) {
if (pathMethod == Routing.SENSORTOSENSOR && destBlockn1.size() == 0) {
// Change the pathMethod to accept the NX sensor at the end bumper.
pathMethod = NONE;
pathMethod = Routing.NONE;
}

List<LayoutBlock> blockList = getLayoutBlocks(currentBlock, destBlock, nextBlock, true, pathMethod); // Was MASTTOMAST
Expand Down Expand Up @@ -391,7 +397,7 @@ public boolean checkValidDest(LayoutBlock currentBlock, LayoutBlock nextBlock, L
* @return true if valid
* @throws JmriException during nested getProtectingBlocks operation
*/
private boolean checkValidDest(LayoutBlock facing, LayoutBlock protecting, FacingProtecting dest, int pathMethod) throws JmriException {
private boolean checkValidDest(LayoutBlock facing, LayoutBlock protecting, FacingProtecting dest, Routing pathMethod) throws JmriException {
if (facing == null || protecting == null || dest == null) {
return false;
}
Expand Down Expand Up @@ -444,7 +450,7 @@ private boolean checkValidDest(LayoutBlock facing, LayoutBlock protecting, Facin
* @throws jmri.JmriException if it can not find a valid path or the routing
* has not been enabled.
*/
public List<LayoutBlock> getLayoutBlocks(LayoutBlock sourceLayoutBlock, LayoutBlock destinationLayoutBlock, LayoutBlock protectingLayoutBlock, boolean validateOnly, int pathMethod) throws jmri.JmriException {
public List<LayoutBlock> getLayoutBlocks(LayoutBlock sourceLayoutBlock, LayoutBlock destinationLayoutBlock, LayoutBlock protectingLayoutBlock, boolean validateOnly, Routing pathMethod) throws jmri.JmriException {
lastErrorMessage = "Unknown Error Occured";
LayoutBlockManager lbm = InstanceManager.getDefault(LayoutBlockManager.class);

Expand Down Expand Up @@ -627,7 +633,7 @@ private boolean canLBlockBeUsed(LayoutBlock lBlock) {
String lastErrorMessage = "Unknown Error Occured";

// We need to take into account if the returned block has a signalmast attached.
int findBestHop(final Block preBlock, final Block currentBlock, Block destBlock, int direction, List<Integer> offSet, boolean validateOnly, int pathMethod) {
int findBestHop(final Block preBlock, final Block currentBlock, Block destBlock, int direction, List<Integer> offSet, boolean validateOnly, Routing pathMethod) {
int result = 0;

LayoutBlock currentLBlock = InstanceManager.getDefault(LayoutBlockManager.class).getLayoutBlock(currentBlock);
Expand All @@ -648,7 +654,7 @@ int findBestHop(final Block preBlock, final Block currentBlock, Block destBlock,
if (log.isDebugEnabled()) {
log.debug("Off Set {}", offSet);
}
result = currentLBlock.getNextBestBlock(preBlock, destBlock, offSet, METRIC);
result = currentLBlock.getNextBestBlock(preBlock, destBlock, offSet, Metric.METRIC);
}
if (result != -1) {
block = currentLBlock.getRouteNextBlockAtIndex(result);
Expand Down Expand Up @@ -775,7 +781,7 @@ private boolean checkForLevelCrossing(LayoutBlock curBlock) {
* NONE, ANY, MASTTOMAST, HEADTOHEAD
* @return the valid pairs
*/
public HashMap<NamedBean, List<NamedBean>> discoverValidBeanPairs(LayoutEditor editor, Class<?> T, int pathMethod) {
public HashMap<NamedBean, List<NamedBean>> discoverValidBeanPairs(LayoutEditor editor, Class<?> T, Routing pathMethod) {
LayoutBlockManager lbm = InstanceManager.getDefault(LayoutBlockManager.class);
HashMap<NamedBean, List<NamedBean>> retPairs = new HashMap<>();
List<FacingProtecting> beanList = generateBlocksWithBeans(editor, T);
Expand Down Expand Up @@ -820,7 +826,7 @@ public HashMap<NamedBean, List<NamedBean>> discoverValidBeanPairs(LayoutEditor e
* @return A list of all reachable NamedBeans
* @throws jmri.JmriException occurring during nested readAll operation
*/
public List<NamedBean> discoverPairDest(NamedBean source, LayoutEditor editor, Class<?> T, int pathMethod) throws JmriException {
public List<NamedBean> discoverPairDest(NamedBean source, LayoutEditor editor, Class<?> T, Routing pathMethod) throws JmriException {
if (log.isDebugEnabled()) {
log.debug("discover pairs from source {}", source.getDisplayName());
}
Expand All @@ -837,7 +843,7 @@ public List<NamedBean> discoverPairDest(NamedBean source, LayoutEditor editor, C
return ret;
}

List<NamedBean> discoverPairDest(NamedBean source, LayoutBlock lProtecting, LayoutBlock lFacing, List<FacingProtecting> blockList, int pathMethod) throws JmriException {
List<NamedBean> discoverPairDest(NamedBean source, LayoutBlock lProtecting, LayoutBlock lFacing, List<FacingProtecting> blockList, Routing pathMethod) throws JmriException {
LayoutBlockManager lbm = InstanceManager.getDefault(LayoutBlockManager.class);
if (!lbm.isAdvancedRoutingEnabled()) {
throw new JmriException("advanced routing not enabled");
Expand Down

0 comments on commit 0d4e07e

Please sign in to comment.