001package jmri.jmrit.operations.trains.trainbuilder;
002
003import java.io.*;
004import java.nio.charset.StandardCharsets;
005import java.util.*;
006
007import jmri.InstanceManager;
008import jmri.Version;
009import jmri.jmrit.operations.locations.Location;
010import jmri.jmrit.operations.locations.Track;
011import jmri.jmrit.operations.locations.schedules.ScheduleItem;
012import jmri.jmrit.operations.rollingstock.RollingStock;
013import jmri.jmrit.operations.rollingstock.cars.*;
014import jmri.jmrit.operations.rollingstock.engines.Engine;
015import jmri.jmrit.operations.router.Router;
016import jmri.jmrit.operations.routes.RouteLocation;
017import jmri.jmrit.operations.setup.Setup;
018import jmri.jmrit.operations.trains.*;
019import jmri.jmrit.operations.trains.schedules.TrainSchedule;
020import jmri.jmrit.operations.trains.schedules.TrainScheduleManager;
021import jmri.util.swing.JmriJOptionPane;
022
023/**
024 * Methods to support the TrainBuilder class.
025 *
026 * @author Daniel Boudreau Copyright (C) 2021
027 */
028public class TrainBuilderBase extends TrainCommon {
029
030    // report levels
031    protected static final String ONE = Setup.BUILD_REPORT_MINIMAL;
032    protected static final String THREE = Setup.BUILD_REPORT_NORMAL;
033    protected static final String FIVE = Setup.BUILD_REPORT_DETAILED;
034    protected static final String SEVEN = Setup.BUILD_REPORT_VERY_DETAILED;
035
036    protected static final int DISPLAY_CAR_LIMIT_20 = 20; // build exception out
037                                                          // of staging
038    protected static final int DISPLAY_CAR_LIMIT_50 = 50;
039    protected static final int DISPLAY_CAR_LIMIT_100 = 100;
040
041    protected static final boolean USE_BUNIT = true;
042    protected static final String TIMING = "timing of trains";
043
044    // build variables shared between local routines
045    Date _startTime; // when the build report started
046    Train _train; // the train being built
047    int _numberCars = 0; // number of cars moved by this train
048    List<Engine> _engineList; // engines for this train, modified during build
049    Engine _lastEngine; // last engine found from getEngine
050    Engine _secondLeadEngine; // lead engine 2nd part of train's route
051    Engine _thirdLeadEngine; // lead engine 3rd part of the train's route
052    int _carIndex; // index for carList
053    List<Car> _carList; // cars for this train, modified during the build
054    List<RouteLocation> _routeList; // ordered list of locations
055    Hashtable<String, Integer> _numOfBlocks; // Number of blocks of cars
056                                             // departing staging.
057    int _completedMoves; // the number of pick up car moves for a location
058    int _reqNumOfMoves; // the requested number of car moves for a location
059    Location _departLocation; // train departs this location
060    Track _departStageTrack; // departure staging track (null if not staging)
061    Location _terminateLocation; // train terminates at this location
062    Track _terminateStageTrack; // terminate staging track (null if not staging)
063    PrintWriter _buildReport; // build report for this train
064    List<Car> _notRoutable = new ArrayList<>(); // cars that couldn't be routed
065    List<Location> _modifiedLocations = new ArrayList<>(); // modified locations
066    int _warnings = 0; // the number of warnings in the build report
067
068    // managers
069    TrainManager trainManager = InstanceManager.getDefault(TrainManager.class);
070    TrainScheduleManager trainScheduleManager = InstanceManager.getDefault(TrainScheduleManager.class);
071    CarLoads carLoads = InstanceManager.getDefault(CarLoads.class);
072    Router router = InstanceManager.getDefault(Router.class);
073
074    protected void createBuildReportFile() throws BuildFailedException {
075        // backup the train's previous build report file
076        InstanceManager.getDefault(TrainManagerXml.class).savePreviousBuildStatusFile(_train.getName());
077
078        // create build report file
079        File file = InstanceManager.getDefault(TrainManagerXml.class).createTrainBuildReportFile(_train.getName());
080        try {
081            _buildReport = new PrintWriter(
082                    new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), StandardCharsets.UTF_8)),
083                    true);
084        } catch (IOException e) {
085            log.error("Can not open build report file: {}", e.getLocalizedMessage());
086            throw new BuildFailedException(e);
087        }
088    }
089
090    /**
091     * Creates the build report header information lines. Build report date,
092     * JMRI version, train schedule, build report display levels, setup comment.
093     */
094    protected void showBuildReportInfo() {
095        addLine(_buildReport, ONE, Bundle.getMessage("BuildReportMsg", _train.getName(), getDate(_startTime)));
096        addLine(_buildReport, ONE,
097                Bundle.getMessage("BuildReportVersion", Version.name()));
098        if (!trainScheduleManager.getTrainScheduleActiveId().equals(TrainScheduleManager.NONE)) {
099            if (trainScheduleManager.getTrainScheduleActiveId().equals(TrainSchedule.ANY)) {
100                addLine(_buildReport, ONE, Bundle.getMessage("buildActiveSchedule", Bundle.getMessage("Any")));
101            } else {
102                TrainSchedule sch = trainScheduleManager.getActiveSchedule();
103                if (sch != null) {
104                    addLine(_buildReport, ONE, Bundle.getMessage("buildActiveSchedule", sch.getName()));
105                }
106            }
107        }
108        // show the various build detail levels
109        addLine(_buildReport, THREE, Bundle.getMessage("buildReportLevelThree"));
110        addLine(_buildReport, FIVE, Bundle.getMessage("buildReportLevelFive"));
111        addLine(_buildReport, SEVEN, Bundle.getMessage("buildReportLevelSeven"));
112
113        if (Setup.getRouterBuildReportLevel().equals(Setup.BUILD_REPORT_DETAILED)) {
114            addLine(_buildReport, SEVEN, Bundle.getMessage("buildRouterReportLevelDetailed"));
115        } else if (Setup.getRouterBuildReportLevel().equals(Setup.BUILD_REPORT_VERY_DETAILED)) {
116            addLine(_buildReport, SEVEN, Bundle.getMessage("buildRouterReportLevelVeryDetailed"));
117        }
118
119        if (!Setup.getComment().trim().isEmpty()) {
120            addLine(_buildReport, ONE, BLANK_LINE);
121            addLine(_buildReport, ONE, Setup.getComment());
122        }
123        addLine(_buildReport, ONE, BLANK_LINE);
124    }
125
126    protected void setUpRoute() throws BuildFailedException {
127        if (_train.getRoute() == null) {
128            throw new BuildFailedException(
129                    Bundle.getMessage("buildErrorRoute", _train.getName()));
130        }
131        // get the train's route
132        _routeList = _train.getRoute().getLocationsBySequenceList();
133        if (_routeList.size() < 1) {
134            throw new BuildFailedException(
135                    Bundle.getMessage("buildErrorNeedRoute", _train.getName()));
136        }
137        // train departs
138        _departLocation = locationManager.getLocationByName(_train.getTrainDepartsName());
139        if (_departLocation == null) {
140            throw new BuildFailedException(
141                    Bundle.getMessage("buildErrorNeedDepLoc", _train.getName()));
142        }
143        // train terminates
144        _terminateLocation = locationManager.getLocationByName(_train.getTrainTerminatesName());
145        if (_terminateLocation == null) {
146            throw new BuildFailedException(Bundle.getMessage("buildErrorNeedTermLoc", _train.getName()));
147        }
148    }
149
150    /**
151     * show train build options when in detailed mode
152     */
153    protected void showTrainBuildOptions() {
154        ResourceBundle rb = ResourceBundle.getBundle("jmri.jmrit.operations.setup.JmritOperationsSetupBundle");
155        addLine(_buildReport, FIVE, Bundle.getMessage("MenuItemBuildOptions") + ":");
156        if (Setup.isBuildAggressive()) {
157            addLine(_buildReport, FIVE, Bundle.getMessage("BuildModeAggressive"));
158            addLine(_buildReport, FIVE, Bundle.getMessage("BuildNumberPasses", Setup.getNumberPasses()));
159            if (Setup.isStagingTrackImmediatelyAvail() && _departLocation.isStaging()) {
160                addLine(_buildReport, FIVE, Bundle.getMessage("BuildStagingTrackAvail"));
161            }
162        } else {
163            addLine(_buildReport, FIVE, Bundle.getMessage("BuildModeNormal"));
164        }
165        // show switcher options
166        if (_train.isLocalSwitcher()) {
167            addLine(_buildReport, FIVE, BLANK_LINE);
168            addLine(_buildReport, FIVE, rb.getString("BorderLayoutSwitcherService") + ":");
169            if (Setup.isLocalInterchangeMovesEnabled()) {
170                addLine(_buildReport, FIVE, rb.getString("AllowLocalInterchange"));
171            } else {
172                addLine(_buildReport, FIVE, rb.getString("NoAllowLocalInterchange"));
173            }
174            if (Setup.isLocalSpurMovesEnabled()) {
175                addLine(_buildReport, FIVE, rb.getString("AllowLocalSpur"));
176            } else {
177                addLine(_buildReport, FIVE, rb.getString("NoAllowLocalSpur"));
178            }
179            if (Setup.isLocalYardMovesEnabled()) {
180                addLine(_buildReport, FIVE, rb.getString("AllowLocalYard"));
181            } else {
182                addLine(_buildReport, FIVE, rb.getString("NoAllowLocalYard"));
183            }
184        }
185        // show staging options
186        if (_departLocation.isStaging() || _terminateLocation.isStaging()) {
187            addLine(_buildReport, FIVE, BLANK_LINE);
188            addLine(_buildReport, FIVE, Bundle.getMessage("buildStagingOptions"));
189
190            if (Setup.isStagingTrainCheckEnabled() && _terminateLocation.isStaging()) {
191                addLine(_buildReport, FIVE, Bundle.getMessage("buildOptionRestrictStaging"));
192            }
193            if (Setup.isStagingTrackImmediatelyAvail() && _terminateLocation.isStaging()) {
194                addLine(_buildReport, FIVE, rb.getString("StagingAvailable"));
195            }
196            if (Setup.isStagingAllowReturnEnabled() &&
197                    _departLocation.isStaging() &&
198                    _terminateLocation.isStaging() &&
199                    _departLocation == _terminateLocation) {
200                addLine(_buildReport, FIVE, rb.getString("AllowCarsToReturn"));
201            }
202            if (Setup.isStagingPromptFromEnabled() && _departLocation.isStaging()) {
203                addLine(_buildReport, FIVE, rb.getString("PromptFromStaging"));
204            }
205            if (Setup.isStagingPromptToEnabled() && _terminateLocation.isStaging()) {
206                addLine(_buildReport, FIVE, rb.getString("PromptToStaging"));
207            }
208            if (Setup.isStagingTryNormalBuildEnabled() && _departLocation.isStaging()) {
209                addLine(_buildReport, FIVE, rb.getString("TryNormalStaging"));
210            }
211        }
212
213        // Car routing options
214        addLine(_buildReport, FIVE, BLANK_LINE);
215        addLine(_buildReport, FIVE, Bundle.getMessage("buildCarRoutingOptions"));
216
217        // warn if car routing is disabled
218        if (!Setup.isCarRoutingEnabled()) {
219            addLine(_buildReport, FIVE, Bundle.getMessage("RoutingDisabled"));
220            _warnings++;
221        } else {
222            if (Setup.isCarRoutingViaYardsEnabled()) {
223                addLine(_buildReport, FIVE, Bundle.getMessage("RoutingViaYardsEnabled"));
224            }
225            if (Setup.isCarRoutingViaStagingEnabled()) {
226                addLine(_buildReport, FIVE, Bundle.getMessage("RoutingViaStagingEnabled"));
227            }
228            if (Setup.isOnlyActiveTrainsEnabled()) {
229                addLine(_buildReport, FIVE, Bundle.getMessage("OnlySelectedTrains"));
230                _warnings++;
231                // list the selected trains
232                for (Train train : trainManager.getTrainsByNameList()) {
233                    if (train.isBuildEnabled()) {
234                        addLine(_buildReport, SEVEN,
235                                Bundle.getMessage("buildTrainNameAndDesc", train.getName(), train.getDescription()));
236                    }
237                }
238                if (!_train.isBuildEnabled()) {
239                    addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainNotSelected", _train.getName()));
240                }
241            } else {
242                addLine(_buildReport, FIVE, rb.getString("AllTrains"));
243            }
244            if (Setup.isCheckCarDestinationEnabled()) {
245                addLine(_buildReport, FIVE, Bundle.getMessage("CheckCarDestination"));
246            }
247        }
248        addLine(_buildReport, FIVE, BLANK_LINE);
249    }
250
251    /*
252     * Show the enabled and disabled build options for this train.
253     */
254    protected void showSpecificTrainBuildOptions() {
255        addLine(_buildReport, FIVE,
256                Bundle.getMessage("buildOptionsForTrain", _train.getName()));
257        showSpecificTrainBuildOptions(true);
258        addLine(_buildReport, FIVE, Bundle.getMessage("buildDisabledOptionsForTrain", _train.getName()));
259        showSpecificTrainBuildOptions(false);
260    }
261
262    /*
263     * Enabled when true lists selected build options for this train. Enabled
264     * when false list disabled build options for this train.
265     */
266    private void showSpecificTrainBuildOptions(boolean enabled) {
267
268        if (_train.isBuildTrainNormalEnabled() ^ !enabled) {
269            addLine(_buildReport, FIVE, Bundle.getMessage("NormalModeWhenBuilding"));
270        }
271        if (_train.isSendCarsToTerminalEnabled() ^ !enabled) {
272            addLine(_buildReport, FIVE, Bundle.getMessage("SendToTerminal", _terminateLocation.getName()));
273        }
274        if ((_train.isAllowReturnToStagingEnabled() || Setup.isStagingAllowReturnEnabled()) ^ !enabled &&
275                _departLocation.isStaging() &&
276                _departLocation == _terminateLocation) {
277            addLine(_buildReport, FIVE, Bundle.getMessage("AllowCarsToReturn"));
278        }
279        if (_train.isAllowLocalMovesEnabled() ^ !enabled) {
280            addLine(_buildReport, FIVE, Bundle.getMessage("AllowLocalMoves"));
281        }
282        if (_train.isAllowThroughCarsEnabled() ^ !enabled && _departLocation != _terminateLocation) {
283            addLine(_buildReport, FIVE, Bundle.getMessage("AllowThroughCars"));
284        }
285        if (_train.isServiceAllCarsWithFinalDestinationsEnabled() ^ !enabled) {
286            addLine(_buildReport, FIVE, Bundle.getMessage("ServiceAllCars"));
287        }
288        if (_train.isSendCarsWithCustomLoadsToStagingEnabled() ^ !enabled) {
289            addLine(_buildReport, FIVE, Bundle.getMessage("SendCustomToStaging"));
290        }
291        if (_train.isBuildConsistEnabled() ^ !enabled) {
292            addLine(_buildReport, FIVE, Bundle.getMessage("BuildConsist"));
293            if (enabled) {
294                addLine(_buildReport, SEVEN, Bundle.getMessage("BuildConsistHPT", Setup.getHorsePowerPerTon()));
295            }
296        }
297        addLine(_buildReport, FIVE, BLANK_LINE);
298    }
299
300    /**
301     * Adds to the build report what the train will service. Road and owner
302     * names, built dates, and engine types.
303     */
304    protected void showTrainServices() {
305        // show road names that this train will service
306        if (!_train.getLocoRoadOption().equals(Train.ALL_ROADS)) {
307            addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainLocoRoads", _train.getName(),
308                    _train.getLocoRoadOption(), formatStringToCommaSeparated(_train.getLocoRoadNames())));
309        }
310        // show owner names that this train will service
311        if (!_train.getOwnerOption().equals(Train.ALL_OWNERS)) {
312            addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainOwners", _train.getName(), _train.getOwnerOption(),
313                    formatStringToCommaSeparated(_train.getOwnerNames())));
314        }
315        // show built dates serviced
316        if (!_train.getBuiltStartYear().equals(Train.NONE)) {
317            addLine(_buildReport, FIVE,
318                    Bundle.getMessage("buildTrainBuiltAfter", _train.getName(), _train.getBuiltStartYear()));
319        }
320        if (!_train.getBuiltEndYear().equals(Train.NONE)) {
321            addLine(_buildReport, FIVE,
322                    Bundle.getMessage("buildTrainBuiltBefore", _train.getName(), _train.getBuiltEndYear()));
323        }
324
325        // show engine types that this train will service
326        if (!_train.getNumberEngines().equals("0")) {
327            addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainServicesEngineTypes", _train.getName()));
328            addLine(_buildReport, FIVE, formatStringToCommaSeparated(_train.getLocoTypeNames()));
329        }
330    }
331
332    /**
333     * Show and initialize the train's route. Determines the number of car moves
334     * requested for this train. Also adjust the number of car moves if the
335     * random car moves option was selected.
336     *
337     * @throws BuildFailedException if random variable isn't an integer
338     */
339    protected void showAndInitializeTrainRoute() throws BuildFailedException {
340        int requestedCarMoves = 0; // how many cars were asked to be moved
341        // TODO: DAB control minimal build by each train
342
343        addLine(_buildReport, THREE,
344                Bundle.getMessage("buildTrainRoute", _train.getName(), _train.getRoute().getName()));
345
346        // get the number of requested car moves for this train
347        for (RouteLocation rl : _routeList) {
348            // check to see if there's a location for each stop in the route
349            // this checks for a deleted location
350            Location location = locationManager.getLocationByName(rl.getName());
351            if (location == null || rl.getLocation() == null) {
352                throw new BuildFailedException(Bundle.getMessage("buildErrorLocMissing", _train.getRoute().getName()));
353            }
354            // train doesn't drop or pick up cars from staging locations found
355            // in middle of a route
356            if (location.isStaging() &&
357                    rl != _train.getTrainDepartsRouteLocation() &&
358                    rl != _train.getTrainTerminatesRouteLocation()) {
359                addLine(_buildReport, ONE,
360                        Bundle.getMessage("buildLocStaging", rl.getName()));
361                // don't allow car moves for this location
362                rl.setCarMoves(rl.getMaxCarMoves());
363            } else if (_train.isLocationSkipped(rl)) {
364                // if a location is skipped, no car drops or pick ups
365                addLine(_buildReport, THREE,
366                        Bundle.getMessage("buildLocSkippedMaxTrain", rl.getId(), rl.getName(),
367                                rl.getTrainDirectionString(), _train.getName(), rl.getMaxTrainLength(),
368                                Setup.getLengthUnit().toLowerCase()));
369                // don't allow car moves for this location
370                rl.setCarMoves(rl.getMaxCarMoves());
371            } else {
372                // we're going to use this location, so initialize
373                rl.setCarMoves(0); // clear the number of moves
374                // add up the total number of car moves requested
375                requestedCarMoves += rl.getMaxCarMoves();
376                // show the type of moves allowed at this location
377                if (!rl.isDropAllowed() && !rl.isPickUpAllowed() && !rl.isLocalMovesAllowed()) {
378                    addLine(_buildReport, THREE,
379                            Bundle.getMessage("buildLocNoDropsOrPickups", rl.getId(),
380                                    location.isStaging() ? Bundle.getMessage("Staging") : Bundle.getMessage("Location"),
381                                    rl.getName(),
382                                    rl.getTrainDirectionString(), rl.getMaxTrainLength(),
383                                    Setup.getLengthUnit().toLowerCase()));
384                } else if (rl == _train.getTrainTerminatesRouteLocation()) {
385                    addLine(_buildReport, THREE, Bundle.getMessage("buildLocTerminates", rl.getId(),
386                            location.isStaging() ? Bundle.getMessage("Staging") : Bundle.getMessage("Location"),
387                            rl.getName(), rl.getTrainDirectionString(), rl.getMaxCarMoves(),
388                            rl.isPickUpAllowed() ? Bundle.getMessage("Pickups").toLowerCase() + ", " : "",
389                            rl.isDropAllowed() ? Bundle.getMessage("Drop").toLowerCase() + ", " : "",
390                            rl.isLocalMovesAllowed() ? Bundle.getMessage("LocalMoves").toLowerCase() + ", " : ""));
391                } else {
392                    addLine(_buildReport, THREE, Bundle.getMessage("buildLocRequestMoves", rl.getId(),
393                            location.isStaging() ? Bundle.getMessage("Staging") : Bundle.getMessage("Location"),
394                            rl.getName(), rl.getTrainDirectionString(), rl.getMaxCarMoves(),
395                            rl.isPickUpAllowed() ? Bundle.getMessage("Pickups").toLowerCase() + ", " : "",
396                            rl.isDropAllowed() ? Bundle.getMessage("Drop").toLowerCase() + ", " : "",
397                            rl.isLocalMovesAllowed() ? Bundle.getMessage("LocalMoves").toLowerCase() + ", " : "",
398                            rl.getMaxTrainLength(), Setup.getLengthUnit().toLowerCase()));
399                }
400            }
401            rl.setTrainWeight(0); // clear the total train weight
402            rl.setTrainLength(0); // and length
403        }
404
405        // check for random moves in the train's route
406        for (RouteLocation rl : _routeList) {
407            if (rl.getRandomControl().equals(RouteLocation.DISABLED)) {
408                continue;
409            }
410            if (rl.getCarMoves() == 0 && rl.getMaxCarMoves() > 0) {
411                log.debug("Location ({}) has random control value {} and maximum moves {}", rl.getName(),
412                        rl.getRandomControl(), rl.getMaxCarMoves());
413                try {
414                    int value = Integer.parseInt(rl.getRandomControl());
415                    // now adjust the number of available moves for this
416                    // location
417                    double random = Math.random();
418                    log.debug("random {}", random);
419                    int moves = (int) (random * ((rl.getMaxCarMoves() * value / 100) + 1));
420                    log.debug("Reducing number of moves for location ({}) by {}", rl.getName(), moves);
421                    rl.setCarMoves(moves);
422                    requestedCarMoves = requestedCarMoves - moves;
423                    addLine(_buildReport, FIVE,
424                            Bundle.getMessage("buildRouteRandomControl", rl.getName(), rl.getId(),
425                                    rl.getRandomControl(), rl.getMaxCarMoves(), rl.getMaxCarMoves() - moves));
426                } catch (NumberFormatException e) {
427                    throw new BuildFailedException(Bundle.getMessage("buildErrorRandomControl",
428                            _train.getRoute().getName(), rl.getName(), rl.getRandomControl()));
429                }
430            }
431        }
432
433        int numMoves = requestedCarMoves; // number of car moves
434        if (!_train.isLocalSwitcher()) {
435            requestedCarMoves = requestedCarMoves / 2; // only need half as many
436                                                       // cars to meet requests
437        }
438        addLine(_buildReport, ONE, Bundle.getMessage("buildRouteRequest", _train.getRoute().getName(),
439                Integer.toString(requestedCarMoves), Integer.toString(numMoves)));
440
441        _train.setNumberCarsRequested(requestedCarMoves); // save number of car
442                                                          // moves requested
443        addLine(_buildReport, ONE, BLANK_LINE);
444    }
445
446    /**
447     * reports if local switcher
448     */
449    protected void showIfLocalSwitcher() {
450        if (_train.isLocalSwitcher()) {
451            addLine(_buildReport, THREE, Bundle.getMessage("buildTrainIsSwitcher", _train.getName(),
452                    TrainCommon.splitString(_train.getTrainDepartsName())));
453            addLine(_buildReport, THREE, BLANK_LINE);
454        }
455    }
456
457    /**
458     * Show how many engines are required for this train, and if a certain road
459     * name for the engine is requested. Show if there are any engine changes in
460     * the route, or if helper engines are needed. There can be up to 2 engine
461     * changes or helper requests. Show if caboose or FRED is needed for train,
462     * and if there's a road name requested. There can be up to 2 caboose
463     * changes in the route.
464     */
465    protected void showTrainRequirements() {
466        addLine(_buildReport, ONE, Bundle.getMessage("TrainRequirements"));
467        if (_train.isBuildConsistEnabled() && Setup.getHorsePowerPerTon() > 0) {
468            addLine(_buildReport, ONE,
469                    Bundle.getMessage("buildTrainReqConsist", Setup.getHorsePowerPerTon(), _train.getNumberEngines()));
470        } else if (_train.getNumberEngines().equals("0")) {
471            addLine(_buildReport, ONE, Bundle.getMessage("buildTrainReq0Engine"));
472        } else if (_train.getNumberEngines().equals("1")) {
473            addLine(_buildReport, ONE, Bundle.getMessage("buildTrainReq1Engine", _train.getTrainDepartsName(),
474                    _train.getEngineModel(), _train.getEngineRoad()));
475        } else {
476            addLine(_buildReport, ONE,
477                    Bundle.getMessage("buildTrainReqEngine", _train.getTrainDepartsName(), _train.getNumberEngines(),
478                            _train.getEngineModel(), _train.getEngineRoad()));
479        }
480        // show any required loco changes
481        if ((_train.getSecondLegOptions() & Train.CHANGE_ENGINES) == Train.CHANGE_ENGINES) {
482            addLine(_buildReport, ONE,
483                    Bundle.getMessage("buildTrainEngineChange", _train.getSecondLegStartLocationName(),
484                            _train.getSecondLegNumberEngines(), _train.getSecondLegEngineModel(),
485                            _train.getSecondLegEngineRoad()));
486        }
487        if ((_train.getSecondLegOptions() & Train.ADD_ENGINES) == Train.ADD_ENGINES) {
488            addLine(_buildReport, ONE,
489                    Bundle.getMessage("buildTrainAddEngines", _train.getSecondLegNumberEngines(),
490                            _train.getSecondLegStartLocationName(), _train.getSecondLegEngineModel(),
491                            _train.getSecondLegEngineRoad()));
492        }
493        if ((_train.getSecondLegOptions() & Train.REMOVE_ENGINES) == Train.REMOVE_ENGINES) {
494            addLine(_buildReport, ONE,
495                    Bundle.getMessage("buildTrainRemoveEngines", _train.getSecondLegNumberEngines(),
496                            _train.getSecondLegStartLocationName(), _train.getSecondLegEngineModel(),
497                            _train.getSecondLegEngineRoad()));
498        }
499        if ((_train.getSecondLegOptions() & Train.HELPER_ENGINES) == Train.HELPER_ENGINES) {
500            addLine(_buildReport, ONE,
501                    Bundle.getMessage("buildTrainHelperEngines", _train.getSecondLegNumberEngines(),
502                            _train.getSecondLegStartLocationName(), _train.getSecondLegEndLocationName(),
503                            _train.getSecondLegEngineModel(), _train.getSecondLegEngineRoad()));
504        }
505
506        if ((_train.getThirdLegOptions() & Train.CHANGE_ENGINES) == Train.CHANGE_ENGINES) {
507            addLine(_buildReport, ONE,
508                    Bundle.getMessage("buildTrainEngineChange", _train.getThirdLegStartLocationName(),
509                            _train.getThirdLegNumberEngines(), _train.getThirdLegEngineModel(),
510                            _train.getThirdLegEngineRoad()));
511        }
512        if ((_train.getThirdLegOptions() & Train.ADD_ENGINES) == Train.ADD_ENGINES) {
513            addLine(_buildReport, ONE,
514                    Bundle.getMessage("buildTrainAddEngines", _train.getThirdLegNumberEngines(),
515                            _train.getThirdLegStartLocationName(), _train.getThirdLegEngineModel(),
516                            _train.getThirdLegEngineRoad()));
517        }
518        if ((_train.getThirdLegOptions() & Train.REMOVE_ENGINES) == Train.REMOVE_ENGINES) {
519            addLine(_buildReport, ONE,
520                    Bundle.getMessage("buildTrainRemoveEngines", _train.getThirdLegNumberEngines(),
521                            _train.getThirdLegStartLocationName(), _train.getThirdLegEngineModel(),
522                            _train.getThirdLegEngineRoad()));
523        }
524        if ((_train.getThirdLegOptions() & Train.HELPER_ENGINES) == Train.HELPER_ENGINES) {
525            addLine(_buildReport, ONE,
526                    Bundle.getMessage("buildTrainHelperEngines", _train.getThirdLegNumberEngines(),
527                            _train.getThirdLegStartLocationName(), _train.getThirdLegEndLocationName(),
528                            _train.getThirdLegEngineModel(), _train.getThirdLegEngineRoad()));
529        }
530        // show caboose or FRED requirements
531        if (_train.isCabooseNeeded()) {
532            addLine(_buildReport, ONE, Bundle.getMessage("buildTrainRequiresCaboose", _train.getTrainDepartsName(),
533                    _train.getCabooseRoad()));
534        }
535        // show any caboose changes in the train's route
536        if ((_train.getSecondLegOptions() & Train.REMOVE_CABOOSE) == Train.REMOVE_CABOOSE ||
537                (_train.getSecondLegOptions() & Train.ADD_CABOOSE) == Train.ADD_CABOOSE) {
538            addLine(_buildReport, ONE,
539                    Bundle.getMessage("buildCabooseChange", _train.getSecondLegStartRouteLocation()));
540        }
541        if ((_train.getThirdLegOptions() & Train.REMOVE_CABOOSE) == Train.REMOVE_CABOOSE ||
542                (_train.getThirdLegOptions() & Train.ADD_CABOOSE) == Train.ADD_CABOOSE) {
543            addLine(_buildReport, ONE, Bundle.getMessage("buildCabooseChange", _train.getThirdLegStartRouteLocation()));
544        }
545        if (_train.isFredNeeded()) {
546            addLine(_buildReport, ONE,
547                    Bundle.getMessage("buildTrainRequiresFRED", _train.getTrainDepartsName(), _train.getCabooseRoad()));
548        }
549        addLine(_buildReport, ONE, BLANK_LINE);
550    }
551
552    /**
553     * Will also set the termination track if returning to staging
554     *
555     * @param departStageTrack departure track from staging
556     */
557    protected void setDepartureTrack(Track departStageTrack) {
558        if ((_terminateStageTrack == null || _terminateStageTrack == _departStageTrack) &&
559                _departLocation == _terminateLocation &&
560                Setup.isBuildAggressive() &&
561                Setup.isStagingTrackImmediatelyAvail()) {
562            _terminateStageTrack = departStageTrack; // use the same track
563        }
564        _departStageTrack = departStageTrack;
565    }
566
567    protected void showTrainCarRoads() {
568        if (!_train.getCarRoadOption().equals(Train.ALL_ROADS)) {
569            addLine(_buildReport, FIVE, BLANK_LINE);
570            addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainRoads", _train.getName(),
571                    _train.getCarRoadOption(), formatStringToCommaSeparated(_train.getCarRoadNames())));
572        }
573    }
574
575    protected void showTrainCabooseRoads() {
576        if (!_train.getCabooseRoadOption().equals(Train.ALL_ROADS)) {
577            addLine(_buildReport, FIVE, BLANK_LINE);
578            addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainCabooseRoads", _train.getName(),
579                    _train.getCabooseRoadOption(), formatStringToCommaSeparated(_train.getCabooseRoadNames())));
580        }
581    }
582
583    protected void showTrainCarTypes() {
584        addLine(_buildReport, FIVE, BLANK_LINE);
585        addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainServicesCarTypes", _train.getName()));
586        addLine(_buildReport, FIVE, formatStringToCommaSeparated(_train.getCarTypeNames()));
587    }
588
589    protected void showTrainLoadNames() {
590        if (!_train.getLoadOption().equals(Train.ALL_LOADS)) {
591            addLine(_buildReport, FIVE, Bundle.getMessage("buildTrainLoads", _train.getName(), _train.getLoadOption(),
592                    formatStringToCommaSeparated(_train.getLoadNames())));
593        }
594    }
595
596    /**
597     * Ask which staging track the train is to depart on.
598     *
599     * @return The departure track the user selected.
600     */
601    protected Track promptFromStagingDialog() {
602        List<Track> tracksIn = _departLocation.getTracksByNameList(null);
603        List<Track> validTracks = new ArrayList<>();
604        // only show valid tracks
605        for (Track track : tracksIn) {
606            if (checkDepartureStagingTrack(track)) {
607                validTracks.add(track);
608            }
609        }
610        if (validTracks.size() > 1) {
611            // need an object array for dialog window
612            Object[] tracks = new Object[validTracks.size()];
613            for (int i = 0; i < validTracks.size(); i++) {
614                tracks[i] = validTracks.get(i);
615            }
616
617            Track selected = (Track) JmriJOptionPane.showInputDialog(null,
618                    Bundle.getMessage("TrainDepartingStaging", _train.getName(), _departLocation.getName()),
619                    Bundle.getMessage("SelectDepartureTrack"), JmriJOptionPane.QUESTION_MESSAGE, null, tracks, null);
620            if (selected != null) {
621                addLine(_buildReport, FIVE, Bundle.getMessage("buildUserSelectedDeparture", selected.getName(),
622                        selected.getLocation().getName()));
623            }
624            return selected;
625        } else if (validTracks.size() == 1) {
626            Track track = validTracks.get(0);
627            addLine(_buildReport, FIVE,
628                    Bundle.getMessage("buildOnlyOneDepartureTrack", track.getName(), track.getLocation().getName()));
629            return track;
630        }
631        return null; // no tracks available
632    }
633
634    /**
635     * Ask which staging track the train is to terminate on.
636     *
637     * @return The termination track selected by the user.
638     */
639    protected Track promptToStagingDialog() {
640        List<Track> tracksIn = _terminateLocation.getTracksByNameList(null);
641        List<Track> validTracks = new ArrayList<>();
642        // only show valid tracks
643        for (Track track : tracksIn) {
644            if (checkTerminateStagingTrack(track)) {
645                validTracks.add(track);
646            }
647        }
648        if (validTracks.size() > 1) {
649            // need an object array for dialog window
650            Object[] tracks = new Object[validTracks.size()];
651            for (int i = 0; i < validTracks.size(); i++) {
652                tracks[i] = validTracks.get(i);
653            }
654
655            Track selected = (Track) JmriJOptionPane.showInputDialog(null,
656                    Bundle.getMessage("TrainTerminatingStaging", _train.getName(), _terminateLocation.getName()),
657                    Bundle.getMessage("SelectArrivalTrack"), JmriJOptionPane.QUESTION_MESSAGE, null, tracks, null);
658            if (selected != null) {
659                addLine(_buildReport, FIVE, Bundle.getMessage("buildUserSelectedArrival", selected.getName(),
660                        selected.getLocation().getName()));
661            }
662            return selected;
663        } else if (validTracks.size() == 1) {
664            return validTracks.get(0);
665        }
666        return null; // no tracks available
667    }
668
669    /**
670     * Removes the remaining cabooses and cars with FRED from consideration.
671     *
672     * @throws BuildFailedException code check if car being removed is in
673     *                              staging
674     */
675    protected void removeCaboosesAndCarsWithFred() throws BuildFailedException {
676        addLine(_buildReport, SEVEN, BLANK_LINE);
677        addLine(_buildReport, SEVEN, Bundle.getMessage("buildRemoveCarsNotNeeded"));
678        for (int i = 0; i < _carList.size(); i++) {
679            Car car = _carList.get(i);
680            if (car.isCaboose() || car.hasFred()) {
681                addLine(_buildReport, SEVEN,
682                        Bundle.getMessage("buildExcludeCarTypeAtLoc", car.toString(), car.getTypeName(),
683                                car.getTypeExtensions(), car.getLocationName(), car.getTrackName()));
684                // code check, should never be staging
685                if (car.getTrack() == _departStageTrack) {
686                    throw new BuildFailedException("ERROR: Attempt to removed car with FRED or Caboose from staging"); // NOI18N
687                }
688                _carList.remove(car); // remove this car from the list
689                i--;
690            }
691        }
692    }
693
694    /**
695     * Save the car's final destination and schedule id in case of train reset
696     */
697    protected void saveCarFinalDestinations() {
698        for (Car car : _carList) {
699            car.setPreviousFinalDestination(car.getFinalDestination());
700            car.setPreviousFinalDestinationTrack(car.getFinalDestinationTrack());
701            car.setPreviousScheduleId(car.getScheduleItemId());
702        }
703    }
704
705    /**
706     * Creates the carList. Only cars that can be serviced by this train are in
707     * the list.
708     *
709     * @throws BuildFailedException if car is marked as missing and is in
710     *                              staging
711     */
712    protected void getCarList() throws BuildFailedException {
713        // get list of cars for this route
714        _carList = carManager.getAvailableTrainList(_train);
715        addLine(_buildReport, SEVEN, BLANK_LINE);
716        addLine(_buildReport, SEVEN, Bundle.getMessage("buildRemoveCars"));
717        boolean showCar = true;
718        int carListSize = _carList.size();
719        // now remove cars that the train can't service
720        for (int i = 0; i < _carList.size(); i++) {
721            Car car = _carList.get(i);
722            // only show the first 100 cars removed due to wrong car type for
723            // train
724            if (showCar && carListSize - _carList.size() == DISPLAY_CAR_LIMIT_100) {
725                showCar = false;
726                addLine(_buildReport, FIVE,
727                        Bundle.getMessage("buildOnlyFirstXXXCars", DISPLAY_CAR_LIMIT_100, Bundle.getMessage("Type")));
728            }
729            // remove cars that don't have a track assignment
730            if (car.getTrack() == null) {
731                _warnings++;
732                addLine(_buildReport, ONE,
733                        Bundle.getMessage("buildWarningRsNoTrack", car.toString(), car.getLocationName()));
734                _carList.remove(car);
735                i--;
736                continue;
737            }
738            // remove cars that have been reported as missing
739            if (car.isLocationUnknown()) {
740                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarLocUnknown", car.toString(),
741                        car.getLocationName(), car.getTrackName()));
742                if (car.getTrack().equals(_departStageTrack)) {
743                    throw new BuildFailedException(Bundle.getMessage("buildErrorLocationUnknown", car.getLocationName(),
744                            car.getTrackName(), car.toString()));
745                }
746                _carList.remove(car);
747                i--;
748                continue;
749            }
750            // remove cars that are out of service
751            if (car.isOutOfService()) {
752                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarOutOfService", car.toString(),
753                        car.getLocationName(), car.getTrackName()));
754                if (car.getTrack().equals(_departStageTrack)) {
755                    throw new BuildFailedException(
756                            Bundle.getMessage("buildErrorLocationOutOfService", car.getLocationName(),
757                                    car.getTrackName(), car.toString()));
758                }
759                _carList.remove(car);
760                i--;
761                continue;
762            }
763            // does car have a destination that is part of this train's route?
764            if (car.getDestination() != null) {
765                RouteLocation rld = _train.getRoute().getLastLocationByName(car.getDestinationName());
766                if (rld == null) {
767                    addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarDestNotPartRoute", car.toString(),
768                            car.getDestinationName(), car.getDestinationTrackName(), _train.getRoute().getName()));
769                    // Code check, programming ERROR if car departing staging
770                    if (car.getLocation().equals(_departLocation) && _departStageTrack != null) {
771                        throw new BuildFailedException(Bundle.getMessage("buildErrorCarNotPartRoute", car.toString()));
772                    }
773                    _carList.remove(car); // remove this car from the list
774                    i--;
775                    continue;
776                }
777            }
778            // remove cars with FRED that have a destination that isn't the
779            // terminal
780            if (car.hasFred() && car.getDestination() != null && car.getDestination() != _terminateLocation) {
781                addLine(_buildReport, FIVE,
782                        Bundle.getMessage("buildExcludeCarWrongDest", car.toString(), car.getTypeName(),
783                                car.getTypeExtensions(), car.getDestinationName()));
784                _carList.remove(car);
785                i--;
786                continue;
787            }
788
789            // remove cabooses that have a destination that isn't the terminal,
790            // and no caboose changes in the train's route
791            if (car.isCaboose() &&
792                    car.getDestination() != null &&
793                    car.getDestination() != _terminateLocation &&
794                    (_train.getSecondLegOptions() & Train.ADD_CABOOSE + Train.REMOVE_CABOOSE) == 0 &&
795                    (_train.getThirdLegOptions() & Train.ADD_CABOOSE + Train.REMOVE_CABOOSE) == 0) {
796                addLine(_buildReport, FIVE,
797                        Bundle.getMessage("buildExcludeCarWrongDest", car.toString(), car.getTypeName(),
798                                car.getTypeExtensions(), car.getDestinationName()));
799                _carList.remove(car);
800                i--;
801                continue;
802            }
803
804            // is car at interchange or spur and is this train allowed to pull?
805            if (!checkPickupInterchangeOrSpur(car)) {
806                _carList.remove(car);
807                i--;
808                continue;
809            }
810            // note that for trains departing staging the engine and car roads,
811            // types, owners, and built date were already checked.
812
813            if (!car.isCaboose() && !_train.isCarRoadNameAccepted(car.getRoadName()) ||
814                    car.isCaboose() && !_train.isCabooseRoadNameAccepted(car.getRoadName())) {
815                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarWrongRoad", car.toString(),
816                        car.getLocationName(), car.getTrackName(), car.getTypeName(), car.getTypeExtensions(),
817                        car.getRoadName()));
818                _carList.remove(car);
819                i--;
820                continue;
821            }
822            if (!_train.isTypeNameAccepted(car.getTypeName())) {
823                // only show lead cars when excluding car type
824                if (showCar && (car.getKernel() == null || car.isLead())) {
825                    addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarWrongType", car.toString(),
826                            car.getLocationName(), car.getTrackName(), car.getTypeName()));
827                }
828                _carList.remove(car);
829                i--;
830                continue;
831            }
832            if (!_train.isOwnerNameAccepted(car.getOwnerName())) {
833                addLine(_buildReport, SEVEN,
834                        Bundle.getMessage("buildExcludeCarOwnerAtLoc", car.toString(), car.getOwnerName(),
835                                car.getLocationName(), car.getTrackName()));
836                _carList.remove(car);
837                i--;
838                continue;
839            }
840            if (!_train.isBuiltDateAccepted(car.getBuilt())) {
841                addLine(_buildReport, SEVEN,
842                        Bundle.getMessage("buildExcludeCarBuiltAtLoc", car.toString(), car.getBuilt(),
843                                car.getLocationName(), car.getTrackName()));
844                _carList.remove(car);
845                i--;
846                continue;
847            }
848
849            // all cars in staging must be accepted, so don't exclude if in
850            // staging
851            // note that a car's load can change when departing staging
852            // a car's wait value is ignored when departing staging
853            // a car's pick up day is ignored when departing staging
854            if (_departStageTrack == null || car.getTrack() != _departStageTrack) {
855                if (!car.isCaboose() &&
856                        !car.isPassenger() &&
857                        !_train.isLoadNameAccepted(car.getLoadName(), car.getTypeName())) {
858                    addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarLoadAtLoc", car.toString(),
859                            car.getTypeName(), car.getLoadName()));
860                    _carList.remove(car);
861                    i--;
862                    continue;
863                }
864                // remove cars with FRED if not needed by train
865                if (car.hasFred() && !_train.isFredNeeded()) {
866                    addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarWithFredAtLoc", car.toString(),
867                            car.getTypeName(), (car.getLocationName() + ", " + car.getTrackName())));
868                    _carList.remove(car); // remove this car from the list
869                    i--;
870                    continue;
871                }
872                // does the car have a pick up day?
873                if (!car.getPickupScheduleId().equals(Car.NONE)) {
874                    if (trainScheduleManager.getTrainScheduleActiveId().equals(TrainSchedule.ANY) ||
875                            car.getPickupScheduleId().equals(trainScheduleManager.getTrainScheduleActiveId())) {
876                        car.setPickupScheduleId(Car.NONE);
877                    } else {
878                        TrainSchedule sch = trainScheduleManager.getScheduleById(car.getPickupScheduleId());
879                        if (sch != null) {
880                            addLine(_buildReport, SEVEN,
881                                    Bundle.getMessage("buildExcludeCarSchedule", car.toString(), car.getTypeName(),
882                                            car.getLocationName(), car.getTrackName(), sch.getName()));
883                            _carList.remove(car);
884                            i--;
885                            continue;
886                        }
887                    }
888                }
889                // does car have a wait count?
890                if (car.getWait() > 0) {
891                    addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarWait", car.toString(),
892                            car.getTypeName(), car.getLocationName(), car.getTrackName(), car.getWait()));
893                    if (_train.isServiceable(car)) {
894                        addLine(_buildReport, SEVEN, Bundle.getMessage("buildTrainCanServiceWait", _train.getName(),
895                                car.toString(), car.getWait() - 1));
896                        car.setWait(car.getWait() - 1); // decrement wait count
897                        // a car's load changes when the wait count reaches 0
898                        String oldLoad = car.getLoadName();
899                        if (car.getTrack().isSpur()) {
900                            car.updateLoad(car.getTrack()); // has the wait
901                                                            // count reached 0?
902                        }
903                        String newLoad = car.getLoadName();
904                        if (!oldLoad.equals(newLoad)) {
905                            addLine(_buildReport, SEVEN, Bundle.getMessage("buildCarLoadChangedWait", car.toString(),
906                                    car.getTypeName(), oldLoad, newLoad));
907                        }
908                    }
909                    _carList.remove(car);
910                    i--;
911                    continue;
912                }
913            }
914        }
915    }
916
917    /**
918     * Adjust car list to only have cars from one staging track
919     *
920     * @throws BuildFailedException if all cars departing staging can't be used
921     */
922    protected void adjustCarsInStaging() throws BuildFailedException {
923        if (!_train.isDepartingStaging()) {
924            return; // not departing staging
925        }
926        int numCarsFromStaging = 0;
927        _numOfBlocks = new Hashtable<>();
928        addLine(_buildReport, SEVEN, BLANK_LINE);
929        addLine(_buildReport, SEVEN, Bundle.getMessage("buildRemoveCarsStaging"));
930        for (int i = 0; i < _carList.size(); i++) {
931            Car car = _carList.get(i);
932            if (car.getLocationName().equals(_departLocation.getName())) {
933                if (car.getTrackName().equals(_departStageTrack.getName())) {
934                    numCarsFromStaging++;
935                    // populate car blocking hashtable
936                    // don't block cabooses, cars with FRED, or passenger. Only
937                    // block lead cars in
938                    // kernel
939                    if (!car.isCaboose() &&
940                            !car.hasFred() &&
941                            !car.isPassenger() &&
942                            (car.getKernel() == null || car.isLead())) {
943                        log.debug("Car {} last location id: {}", car.toString(), car.getLastLocationId());
944                        Integer number = 1;
945                        if (_numOfBlocks.containsKey(car.getLastLocationId())) {
946                            number = _numOfBlocks.get(car.getLastLocationId()) + 1;
947                            _numOfBlocks.remove(car.getLastLocationId());
948                        }
949                        _numOfBlocks.put(car.getLastLocationId(), number);
950                    }
951                } else {
952                    addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarAtLoc", car.toString(),
953                            car.getTypeName(), car.getLocationName(), car.getTrackName()));
954                    _carList.remove(car);
955                    i--;
956                }
957            }
958        }
959        // show how many cars are departing from staging
960        addLine(_buildReport, FIVE, BLANK_LINE);
961        addLine(_buildReport, FIVE, Bundle.getMessage("buildDepartingStagingCars",
962                _departStageTrack.getLocation().getName(), _departStageTrack.getName(), numCarsFromStaging));
963        // and list them
964        for (Car car : _carList) {
965            if (car.getTrack() == _departStageTrack) {
966                addLine(_buildReport, SEVEN, Bundle.getMessage("buildStagingCarAtLoc", car.toString(),
967                        car.getTypeName(), car.getLoadType().toLowerCase(), car.getLoadName()));
968            }
969        }
970        // error if all of the cars from staging aren't available
971        if (numCarsFromStaging != _departStageTrack.getNumberCars()) {
972            throw new BuildFailedException(Bundle.getMessage("buildErrorNotAllCars", _departStageTrack.getName(),
973                    Integer.toString(_departStageTrack.getNumberCars() - numCarsFromStaging)));
974        }
975        log.debug("Staging departure track ({}) has {} cars and {} blocks", _departStageTrack.getName(),
976                numCarsFromStaging, _numOfBlocks.size()); // NOI18N
977    }
978
979    /**
980     * List available cars by location. Removes non-lead kernel cars from the
981     * car list.
982     *
983     * @throws BuildFailedException if kernel doesn't have lead or cars aren't
984     *                              on the same track.
985     */
986    protected void showCarsByLocation() throws BuildFailedException {
987        // show how many cars were found
988        addLine(_buildReport, FIVE, BLANK_LINE);
989        addLine(_buildReport, ONE,
990                Bundle.getMessage("buildFoundCars", Integer.toString(_carList.size()), _train.getName()));
991        // only show cars once using the train's route
992        List<String> locationNames = new ArrayList<>();
993        for (RouteLocation rl : _train.getRoute().getLocationsBySequenceList()) {
994            if (locationNames.contains(rl.getName())) {
995                continue;
996            }
997            locationNames.add(rl.getName());
998            int count = countRollingStockAt(rl, new ArrayList<RollingStock>(_carList));
999            if (rl.getLocation().isStaging()) {
1000                addLine(_buildReport, FIVE,
1001                        Bundle.getMessage("buildCarsInStaging", count, rl.getName()));
1002            } else {
1003                addLine(_buildReport, FIVE,
1004                        Bundle.getMessage("buildCarsAtLocation", count, rl.getName()));
1005            }
1006            // now go through the car list and remove non-lead cars in kernels,
1007            // destinations
1008            // that aren't part of this route
1009            int carCount = 0;
1010            for (int i = 0; i < _carList.size(); i++) {
1011                Car car = _carList.get(i);
1012                if (!car.getLocationName().equals(rl.getName())) {
1013                    continue;
1014                }
1015                // only print out the first DISPLAY_CAR_LIMIT cars for each
1016                // location
1017                if (carCount < DISPLAY_CAR_LIMIT_50 && (car.getKernel() == null || car.isLead())) {
1018                    if (car.getLoadPriority().equals(CarLoad.PRIORITY_LOW) &&
1019                            car.getTrack().getTrackPriority().equals(Track.PRIORITY_NORMAL)) {
1020                        addLine(_buildReport, SEVEN,
1021                                Bundle.getMessage("buildCarAtLocWithMoves", car.toString(), car.getTypeName(),
1022                                        car.getTypeExtensions(), car.getLocationName(), car.getTrackName(),
1023                                        car.getMoves()));
1024                    } else {
1025                        addLine(_buildReport, SEVEN,
1026                                Bundle.getMessage("buildCarAtLocWithMovesPriority", car.toString(), car.getTypeName(),
1027                                        car.getTypeExtensions(), car.getLocationName(), car.getTrackName(),
1028                                        car.getTrack().getTrackPriority(), car.getMoves(),
1029                                        car.getLoadType().toLowerCase(), car.getLoadName(),
1030                                        car.getLoadPriority()));
1031                    }
1032                    if (car.isLead()) {
1033                        addLine(_buildReport, SEVEN,
1034                                Bundle.getMessage("buildCarLeadKernel", car.toString(), car.getKernelName(),
1035                                        car.getKernel().getSize(), car.getKernel().getTotalLength(),
1036                                        Setup.getLengthUnit().toLowerCase()));
1037                        // list all of the cars in the kernel now
1038                        for (Car k : car.getKernel().getCars()) {
1039                            if (!k.isLead()) {
1040                                addLine(_buildReport, SEVEN,
1041                                        Bundle.getMessage("buildCarPartOfKernel", k.toString(), k.getKernelName(),
1042                                                k.getKernel().getSize(), k.getKernel().getTotalLength(),
1043                                                Setup.getLengthUnit().toLowerCase()));
1044                            }
1045                        }
1046                    }
1047                    carCount++;
1048                    if (carCount == DISPLAY_CAR_LIMIT_50) {
1049                        addLine(_buildReport, SEVEN,
1050                                Bundle.getMessage("buildOnlyFirstXXXCars", carCount, rl.getName()));
1051                    }
1052                }
1053                // report car in kernel but lead has been removed
1054                if (car.getKernel() != null && !_carList.contains(car.getKernel().getLead())) {
1055                    addLine(_buildReport, SEVEN,
1056                            Bundle.getMessage("buildCarPartOfKernel", car.toString(), car.getKernelName(),
1057                                    car.getKernel().getSize(), car.getKernel().getTotalLength(),
1058                                    Setup.getLengthUnit().toLowerCase()));
1059                }
1060                // use only the lead car in a kernel for building trains
1061                if (car.getKernel() != null) {
1062                    checkKernel(car); // kernel needs lead car and all cars on
1063                                      // the same track
1064                    if (!car.isLead()) {
1065                        _carList.remove(car); // remove this car from the list
1066                        i--;
1067                        continue;
1068                    }
1069                }
1070                if (_train.equals(car.getTrain())) {
1071                    addLine(_buildReport, FIVE, Bundle.getMessage("buildCarAlreadyAssigned", car.toString()));
1072                }
1073            }
1074            addLine(_buildReport, SEVEN, BLANK_LINE);
1075        }
1076    }
1077
1078    protected void sortCarsOnFifoLifoTracks() {
1079        addLine(_buildReport, SEVEN, Bundle.getMessage("buildSortCarsByLastDate"));
1080        for (_carIndex = 0; _carIndex < _carList.size(); _carIndex++) {
1081            Car car = _carList.get(_carIndex);
1082            if (car.getTrack().getServiceOrder().equals(Track.NORMAL) || car.getTrack().isStaging()) {
1083                continue;
1084            }
1085            addLine(_buildReport, SEVEN,
1086                    Bundle.getMessage("buildTrackModePriority", car.toString(), car.getTrack().getTrackTypeName(),
1087                            car.getLocationName(), car.getTrackName(), car.getTrack().getServiceOrder(),
1088                            car.getLastDate()));
1089            Car bestCar = car;
1090            for (int i = _carIndex + 1; i < _carList.size(); i++) {
1091                Car testCar = _carList.get(i);
1092                if (testCar.getTrack() == car.getTrack() &&
1093                        bestCar.getLoadPriority().equals(testCar.getLoadPriority())) {
1094                    log.debug("{} car ({}) last moved date: {}", car.getTrack().getTrackTypeName(), testCar.toString(),
1095                            testCar.getLastDate()); // NOI18N
1096                    if (car.getTrack().getServiceOrder().equals(Track.FIFO)) {
1097                        if (bestCar.getLastMoveDate().after(testCar.getLastMoveDate())) {
1098                            bestCar = testCar;
1099                            log.debug("New best car ({})", bestCar.toString());
1100                        }
1101                    } else if (car.getTrack().getServiceOrder().equals(Track.LIFO)) {
1102                        if (bestCar.getLastMoveDate().before(testCar.getLastMoveDate())) {
1103                            bestCar = testCar;
1104                            log.debug("New best car ({})", bestCar.toString());
1105                        }
1106                    }
1107                }
1108            }
1109            if (car != bestCar) {
1110                addLine(_buildReport, SEVEN,
1111                        Bundle.getMessage("buildTrackModeCarPriority", car.getTrack().getTrackTypeName(),
1112                                car.getTrackName(), car.getTrack().getServiceOrder(), bestCar.toString(),
1113                                bestCar.getLastDate(), car.toString(), car.getLastDate()));
1114                _carList.remove(bestCar); // change sort
1115                _carList.add(_carIndex, bestCar);
1116            }
1117        }
1118        addLine(_buildReport, SEVEN, BLANK_LINE);
1119    }
1120
1121    /**
1122     * Verifies that all cars in the kernel have the same departure track. Also
1123     * checks to see if the kernel has a lead car and the lead car is in
1124     * service.
1125     *
1126     * @throws BuildFailedException
1127     */
1128    private void checkKernel(Car car) throws BuildFailedException {
1129        boolean foundLeadCar = false;
1130        for (Car c : car.getKernel().getCars()) {
1131            // check that lead car exists
1132            if (c.isLead() && !c.isOutOfService()) {
1133                foundLeadCar = true;
1134            }
1135            // check to see that all cars have the same location and track
1136            if (car.getLocation() != c.getLocation() ||
1137                    c.getTrack() == null ||
1138                    !car.getTrack().getSplitName().equals(c.getTrack().getSplitName())) {
1139                throw new BuildFailedException(Bundle.getMessage("buildErrorCarKernelLocation", c.toString(),
1140                        car.getKernelName(), c.getLocationName(), c.getTrackName(), car.toString(),
1141                        car.getLocationName(), car.getTrackName()));
1142            }
1143        }
1144        // code check, all kernels should have a lead car
1145        if (foundLeadCar == false) {
1146            throw new BuildFailedException(Bundle.getMessage("buildErrorCarKernelNoLead", car.getKernelName()));
1147        }
1148    }
1149
1150    /*
1151     * For blocking cars out of staging
1152     */
1153    protected String getLargestBlock() {
1154        Enumeration<String> en = _numOfBlocks.keys();
1155        String largestBlock = "";
1156        int maxCars = 0;
1157        while (en.hasMoreElements()) {
1158            String locId = en.nextElement();
1159            if (_numOfBlocks.get(locId) > maxCars) {
1160                largestBlock = locId;
1161                maxCars = _numOfBlocks.get(locId);
1162            }
1163        }
1164        return largestBlock;
1165    }
1166
1167    /**
1168     * Returns the routeLocation with the most available moves. Used for
1169     * blocking a train out of staging.
1170     *
1171     * @param blockRouteList The route for this train, modified by deleting
1172     *                       RouteLocations serviced
1173     * @param blockId        Where these cars were originally picked up from.
1174     * @return The location in the route with the most available moves.
1175     */
1176    protected RouteLocation getLocationWithMaximumMoves(List<RouteLocation> blockRouteList, String blockId) {
1177        RouteLocation rlMax = null;
1178        int maxMoves = 0;
1179        for (RouteLocation rl : blockRouteList) {
1180            if (rl == _train.getTrainDepartsRouteLocation()) {
1181                continue;
1182            }
1183            if (rl.getMaxCarMoves() - rl.getCarMoves() > maxMoves) {
1184                maxMoves = rl.getMaxCarMoves() - rl.getCarMoves();
1185                rlMax = rl;
1186            }
1187            // if two locations have the same number of moves, return the one
1188            // that doesn't match the block id
1189            if (rl.getMaxCarMoves() - rl.getCarMoves() == maxMoves && !rl.getLocation().getId().equals(blockId)) {
1190                rlMax = rl;
1191            }
1192        }
1193        return rlMax;
1194    }
1195
1196    /**
1197     * Temporally remove cars from staging track if train returning to the same
1198     * staging track to free up track space.
1199     */
1200    protected void makeAdjustmentsIfDepartingStaging() {
1201        if (_train.isDepartingStaging()) {
1202            _reqNumOfMoves = 0;
1203            // Move cars out of staging after working other locations
1204            // if leaving and returning to staging on the same track, temporary pull cars off the track
1205            if (_departStageTrack == _terminateStageTrack) {
1206                if (!_train.isAllowReturnToStagingEnabled() && !Setup.isStagingAllowReturnEnabled()) {
1207                    // takes care of cars in a kernel by getting all cars
1208                    for (Car car : carManager.getList()) {
1209                        // don't remove caboose or car with FRED already
1210                        // assigned to train
1211                        if (car.getTrack() == _departStageTrack && car.getRouteDestination() == null) {
1212                            car.setLocation(car.getLocation(), null);
1213                        }
1214                    }
1215                } else {
1216                    // since all cars can return to staging, the track space is
1217                    // consumed for now
1218                    addLine(_buildReport, THREE, BLANK_LINE);
1219                    addLine(_buildReport, THREE, Bundle.getMessage("buildWarnDepartStaging",
1220                            _departStageTrack.getLocation().getName(), _departStageTrack.getName()));
1221                    addLine(_buildReport, THREE, BLANK_LINE);
1222                }
1223            }
1224            addLine(_buildReport, THREE,
1225                    Bundle.getMessage("buildDepartStagingAggressive", _departStageTrack.getLocation().getName()));
1226        }
1227    }
1228
1229    /**
1230     * Restores cars departing staging track assignment.
1231     */
1232    protected void restoreCarsIfDepartingStaging() {
1233        if (_train.isDepartingStaging() &&
1234                _departStageTrack == _terminateStageTrack &&
1235                !_train.isAllowReturnToStagingEnabled() &&
1236                !Setup.isStagingAllowReturnEnabled()) {
1237            // restore departure track for cars departing staging
1238            for (Car car : _carList) {
1239                if (car.getLocation() == _departStageTrack.getLocation() && car.getTrack() == null) {
1240                    car.setLocation(_departStageTrack.getLocation(), _departStageTrack, RollingStock.FORCE); // force
1241                    if (car.getKernel() != null) {
1242                        for (Car k : car.getKernel().getCars()) {
1243                            k.setLocation(_departStageTrack.getLocation(), _departStageTrack, RollingStock.FORCE); // force
1244                        }
1245                    }
1246                }
1247            }
1248        }
1249    }
1250
1251    protected void showLoadGenerationOptionsStaging() {
1252        if (_departStageTrack != null &&
1253                _reqNumOfMoves > 0 &&
1254                (_departStageTrack.isAddCustomLoadsEnabled() ||
1255                        _departStageTrack.isAddCustomLoadsAnySpurEnabled() ||
1256                        _departStageTrack.isAddCustomLoadsAnyStagingTrackEnabled())) {
1257            addLine(_buildReport, FIVE, Bundle.getMessage("buildCustomLoadOptions", _departStageTrack.getName()));
1258            if (_departStageTrack.isAddCustomLoadsEnabled()) {
1259                addLine(_buildReport, FIVE, Bundle.getMessage("buildLoadCarLoads"));
1260            }
1261            if (_departStageTrack.isAddCustomLoadsAnySpurEnabled()) {
1262                addLine(_buildReport, FIVE, Bundle.getMessage("buildLoadAnyCarLoads"));
1263            }
1264            if (_departStageTrack.isAddCustomLoadsAnyStagingTrackEnabled()) {
1265                addLine(_buildReport, FIVE, Bundle.getMessage("buildLoadsStaging"));
1266            }
1267            addLine(_buildReport, FIVE, BLANK_LINE);
1268        }
1269    }
1270
1271    /**
1272     * Checks to see if all cars on a staging track have been given a
1273     * destination. Throws exception if there's a car without a destination.
1274     *
1275     * @throws BuildFailedException if car on staging track not assigned to
1276     *                              train
1277     */
1278    protected void checkStuckCarsInStaging() throws BuildFailedException {
1279        if (!_train.isDepartingStaging()) {
1280            return;
1281        }
1282        int carCount = 0;
1283        StringBuffer buf = new StringBuffer();
1284        // confirm that all cars in staging are departing
1285        for (Car car : _carList) {
1286            // build failure if car departing staging without a destination or
1287            // train
1288            if (car.getTrack() == _departStageTrack &&
1289                    (car.getDestination() == null || car.getDestinationTrack() == null || car.getTrain() == null)) {
1290                if (car.getKernel() != null) {
1291                    for (Car c : car.getKernel().getCars()) {
1292                        carCount++;
1293                        addCarToStuckStagingList(c, buf, carCount);
1294                    }
1295                } else {
1296                    carCount++;
1297                    addCarToStuckStagingList(car, buf, carCount);
1298                }
1299            }
1300        }
1301        if (carCount > 0) {
1302            log.debug("{} cars stuck in staging", carCount);
1303            String msg = Bundle.getMessage("buildStagingCouldNotFindDest", carCount,
1304                    _departStageTrack.getLocation().getName(), _departStageTrack.getName());
1305            throw new BuildFailedException(msg + buf.toString(), BuildFailedException.STAGING);
1306        }
1307    }
1308
1309    /**
1310     * Creates a list of up to 20 cars stuck in staging.
1311     *
1312     * @param car      The car to add to the list
1313     * @param buf      StringBuffer
1314     * @param carCount how many cars in the list
1315     */
1316    private void addCarToStuckStagingList(Car car, StringBuffer buf, int carCount) {
1317        if (carCount <= DISPLAY_CAR_LIMIT_20) {
1318            buf.append(NEW_LINE + " " + car.toString());
1319        } else if (carCount == DISPLAY_CAR_LIMIT_20 + 1) {
1320            buf.append(NEW_LINE +
1321                    Bundle.getMessage("buildOnlyFirstXXXCars", DISPLAY_CAR_LIMIT_20, _departStageTrack.getName()));
1322        }
1323    }
1324
1325    /**
1326     * Used to determine if a car on a staging track doesn't have a destination
1327     * or train
1328     *
1329     * @return true if at least one car doesn't have a destination or train.
1330     *         false if all cars have a destination.
1331     */
1332    protected boolean isCarStuckStaging() {
1333        if (_train.isDepartingStaging()) {
1334            // confirm that all cars in staging are departing
1335            for (Car car : _carList) {
1336                if (car.getTrack() == _departStageTrack &&
1337                        (car.getDestination() == null || car.getDestinationTrack() == null || car.getTrain() == null)) {
1338                    return true;
1339                }
1340            }
1341        }
1342        return false;
1343    }
1344
1345    protected void finishAddRsToTrain(RollingStock rs, RouteLocation rl, RouteLocation rld, int length,
1346            int weightTons) {
1347        // notify that locations have been modified when build done
1348        // allows automation actions to run properly
1349        if (!_modifiedLocations.contains(rl.getLocation())) {
1350            _modifiedLocations.add(rl.getLocation());
1351        }
1352        if (!_modifiedLocations.contains(rld.getLocation())) {
1353            _modifiedLocations.add(rld.getLocation());
1354        }
1355        rs.setTrain(_train);
1356        rs.setRouteLocation(rl);
1357        rs.setRouteDestination(rld);
1358        // now adjust train length and weight for each location that the rolling
1359        // stock is in the train
1360        boolean inTrain = false;
1361        for (RouteLocation routeLocation : _routeList) {
1362            if (rl == routeLocation) {
1363                inTrain = true;
1364            }
1365            if (rld == routeLocation) {
1366                break; // done
1367            }
1368            if (inTrain) {
1369                routeLocation.setTrainLength(routeLocation.getTrainLength() + length);
1370                routeLocation.setTrainWeight(routeLocation.getTrainWeight() + weightTons);
1371            }
1372        }
1373    }
1374
1375    /**
1376     * Determine if rolling stock can be picked up based on train direction at
1377     * the route location.
1378     *
1379     * @param rs The rolling stock
1380     * @param rl The rolling stock's route location
1381     * @throws BuildFailedException if coding issue
1382     * @return true if there isn't a problem
1383     */
1384    protected boolean checkPickUpTrainDirection(RollingStock rs, RouteLocation rl) throws BuildFailedException {
1385        // Code Check, car or engine should have a track assignment
1386        if (rs.getTrack() == null) {
1387            throw new BuildFailedException(
1388                    Bundle.getMessage("buildWarningRsNoTrack", rs.toString(), rs.getLocationName()));
1389        }
1390        // ignore local switcher direction
1391        if (_train.isLocalSwitcher()) {
1392            return true;
1393        }
1394        if ((rl.getTrainDirection() &
1395                rs.getLocation().getTrainDirections() &
1396                rs.getTrack().getTrainDirections()) != 0) {
1397            return true;
1398        }
1399
1400        // Only track direction can cause the following message. Location
1401        // direction has
1402        // already been checked
1403        addLine(_buildReport, SEVEN,
1404                Bundle.getMessage("buildRsCanNotPickupUsingTrain", rs.toString(), rl.getTrainDirectionString(),
1405                        rs.getTrackName(), rs.getLocationName(), rl.getId()));
1406        return false;
1407    }
1408
1409    /**
1410     * Used to report a problem picking up the rolling stock due to train
1411     * direction.
1412     *
1413     * @param rl The route location
1414     * @return true if there isn't a problem
1415     */
1416    protected boolean checkPickUpTrainDirection(RouteLocation rl) {
1417        // ignore local switcher direction
1418        if (_train.isLocalSwitcher()) {
1419            return true;
1420        }
1421        if ((rl.getTrainDirection() & rl.getLocation().getTrainDirections()) != 0) {
1422            return true;
1423        }
1424
1425        addLine(_buildReport, ONE, Bundle.getMessage("buildLocDirection", rl.getName(), rl.getTrainDirectionString()));
1426        return false;
1427    }
1428
1429    /**
1430     * Determines if car can be pulled from an interchange or spur. Needed for
1431     * quick service tracks.
1432     * 
1433     * @param car the car being pulled
1434     * @return true if car can be pulled, otherwise false.
1435     */
1436    protected boolean checkPickupInterchangeOrSpur(Car car) {
1437        if (car.getTrack().isInterchange()) {
1438            // don't service a car at interchange and has been dropped off
1439            // by this train
1440            if (car.getTrack().getPickupOption().equals(Track.ANY) &&
1441                    car.getLastRouteId().equals(_train.getRoute().getId())) {
1442                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeCarDropByTrain", car.toString(),
1443                        car.getTypeName(), _train.getRoute().getName(), car.getLocationName(), car.getTrackName()));
1444                return false;
1445            }
1446        }
1447        // is car at interchange or spur and is this train allowed to pull?
1448        if (car.getTrack().isInterchange() || car.getTrack().isSpur()) {
1449            if (car.getTrack().getPickupOption().equals(Track.TRAINS) ||
1450                    car.getTrack().getPickupOption().equals(Track.EXCLUDE_TRAINS)) {
1451                if (car.getTrack().isPickupTrainAccepted(_train)) {
1452                    log.debug("Car ({}) can be picked up by this train", car.toString());
1453                } else {
1454                    addLine(_buildReport, SEVEN,
1455                            Bundle.getMessage("buildExcludeCarByTrain", car.toString(), car.getTypeName(),
1456                                    car.getTrack().getTrackTypeName(), car.getLocationName(), car.getTrackName()));
1457                    return false;
1458                }
1459            } else if (car.getTrack().getPickupOption().equals(Track.ROUTES) ||
1460                    car.getTrack().getPickupOption().equals(Track.EXCLUDE_ROUTES)) {
1461                if (car.getTrack().isPickupRouteAccepted(_train.getRoute())) {
1462                    log.debug("Car ({}) can be picked up by this route", car.toString());
1463                } else {
1464                    addLine(_buildReport, SEVEN,
1465                            Bundle.getMessage("buildExcludeCarByRoute", car.toString(), car.getTypeName(),
1466                                    car.getTrack().getTrackTypeName(), car.getLocationName(), car.getTrackName()));
1467                    return false;
1468                }
1469            }
1470        }
1471        return true;
1472    }
1473
1474    /**
1475     * Checks to see if train length would be exceeded if this car was added to
1476     * the train.
1477     *
1478     * @param car the car in question
1479     * @param rl  the departure route location for this car
1480     * @param rld the destination route location for this car
1481     * @return true if car can be added to train
1482     */
1483    protected boolean checkTrainLength(Car car, RouteLocation rl, RouteLocation rld) {
1484        // car can be a kernel so get total length
1485        int length = car.getTotalKernelLength();
1486        boolean carInTrain = false;
1487        for (RouteLocation rlt : _routeList) {
1488            if (rl == rlt) {
1489                carInTrain = true;
1490            }
1491            if (rld == rlt) {
1492                break;
1493            }
1494            if (carInTrain && rlt.getTrainLength() + length > rlt.getMaxTrainLength()) {
1495                addLine(_buildReport, FIVE,
1496                        Bundle.getMessage("buildCanNotPickupCarLength", car.toString(), length,
1497                                Setup.getLengthUnit().toLowerCase(), rlt.getMaxTrainLength(),
1498                                Setup.getLengthUnit().toLowerCase(),
1499                                rlt.getTrainLength() + length - rlt.getMaxTrainLength(), rlt.getName(), rlt.getId()));
1500                return false;
1501            }
1502        }
1503        return true;
1504    }
1505
1506    protected boolean checkDropTrainDirection(RollingStock rs, RouteLocation rld, Track track) {
1507        // local?
1508        if (_train.isLocalSwitcher()) {
1509            return true;
1510        }
1511        // this location only services trains with these directions
1512        int serviceTrainDir = rld.getLocation().getTrainDirections();
1513        if (track != null) {
1514            serviceTrainDir = serviceTrainDir & track.getTrainDirections();
1515        }
1516
1517        // is this a car going to alternate track? Check to see if direct move
1518        // from alternate to FD track is possible
1519        if ((rld.getTrainDirection() & serviceTrainDir) != 0 &&
1520                rs != null &&
1521                track != null &&
1522                Car.class.isInstance(rs)) {
1523            Car car = (Car) rs;
1524            if (car.getFinalDestinationTrack() != null &&
1525                    track == car.getFinalDestinationTrack().getAlternateTrack() &&
1526                    (track.getTrainDirections() & car.getFinalDestinationTrack().getTrainDirections()) == 0) {
1527                addLine(_buildReport, SEVEN,
1528                        Bundle.getMessage("buildCanNotDropRsUsingTrain4", car.getFinalDestinationTrack().getName(),
1529                                formatStringToCommaSeparated(
1530                                        Setup.getDirectionStrings(car.getFinalDestinationTrack().getTrainDirections())),
1531                                car.getFinalDestinationTrack().getAlternateTrack().getName(),
1532                                formatStringToCommaSeparated(Setup.getDirectionStrings(
1533                                        car.getFinalDestinationTrack().getAlternateTrack().getTrainDirections()))));
1534                return false;
1535            }
1536        }
1537
1538        if ((rld.getTrainDirection() & serviceTrainDir) != 0) {
1539            return true;
1540        }
1541        if (rs == null || track == null) {
1542            addLine(_buildReport, SEVEN,
1543                    Bundle.getMessage("buildDestinationDoesNotService", rld.getName(), rld.getTrainDirectionString()));
1544        } else {
1545            addLine(_buildReport, SEVEN, Bundle.getMessage("buildCanNotDropRsUsingTrain", rs.toString(),
1546                    rld.getTrainDirectionString(), track.getName()));
1547        }
1548        return false;
1549    }
1550
1551    protected boolean checkDropTrainDirection(RouteLocation rld) {
1552        return (checkDropTrainDirection(null, rld, null));
1553    }
1554
1555    /**
1556     * Determinate if rolling stock can be dropped by this train to the track
1557     * specified.
1558     *
1559     * @param rs    the rolling stock to be set out.
1560     * @param track the destination track.
1561     * @return true if able to drop.
1562     */
1563    protected boolean checkTrainCanDrop(RollingStock rs, Track track) {
1564        if (track.isInterchange() || track.isSpur()) {
1565            if (track.getDropOption().equals(Track.TRAINS) || track.getDropOption().equals(Track.EXCLUDE_TRAINS)) {
1566                if (track.isDropTrainAccepted(_train)) {
1567                    log.debug("Rolling stock ({}) can be droped by train to track ({})", rs.toString(),
1568                            track.getName());
1569                } else {
1570                    addLine(_buildReport, SEVEN,
1571                            Bundle.getMessage("buildCanNotDropTrain", rs.toString(), _train.getName(),
1572                                    track.getTrackTypeName(), track.getLocation().getName(), track.getName()));
1573                    return false;
1574                }
1575            }
1576            if (track.getDropOption().equals(Track.ROUTES) || track.getDropOption().equals(Track.EXCLUDE_ROUTES)) {
1577                if (track.isDropRouteAccepted(_train.getRoute())) {
1578                    log.debug("Rolling stock ({}) can be droped by route to track ({})", rs.toString(),
1579                            track.getName());
1580                } else {
1581                    addLine(_buildReport, SEVEN,
1582                            Bundle.getMessage("buildCanNotDropRoute", rs.toString(), _train.getRoute().getName(),
1583                                    track.getTrackTypeName(), track.getLocation().getName(), track.getName()));
1584                    return false;
1585                }
1586            }
1587        }
1588        return true;
1589    }
1590
1591    /**
1592     * Check departure staging track to see if engines and cars are available to
1593     * a new train. Also confirms that the engine and car type, load, road, etc.
1594     * are accepted by the train.
1595     *
1596     * @param departStageTrack The staging track
1597     * @return true is there are engines and cars available.
1598     */
1599    protected boolean checkDepartureStagingTrack(Track departStageTrack) {
1600        addLine(_buildReport, THREE,
1601                Bundle.getMessage("buildStagingHas", departStageTrack.getName(),
1602                        Integer.toString(departStageTrack.getNumberEngines()),
1603                        Integer.toString(departStageTrack.getNumberCars())));
1604        // does this staging track service this train?
1605        if (!departStageTrack.isPickupTrainAccepted(_train)) {
1606            addLine(_buildReport, THREE, Bundle.getMessage("buildStagingNotTrain", departStageTrack.getName()));
1607            return false;
1608        }
1609        if (departStageTrack.getNumberRS() == 0 && _train.getTrainDepartsRouteLocation().getMaxCarMoves() > 0) {
1610            addLine(_buildReport, THREE, Bundle.getMessage("buildStagingEmpty", departStageTrack.getName()));
1611            return false;
1612        }
1613        if (departStageTrack.getUsedLength() > _train.getTrainDepartsRouteLocation().getMaxTrainLength()) {
1614            addLine(_buildReport, THREE,
1615                    Bundle.getMessage("buildStagingTrainTooLong", departStageTrack.getName(),
1616                            departStageTrack.getUsedLength(), Setup.getLengthUnit().toLowerCase(),
1617                            _train.getTrainDepartsRouteLocation().getMaxTrainLength()));
1618            return false;
1619        }
1620        if (departStageTrack.getNumberCars() > _train.getTrainDepartsRouteLocation().getMaxCarMoves()) {
1621            addLine(_buildReport, THREE, Bundle.getMessage("buildStagingTooManyCars", departStageTrack.getName(),
1622                    departStageTrack.getNumberCars(), _train.getTrainDepartsRouteLocation().getMaxCarMoves()));
1623            return false;
1624        }
1625        // does the staging track have the right number of locomotives?
1626        if (!_train.getNumberEngines().equals("0") &&
1627                getNumberEngines(_train.getNumberEngines()) != departStageTrack.getNumberEngines()) {
1628            addLine(_buildReport, THREE, Bundle.getMessage("buildStagingNotEngines", departStageTrack.getName(),
1629                    departStageTrack.getNumberEngines(), _train.getNumberEngines()));
1630            return false;
1631        }
1632        // is the staging track direction correct for this train?
1633        if ((departStageTrack.getTrainDirections() & _train.getTrainDepartsRouteLocation().getTrainDirection()) == 0) {
1634            addLine(_buildReport, THREE, Bundle.getMessage("buildStagingNotDirection", departStageTrack.getName()));
1635            return false;
1636        }
1637
1638        // check engines on staging track
1639        if (!checkStagingEngines(departStageTrack)) {
1640            return false;
1641        }
1642
1643        // check for car road, load, owner, built, Caboose or FRED needed
1644        if (!checkStagingCarTypeRoadLoadOwnerBuiltCabooseOrFRED(departStageTrack)) {
1645            return false;
1646        }
1647
1648        // determine if staging track is in a pool (multiple trains on one
1649        // staging track)
1650        if (!checkStagingPool(departStageTrack)) {
1651            return false;
1652        }
1653        addLine(_buildReport, FIVE,
1654                Bundle.getMessage("buildTrainCanDepartTrack", _train.getName(), departStageTrack.getName()));
1655        return true;
1656    }
1657
1658    /**
1659     * Used to determine if engines on staging track are acceptable to the train
1660     * being built.
1661     *
1662     * @param departStageTrack Depart staging track
1663     * @return true if engines on staging track meet train requirement
1664     */
1665    private boolean checkStagingEngines(Track departStageTrack) {
1666        if (departStageTrack.getNumberEngines() > 0) {
1667            for (Engine eng : engineManager.getList()) {
1668                if (eng.getTrack() == departStageTrack) {
1669                    // has engine been assigned to another train?
1670                    if (eng.getRouteLocation() != null) {
1671                        addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepart", departStageTrack.getName(),
1672                                eng.getTrainName()));
1673                        return false;
1674                    }
1675                    if (eng.getTrain() != null && eng.getTrain() != _train) {
1676                        addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartEngineTrain",
1677                                departStageTrack.getName(), eng.toString(), eng.getTrainName()));
1678                        return false;
1679                    }
1680                    // does the train accept the engine type from the staging
1681                    // track?
1682                    if (!_train.isTypeNameAccepted(eng.getTypeName())) {
1683                        addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartEngineType",
1684                                departStageTrack.getName(), eng.toString(), eng.getTypeName(), _train.getName()));
1685                        return false;
1686                    }
1687                    // does the train accept the engine model from the staging
1688                    // track?
1689                    if (!_train.getEngineModel().equals(Train.NONE) &&
1690                            !_train.getEngineModel().equals(eng.getModel())) {
1691                        addLine(_buildReport, THREE,
1692                                Bundle.getMessage("buildStagingDepartEngineModel", departStageTrack.getName(),
1693                                        eng.toString(), eng.getModel(), _train.getName()));
1694                        return false;
1695                    }
1696                    // does the engine road match the train requirements?
1697                    if (!_train.getCarRoadOption().equals(Train.ALL_ROADS) &&
1698                            !_train.getEngineRoad().equals(Train.NONE) &&
1699                            !_train.getEngineRoad().equals(eng.getRoadName())) {
1700                        addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartEngineRoad",
1701                                departStageTrack.getName(), eng.toString(), eng.getRoadName(), _train.getName()));
1702                        return false;
1703                    }
1704                    // does the train accept the engine road from the staging
1705                    // track?
1706                    if (_train.getEngineRoad().equals(Train.NONE) &&
1707                            !_train.isLocoRoadNameAccepted(eng.getRoadName())) {
1708                        addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartEngineRoad",
1709                                departStageTrack.getName(), eng.toString(), eng.getRoadName(), _train.getName()));
1710                        return false;
1711                    }
1712                    // does the train accept the engine owner from the staging
1713                    // track?
1714                    if (!_train.isOwnerNameAccepted(eng.getOwnerName())) {
1715                        addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartEngineOwner",
1716                                departStageTrack.getName(), eng.toString(), eng.getOwnerName(), _train.getName()));
1717                        return false;
1718                    }
1719                    // does the train accept the engine built date from the
1720                    // staging track?
1721                    if (!_train.isBuiltDateAccepted(eng.getBuilt())) {
1722                        addLine(_buildReport, THREE,
1723                                Bundle.getMessage("buildStagingDepartEngineBuilt", departStageTrack.getName(),
1724                                        eng.toString(), eng.getBuilt(), _train.getName()));
1725                        return false;
1726                    }
1727                }
1728            }
1729        }
1730        return true;
1731    }
1732
1733    /**
1734     * Checks to see if all cars in staging can be serviced by the train being
1735     * built. Also searches for caboose or car with FRED.
1736     *
1737     * @param departStageTrack Departure staging track
1738     * @return True if okay
1739     */
1740    private boolean checkStagingCarTypeRoadLoadOwnerBuiltCabooseOrFRED(Track departStageTrack) {
1741        boolean foundCaboose = false;
1742        boolean foundFRED = false;
1743        if (departStageTrack.getNumberCars() > 0) {
1744            for (Car car : carManager.getList()) {
1745                if (car.getTrack() != departStageTrack) {
1746                    continue;
1747                }
1748                // ignore non-lead cars in kernels
1749                if (car.getKernel() != null && !car.isLead()) {
1750                    continue; // ignore non-lead cars
1751                }
1752                // has car been assigned to another train?
1753                if (car.getRouteLocation() != null) {
1754                    log.debug("Car ({}) has route location ({})", car.toString(), car.getRouteLocation().getName());
1755                    addLine(_buildReport, THREE,
1756                            Bundle.getMessage("buildStagingDepart", departStageTrack.getName(), car.getTrainName()));
1757                    return false;
1758                }
1759                if (car.getTrain() != null && car.getTrain() != _train) {
1760                    addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartCarTrain",
1761                            departStageTrack.getName(), car.toString(), car.getTrainName()));
1762                    return false;
1763                }
1764                // does the train accept the car type from the staging track?
1765                if (!_train.isTypeNameAccepted(car.getTypeName())) {
1766                    addLine(_buildReport, THREE,
1767                            Bundle.getMessage("buildStagingDepartCarType", departStageTrack.getName(), car.toString(),
1768                                    car.getTypeName(), _train.getName()));
1769                    return false;
1770                }
1771                // does the train accept the car road from the staging track?
1772                if (!car.isCaboose() && !_train.isCarRoadNameAccepted(car.getRoadName())) {
1773                    addLine(_buildReport, THREE,
1774                            Bundle.getMessage("buildStagingDepartCarRoad", departStageTrack.getName(), car.toString(),
1775                                    car.getRoadName(), _train.getName()));
1776                    return false;
1777                }
1778                // does the train accept the car load from the staging track?
1779                if (!car.isCaboose() &&
1780                        !car.isPassenger() &&
1781                        (!car.getLoadName().equals(carLoads.getDefaultEmptyName()) ||
1782                                !departStageTrack.isAddCustomLoadsEnabled() &&
1783                                        !departStageTrack.isAddCustomLoadsAnySpurEnabled() &&
1784                                        !departStageTrack.isAddCustomLoadsAnyStagingTrackEnabled()) &&
1785                        !_train.isLoadNameAccepted(car.getLoadName(), car.getTypeName())) {
1786                    addLine(_buildReport, THREE,
1787                            Bundle.getMessage("buildStagingDepartCarLoad", departStageTrack.getName(), car.toString(),
1788                                    car.getLoadName(), _train.getName()));
1789                    return false;
1790                }
1791                // does the train accept the car owner from the staging track?
1792                if (!_train.isOwnerNameAccepted(car.getOwnerName())) {
1793                    addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartCarOwner",
1794                            departStageTrack.getName(), car.toString(), car.getOwnerName(), _train.getName()));
1795                    return false;
1796                }
1797                // does the train accept the car built date from the staging
1798                // track?
1799                if (!_train.isBuiltDateAccepted(car.getBuilt())) {
1800                    addLine(_buildReport, THREE, Bundle.getMessage("buildStagingDepartCarBuilt",
1801                            departStageTrack.getName(), car.toString(), car.getBuilt(), _train.getName()));
1802                    return false;
1803                }
1804                // does the car have a destination serviced by this train?
1805                if (car.getDestination() != null) {
1806                    log.debug("Car ({}) has a destination ({}, {})", car.toString(), car.getDestinationName(),
1807                            car.getDestinationTrackName());
1808                    if (!_train.isServiceable(car)) {
1809                        addLine(_buildReport, THREE,
1810                                Bundle.getMessage("buildStagingDepartCarDestination", departStageTrack.getName(),
1811                                        car.toString(), car.getDestinationName(), _train.getName()));
1812                        return false;
1813                    }
1814                }
1815                // is this car a caboose with the correct road for this train?
1816                if (car.isCaboose() &&
1817                        (_train.getCabooseRoad().equals(Train.NONE) ||
1818                                _train.getCabooseRoad().equals(car.getRoadName()))) {
1819                    foundCaboose = true;
1820                }
1821                // is this car have a FRED with the correct road for this train?
1822                if (car.hasFred() &&
1823                        (_train.getCabooseRoad().equals(Train.NONE) ||
1824                                _train.getCabooseRoad().equals(car.getRoadName()))) {
1825                    foundFRED = true;
1826                }
1827            }
1828        }
1829        // does the train require a caboose and did we find one from staging?
1830        if (_train.isCabooseNeeded() && !foundCaboose) {
1831            addLine(_buildReport, THREE,
1832                    Bundle.getMessage("buildStagingNoCaboose", departStageTrack.getName(), _train.getCabooseRoad()));
1833            return false;
1834        }
1835        // does the train require a car with FRED and did we find one from
1836        // staging?
1837        if (_train.isFredNeeded() && !foundFRED) {
1838            addLine(_buildReport, THREE,
1839                    Bundle.getMessage("buildStagingNoCarFRED", departStageTrack.getName(), _train.getCabooseRoad()));
1840            return false;
1841        }
1842        return true;
1843    }
1844
1845    /**
1846     * Used to determine if staging track in a pool is the appropriated one for
1847     * departure. Staging tracks in a pool can operate in one of two ways FIFO
1848     * or LIFO. In FIFO mode (First in First out), the program selects a staging
1849     * track from the pool that has cars with the earliest arrival date. In LIFO
1850     * mode (Last in First out), the program selects a staging track from the
1851     * pool that has cars with the latest arrival date.
1852     *
1853     * @param departStageTrack the track being tested
1854     * @return true if departure on this staging track is possible
1855     */
1856    private boolean checkStagingPool(Track departStageTrack) {
1857        if (departStageTrack.getPool() == null ||
1858                departStageTrack.getServiceOrder().equals(Track.NORMAL) ||
1859                departStageTrack.getNumberCars() == 0) {
1860            return true;
1861        }
1862
1863        addLine(_buildReport, SEVEN, Bundle.getMessage("buildStagingTrackPool", departStageTrack.getName(),
1864                departStageTrack.getPool().getName(), departStageTrack.getPool().getSize(),
1865                departStageTrack.getServiceOrder()));
1866
1867        List<Car> carList = carManager.getAvailableTrainList(_train);
1868        Date carDepartStageTrackDate = null;
1869        for (Car car : carList) {
1870            if (car.getTrack() == departStageTrack) {
1871                carDepartStageTrackDate = car.getLastMoveDate();
1872                break; // use 1st car found
1873            }
1874        }
1875        // next check isn't really necessary, null is never returned
1876        if (carDepartStageTrackDate == null) {
1877            return true; // no cars with found date
1878        }
1879
1880        for (Track track : departStageTrack.getPool().getTracks()) {
1881            if (track == departStageTrack || track.getNumberCars() == 0) {
1882                continue;
1883            }
1884            // determine dates cars arrived into staging
1885            Date carOtherStageTrackDate = null;
1886
1887            for (Car car : carList) {
1888                if (car.getTrack() == track) {
1889                    carOtherStageTrackDate = car.getLastMoveDate();
1890                    break; // use 1st car found
1891                }
1892            }
1893            if (carOtherStageTrackDate != null) {
1894                if (departStageTrack.getServiceOrder().equals(Track.LIFO)) {
1895                    if (carDepartStageTrackDate.before(carOtherStageTrackDate)) {
1896                        addLine(_buildReport, SEVEN,
1897                                Bundle.getMessage("buildStagingCarsBefore", departStageTrack.getName(),
1898                                        track.getName()));
1899                        return false;
1900                    }
1901                } else {
1902                    if (carOtherStageTrackDate.before(carDepartStageTrackDate)) {
1903                        addLine(_buildReport, SEVEN, Bundle.getMessage("buildStagingCarsBefore", track.getName(),
1904                                departStageTrack.getName()));
1905                        return false;
1906                    }
1907                }
1908            }
1909        }
1910        return true;
1911    }
1912
1913    /**
1914     * Checks to see if staging track can accept train.
1915     *
1916     * @param terminateStageTrack the staging track
1917     * @return true if staging track is empty, not reserved, and accepts car and
1918     *         engine types, roads, and loads.
1919     */
1920    protected boolean checkTerminateStagingTrack(Track terminateStageTrack) {
1921        if (!terminateStageTrack.isDropTrainAccepted(_train)) {
1922            addLine(_buildReport, FIVE, Bundle.getMessage("buildStagingNotTrain", terminateStageTrack.getName()));
1923            return false;
1924        }
1925        // In normal mode, find a completely empty track. In aggressive mode, a
1926        // track that scheduled to depart is okay
1927        if (((!Setup.isBuildAggressive() || !Setup.isStagingTrackImmediatelyAvail()) &&
1928                terminateStageTrack.getNumberRS() != 0) ||
1929                terminateStageTrack.getNumberRS() != terminateStageTrack.getPickupRS()) {
1930            addLine(_buildReport, FIVE,
1931                    Bundle.getMessage("buildStagingTrackOccupied", terminateStageTrack.getName(),
1932                            terminateStageTrack.getNumberEngines(), terminateStageTrack.getNumberCars()));
1933            if (terminateStageTrack.getIgnoreUsedLengthPercentage() == Track.IGNORE_0) {
1934                return false;
1935            } else {
1936                addLine(_buildReport, FIVE,
1937                        Bundle.getMessage("buildTrackHasPlannedPickups", terminateStageTrack.getName(),
1938                                terminateStageTrack.getIgnoreUsedLengthPercentage(), terminateStageTrack.getLength(),
1939                                Setup.getLengthUnit().toLowerCase(), terminateStageTrack.getUsedLength(),
1940                                terminateStageTrack.getReserved(),
1941                                terminateStageTrack.getReservedLengthSetouts(),
1942                                terminateStageTrack.getReservedLengthSetouts() - terminateStageTrack.getReserved(),
1943                                terminateStageTrack.getAvailableTrackSpace()));
1944            }
1945        }
1946        if (terminateStageTrack.getDropRS() != 0) {
1947            addLine(_buildReport, FIVE, Bundle.getMessage("buildStagingTrackReserved", terminateStageTrack.getName(),
1948                    terminateStageTrack.getDropRS()));
1949            return false;
1950        }
1951        if (terminateStageTrack.getPickupRS() > 0) {
1952            addLine(_buildReport, FIVE, Bundle.getMessage("buildStagingTrackDepart", terminateStageTrack.getName()));
1953        }
1954        // if track is setup to accept a specific train or route, then ignore
1955        // other track restrictions
1956        if (terminateStageTrack.getDropOption().equals(Track.TRAINS) ||
1957                terminateStageTrack.getDropOption().equals(Track.ROUTES)) {
1958            addLine(_buildReport, SEVEN,
1959                    Bundle.getMessage("buildTrainCanTerminateTrack", _train.getName(), terminateStageTrack.getName()));
1960            return true; // train can drop to this track, ignore other track
1961                         // restrictions
1962        }
1963        if (!Setup.isStagingTrainCheckEnabled()) {
1964            addLine(_buildReport, SEVEN,
1965                    Bundle.getMessage("buildTrainCanTerminateTrack", _train.getName(), terminateStageTrack.getName()));
1966            return true;
1967        } else if (!checkTerminateStagingTrackRestrictions(terminateStageTrack)) {
1968            addLine(_buildReport, SEVEN,
1969                    Bundle.getMessage("buildStagingTrackRestriction", terminateStageTrack.getName(), _train.getName()));
1970            addLine(_buildReport, SEVEN, Bundle.getMessage("buildOptionRestrictStaging"));
1971            return false;
1972        }
1973        return true;
1974    }
1975
1976    private boolean checkTerminateStagingTrackRestrictions(Track terminateStageTrack) {
1977        // check go see if location/track will accept the train's car and engine
1978        // types
1979        for (String name : _train.getTypeNames()) {
1980            if (!_terminateLocation.acceptsTypeName(name)) {
1981                addLine(_buildReport, FIVE,
1982                        Bundle.getMessage("buildDestinationType", _terminateLocation.getName(), name));
1983                return false;
1984            }
1985            if (!terminateStageTrack.isTypeNameAccepted(name)) {
1986                addLine(_buildReport, FIVE,
1987                        Bundle.getMessage("buildStagingTrackType", terminateStageTrack.getLocation().getName(),
1988                                terminateStageTrack.getName(), name));
1989                return false;
1990            }
1991        }
1992        // check go see if track will accept the train's car roads
1993        if (_train.getCarRoadOption().equals(Train.ALL_ROADS) &&
1994                !terminateStageTrack.getRoadOption().equals(Track.ALL_ROADS)) {
1995            addLine(_buildReport, FIVE, Bundle.getMessage("buildStagingTrackAllRoads", terminateStageTrack.getName()));
1996            return false;
1997        }
1998        // now determine if roads accepted by train are also accepted by staging
1999        // track
2000        // TODO should we be checking caboose and loco road names?
2001        for (String road : InstanceManager.getDefault(CarRoads.class).getNames()) {
2002            if (_train.isCarRoadNameAccepted(road)) {
2003                if (!terminateStageTrack.isRoadNameAccepted(road)) {
2004                    addLine(_buildReport, FIVE,
2005                            Bundle.getMessage("buildStagingTrackRoad", terminateStageTrack.getLocation().getName(),
2006                                    terminateStageTrack.getName(), road));
2007                    return false;
2008                }
2009            }
2010        }
2011
2012        // determine if staging will accept loads carried by train
2013        if (_train.getLoadOption().equals(Train.ALL_LOADS) &&
2014                !terminateStageTrack.getLoadOption().equals(Track.ALL_LOADS)) {
2015            addLine(_buildReport, FIVE, Bundle.getMessage("buildStagingTrackAllLoads", terminateStageTrack.getName()));
2016            return false;
2017        }
2018        // get all of the types and loads that a train can carry, and determine
2019        // if staging will accept
2020        for (String type : _train.getTypeNames()) {
2021            for (String load : carLoads.getNames(type)) {
2022                if (_train.isLoadNameAccepted(load, type)) {
2023                    if (!terminateStageTrack.isLoadNameAndCarTypeAccepted(load, type)) {
2024                        addLine(_buildReport, FIVE,
2025                                Bundle.getMessage("buildStagingTrackLoad", terminateStageTrack.getLocation().getName(),
2026                                terminateStageTrack.getName(), type + CarLoad.SPLIT_CHAR + load));
2027                        return false;
2028                    }
2029                }
2030            }
2031        }
2032        addLine(_buildReport, SEVEN,
2033                Bundle.getMessage("buildTrainCanTerminateTrack", _train.getName(), terminateStageTrack.getName()));
2034        return true;
2035    }
2036
2037    boolean routeToTrackFound;
2038
2039    protected boolean checkBasicMoves(Car car, Track track) {
2040        if (car.getTrack() == track) {
2041            return false;
2042        }
2043        // don't allow local move to track with a "similar" name
2044        if (car.getSplitLocationName().equals(track.getLocation().getSplitName()) &&
2045                car.getSplitTrackName().equals(track.getSplitName())) {
2046            return false;
2047        }
2048        if (track.isStaging() && car.getLocation() == track.getLocation()) {
2049            return false; // don't use same staging location
2050        }
2051        // is the car's destination the terminal and is that allowed?
2052        if (!checkThroughCarsAllowed(car, track.getLocation().getName())) {
2053            return false;
2054        }
2055        if (!checkLocalMovesAllowed(car, track)) {
2056            return false;
2057        }
2058        return true;
2059    }
2060
2061    /**
2062     * Used when generating a car load from staging.
2063     *
2064     * @param car   the car.
2065     * @param track the car's destination track that has the schedule.
2066     * @return ScheduleItem si if match found, null otherwise.
2067     * @throws BuildFailedException if schedule doesn't have any line items
2068     */
2069    protected ScheduleItem getScheduleItem(Car car, Track track) throws BuildFailedException {
2070        if (track.getSchedule() == null) {
2071            return null;
2072        }
2073        if (!track.isTypeNameAccepted(car.getTypeName())) {
2074            log.debug("Track ({}) doesn't service car type ({})", track.getName(), car.getTypeName());
2075            if (!Setup.getRouterBuildReportLevel().equals(Setup.BUILD_REPORT_NORMAL)) {
2076                addLine(_buildReport, SEVEN,
2077                        Bundle.getMessage("buildSpurNotThisType", track.getLocation().getName(), track.getName(),
2078                                track.getScheduleName(), car.getTypeName()));
2079            }
2080            return null;
2081        }
2082        ScheduleItem si = null;
2083        if (track.getScheduleMode() == Track.SEQUENTIAL) {
2084            si = track.getCurrentScheduleItem();
2085            // code check
2086            if (si == null) {
2087                throw new BuildFailedException(Bundle.getMessage("buildErrorNoScheduleItem", track.getScheduleItemId(),
2088                        track.getScheduleName(), track.getName(), track.getLocation().getName()));
2089            }
2090            return checkScheduleItem(si, car, track);
2091        }
2092        log.debug("Track ({}) in match mode", track.getName());
2093        // go through entire schedule looking for a match
2094        for (int i = 0; i < track.getSchedule().getSize(); i++) {
2095            si = track.getNextScheduleItem();
2096            // code check
2097            if (si == null) {
2098                throw new BuildFailedException(Bundle.getMessage("buildErrorNoScheduleItem", track.getScheduleItemId(),
2099                        track.getScheduleName(), track.getName(), track.getLocation().getName()));
2100            }
2101            si = checkScheduleItem(si, car, track);
2102            if (si != null) {
2103                break;
2104            }
2105        }
2106        return si;
2107    }
2108
2109    /**
2110     * Used when generating a car load from staging. Checks a schedule item to
2111     * see if the car type matches, and the train and track can service the
2112     * schedule item's load. This code doesn't check to see if the car's load
2113     * can be serviced by the schedule. Instead a schedule item is returned that
2114     * allows the program to assign a custom load to the car that matches a
2115     * schedule item. Therefore, schedule items that don't request a custom load
2116     * are ignored.
2117     *
2118     * @param si    the schedule item
2119     * @param car   the car to check
2120     * @param track the destination track
2121     * @return Schedule item si if okay, null otherwise.
2122     */
2123    private ScheduleItem checkScheduleItem(ScheduleItem si, Car car, Track track) {
2124        if (!car.getTypeName().equals(si.getTypeName()) ||
2125                si.getReceiveLoadName().equals(ScheduleItem.NONE) ||
2126                si.getReceiveLoadName().equals(carLoads.getDefaultEmptyName()) ||
2127                si.getReceiveLoadName().equals(carLoads.getDefaultLoadName())) {
2128            log.debug("Not using track ({}) schedule request type ({}) road ({}) load ({})", track.getName(),
2129                    si.getTypeName(), si.getRoadName(), si.getReceiveLoadName()); // NOI18N
2130            if (!Setup.getRouterBuildReportLevel().equals(Setup.BUILD_REPORT_NORMAL)) {
2131                addLine(_buildReport, SEVEN,
2132                        Bundle.getMessage("buildSpurScheduleNotUsed", track.getLocation().getName(), track.getName(),
2133                                track.getScheduleName(), si.getId(), track.getScheduleModeName().toLowerCase(),
2134                                si.getTypeName(), si.getRoadName(), si.getReceiveLoadName()));
2135            }
2136            return null;
2137        }
2138        if (!si.getRoadName().equals(ScheduleItem.NONE) && !car.getRoadName().equals(si.getRoadName())) {
2139            log.debug("Not using track ({}) schedule request type ({}) road ({}) load ({})", track.getName(),
2140                    si.getTypeName(), si.getRoadName(), si.getReceiveLoadName()); // NOI18N
2141            if (!Setup.getRouterBuildReportLevel().equals(Setup.BUILD_REPORT_NORMAL)) {
2142                addLine(_buildReport, SEVEN,
2143                        Bundle.getMessage("buildSpurScheduleNotUsed", track.getLocation().getName(), track.getName(),
2144                                track.getScheduleName(), si.getId(), track.getScheduleModeName().toLowerCase(),
2145                                si.getTypeName(), si.getRoadName(), si.getReceiveLoadName()));
2146            }
2147            return null;
2148        }
2149        if (!_train.isLoadNameAccepted(si.getReceiveLoadName(), si.getTypeName())) {
2150            addLine(_buildReport, SEVEN, Bundle.getMessage("buildTrainNotNewLoad", _train.getName(),
2151                    si.getReceiveLoadName(), track.getLocation().getName(), track.getName()));
2152            return null;
2153        }
2154        // does the departure track allow this load?
2155        if (!car.getTrack().isLoadNameAndCarTypeShipped(si.getReceiveLoadName(), car.getTypeName())) {
2156            addLine(_buildReport, SEVEN,
2157                    Bundle.getMessage("buildTrackNotLoadSchedule", car.getTrackName(), si.getReceiveLoadName(),
2158                            track.getLocation().getName(), track.getName(), si.getId()));
2159            return null;
2160        }
2161        if (!si.getSetoutTrainScheduleId().equals(ScheduleItem.NONE) &&
2162                !trainScheduleManager.getTrainScheduleActiveId().equals(si.getSetoutTrainScheduleId())) {
2163            log.debug("Schedule item isn't active");
2164            // build the status message
2165            TrainSchedule aSch = trainScheduleManager.getScheduleById(trainScheduleManager.getTrainScheduleActiveId());
2166            TrainSchedule tSch = trainScheduleManager.getScheduleById(si.getSetoutTrainScheduleId());
2167            String aName = "";
2168            String tName = "";
2169            if (aSch != null) {
2170                aName = aSch.getName();
2171            }
2172            if (tSch != null) {
2173                tName = tSch.getName();
2174            }
2175            addLine(_buildReport, SEVEN,
2176                    Bundle.getMessage("buildScheduleNotActive", track.getName(), si.getId(), tName, aName));
2177
2178            return null;
2179        }
2180        if (!si.getRandom().equals(ScheduleItem.NONE)) {
2181            if (!si.doRandom()) {
2182                addLine(_buildReport, SEVEN,
2183                        Bundle.getMessage("buildScheduleRandom", track.getLocation().getName(), track.getName(),
2184                                track.getScheduleName(), si.getId(), si.getReceiveLoadName(), si.getRandom(),
2185                                si.getCalculatedRandom()));
2186                return null;
2187            }
2188        }
2189        log.debug("Found track ({}) schedule item id ({}) for car ({})", track.getName(), si.getId(), car.toString());
2190        return si;
2191    }
2192
2193    protected void showCarServiceOrder(Car car) {
2194        if (!car.getTrack().getServiceOrder().equals(Track.NORMAL) && !car.getTrack().isStaging()) {
2195            addLine(_buildReport, SEVEN,
2196                    Bundle.getMessage("buildTrackModePriority", car.toString(), car.getTrack().getTrackTypeName(),
2197                            car.getLocationName(), car.getTrackName(), car.getTrack().getServiceOrder(),
2198                            car.getLastDate()));
2199        }
2200    }
2201
2202    /**
2203     * Returns a list containing two tracks. The 1st track found for the car,
2204     * the 2nd track is the car's final destination if an alternate track was
2205     * used for the car. 2nd track can be null.
2206     *
2207     * @param car The car needing a destination track
2208     * @param rld the RouteLocation destination
2209     * @return List containing up to two tracks. No tracks if none found.
2210     */
2211    protected List<Track> getTracksAtDestination(Car car, RouteLocation rld) {
2212        List<Track> tracks = new ArrayList<>();
2213        Location testDestination = rld.getLocation();
2214        // first report if there are any alternate tracks
2215        for (Track track : testDestination.getTracksByNameList(null)) {
2216            if (track.isAlternate()) {
2217                addLine(_buildReport, SEVEN, Bundle.getMessage("buildTrackIsAlternate", car.toString(),
2218                        track.getTrackTypeName(), track.getLocation().getName(), track.getName()));
2219            }
2220        }
2221        // now find a track for this car
2222        for (Track testTrack : testDestination.getTracksByMoves(null)) {
2223            // normally don't move car to a track with the same name at the same
2224            // location
2225            if (car.getSplitLocationName().equals(testTrack.getLocation().getSplitName()) &&
2226                    car.getSplitTrackName().equals(testTrack.getSplitName()) &&
2227                    !car.isPassenger() &&
2228                    !car.isCaboose() &&
2229                    !car.hasFred()) {
2230                addLine(_buildReport, SEVEN,
2231                        Bundle.getMessage("buildCanNotDropCarSameTrack", car.toString(), testTrack.getName()));
2232                continue;
2233            }
2234            // Can the train service this track?
2235            if (!checkDropTrainDirection(car, rld, testTrack)) {
2236                continue;
2237            }
2238            // drop to interchange or spur?
2239            if (!checkTrainCanDrop(car, testTrack)) {
2240                continue;
2241            }
2242            // report if track has planned pickups
2243            if (testTrack.getIgnoreUsedLengthPercentage() > Track.IGNORE_0) {
2244                addLine(_buildReport, SEVEN,
2245                        Bundle.getMessage("buildTrackHasPlannedPickups", testTrack.getName(),
2246                                testTrack.getIgnoreUsedLengthPercentage(), testTrack.getLength(),
2247                                Setup.getLengthUnit().toLowerCase(), testTrack.getUsedLength(), testTrack.getReserved(),
2248                                testTrack.getReservedLengthSetouts(),
2249                                testTrack.getReservedLengthPickups(),
2250                                testTrack.getAvailableTrackSpace()));
2251            }
2252            String status = car.checkDestination(testDestination, testTrack);
2253            // Can be a caboose or car with FRED with a custom load
2254            // is the destination a spur with a schedule demanding this car's
2255            // custom load?
2256            if (status.equals(Track.OKAY) &&
2257                    !testTrack.getScheduleId().equals(Track.NONE) &&
2258                    !car.getLoadName().equals(carLoads.getDefaultEmptyName()) &&
2259                    !car.getLoadName().equals(carLoads.getDefaultLoadName())) {
2260                addLine(_buildReport, FIVE,
2261                        Bundle.getMessage("buildSpurScheduleLoad", testTrack.getName(), car.getLoadName()));
2262            }
2263            // check to see if alternate track is available if track full
2264            if (status.startsWith(Track.LENGTH)) {
2265                addLine(_buildReport, SEVEN,
2266                        Bundle.getMessage("buildCanNotDropCarBecause", car.toString(), testTrack.getTrackTypeName(),
2267                                testTrack.getLocation().getName(), testTrack.getName(), status));
2268                if (checkForAlternate(car, testTrack)) {
2269                    // send car to alternate track
2270                    tracks.add(testTrack.getAlternateTrack());
2271                    tracks.add(testTrack); // car's final destination
2272                    break; // done with this destination
2273                }
2274                continue;
2275            }
2276            // check for train timing
2277            if (status.equals(Track.OKAY)) {
2278                status = checkReserved(_train, rld, car, testTrack, true);
2279                if (status.equals(TIMING) && checkForAlternate(car, testTrack)) {
2280                    // send car to alternate track
2281                    tracks.add(testTrack.getAlternateTrack());
2282                    tracks.add(testTrack); // car's final destination
2283                    break; // done with this destination
2284                }
2285            }
2286            // okay to drop car?
2287            if (!status.equals(Track.OKAY)) {
2288                addLine(_buildReport, SEVEN,
2289                        Bundle.getMessage("buildCanNotDropCarBecause", car.toString(), testTrack.getTrackTypeName(),
2290                                testTrack.getLocation().getName(), testTrack.getName(), status));
2291                continue;
2292            }
2293            if (!checkForLocalMove(car, testTrack)) {
2294                continue;
2295            }
2296            tracks.add(testTrack);
2297            tracks.add(null); // no final destination for this car
2298            break; // done with this destination
2299        }
2300        return tracks;
2301    }
2302
2303    /**
2304     * Checks to see if track has an alternate and can be used
2305     * 
2306     * @param car       the car being dropped
2307     * @param testTrack the destination track
2308     * @return true if track has an alternate and can be used
2309     */
2310    protected boolean checkForAlternate(Car car, Track testTrack) {
2311        if (testTrack.getAlternateTrack() != null &&
2312                car.getTrack() != testTrack.getAlternateTrack() &&
2313                checkTrainCanDrop(car, testTrack.getAlternateTrack())) {
2314            addLine(_buildReport, SEVEN,
2315                    Bundle.getMessage("buildTrackFullHasAlternate", testTrack.getLocation().getName(),
2316                            testTrack.getName(), testTrack.getAlternateTrack().getName()));
2317            String status = car.checkDestination(testTrack.getLocation(), testTrack.getAlternateTrack());
2318            if (status.equals(Track.OKAY)) {
2319                return true;
2320            }
2321            addLine(_buildReport, SEVEN,
2322                    Bundle.getMessage("buildCanNotDropCarBecause", car.toString(),
2323                            testTrack.getAlternateTrack().getTrackTypeName(),
2324                            testTrack.getLocation().getName(), testTrack.getAlternateTrack().getName(),
2325                            status));
2326        }
2327        return false;
2328    }
2329
2330    /**
2331     * Used to determine if car could be set out at earlier location in the
2332     * train's route.
2333     *
2334     * @param car       The car
2335     * @param trackTemp The destination track for this car
2336     * @param rld       Where in the route the destination track was found
2337     * @param start     Where to begin the check
2338     * @param routeEnd  Where to stop the check
2339     * @return The best RouteLocation to drop off the car
2340     */
2341    protected RouteLocation checkForEarlierDrop(Car car, Track trackTemp, RouteLocation rld, int start, int routeEnd) {
2342        for (int m = start; m < routeEnd; m++) {
2343            RouteLocation rle = _routeList.get(m);
2344            if (rle == rld) {
2345                break;
2346            }
2347            if (rle.getName().equals(rld.getName()) &&
2348                    (rle.getCarMoves() < rle.getMaxCarMoves()) &&
2349                    rle.isDropAllowed() &&
2350                    checkDropTrainDirection(car, rle, trackTemp)) {
2351                log.debug("Found an earlier drop for car ({}) destination ({})", car.toString(), rle.getName()); // NOI18N
2352                return rle; // earlier drop in train's route
2353            }
2354        }
2355        return rld;
2356    }
2357
2358    /*
2359     * Determines if rolling stock can be delivered to track when considering
2360     * timing of car pulls by other trains.
2361     */
2362    protected String checkReserved(Train train, RouteLocation rld, Car car, Track destTrack, boolean printMsg) {
2363        // car returning to same track?
2364        if (car.getTrack() != destTrack) {
2365            // car can be a kernel so get total length
2366            int length = car.getTotalKernelLength();
2367            log.debug("Car length: {}, available track space: {}, reserved: {}", length,
2368                    destTrack.getAvailableTrackSpace(), destTrack.getReserved());
2369            if (length > destTrack.getAvailableTrackSpace() +
2370                    destTrack.getReserved()) {
2371                boolean returned = false;
2372                String trainExpectedArrival = train.getExpectedArrivalTime(rld, true);
2373                int trainArrivalTimeMinutes = convertStringTime(trainExpectedArrival);
2374                int reservedReturned = 0;
2375                // does this car already have this destination?
2376                if (car.getDestinationTrack() == destTrack) {
2377                    reservedReturned = -car.getTotalKernelLength();
2378                }
2379                // get a list of cars on this track
2380                List<Car> cars = carManager.getList(destTrack);
2381                for (Car kar : cars) {
2382                    if (kar.getTrain() != null && kar.getTrain() != train) {
2383                        int carPullTime = convertStringTime(kar.getPickupTime());
2384                        if (trainArrivalTimeMinutes < carPullTime) {
2385                            // don't print if checking redirect to alternate
2386                            if (printMsg) {
2387                                addLine(_buildReport, SEVEN,
2388                                        Bundle.getMessage("buildCarTrainTiming", kar.toString(),
2389                                                kar.getTrack().getTrackTypeName(), kar.getLocationName(),
2390                                                kar.getTrackName(), kar.getTrainName(), kar.getPickupTime(),
2391                                                _train.getName(), trainExpectedArrival));
2392                            }
2393                            reservedReturned += kar.getTotalLength();
2394                            returned = true;
2395                        }
2396                    }
2397                }
2398                if (returned && length > destTrack.getAvailableTrackSpace() - reservedReturned) {
2399                    if (printMsg) {
2400                        addLine(_buildReport, SEVEN,
2401                                Bundle.getMessage("buildWarnTrainTiming", car.toString(), destTrack.getTrackTypeName(),
2402                                        destTrack.getLocation().getName(), destTrack.getName(), _train.getName(),
2403                                        destTrack.getAvailableTrackSpace() - reservedReturned,
2404                                        Setup.getLengthUnit().toLowerCase()));
2405                    }
2406                    return TIMING;
2407                }
2408            }
2409        }
2410        return Track.OKAY;
2411    }
2412
2413    /**
2414     * Checks to see if local move is allowed for this car
2415     *
2416     * @param car       the car being moved
2417     * @param testTrack the destination track for this car
2418     * @return false if local move not allowed
2419     */
2420    private boolean checkForLocalMove(Car car, Track testTrack) {
2421        if (_train.isLocalSwitcher()) {
2422            // No local moves from spur to spur
2423            if (!Setup.isLocalSpurMovesEnabled() && testTrack.isSpur() && car.getTrack().isSpur()) {
2424                addLine(_buildReport, SEVEN,
2425                        Bundle.getMessage("buildNoSpurToSpurMove", car.getTrackName(), testTrack.getName()));
2426                return false;
2427            }
2428            // No local moves from yard to yard, except for cabooses and cars
2429            // with FRED
2430            if (!Setup.isLocalYardMovesEnabled() &&
2431                    testTrack.isYard() &&
2432                    car.getTrack().isYard() &&
2433                    !car.isCaboose() &&
2434                    !car.hasFred()) {
2435                addLine(_buildReport, SEVEN,
2436                        Bundle.getMessage("buildNoYardToYardMove", car.getTrackName(), testTrack.getName()));
2437                return false;
2438            }
2439            // No local moves from interchange to interchange
2440            if (!Setup.isLocalInterchangeMovesEnabled() &&
2441                    testTrack.isInterchange() &&
2442                    car.getTrack().isInterchange()) {
2443                addLine(_buildReport, SEVEN,
2444                        Bundle.getMessage("buildNoInterchangeToInterchangeMove", car.getTrackName(),
2445                                testTrack.getName()));
2446                return false;
2447            }
2448        }
2449        return true;
2450    }
2451
2452    protected Track tryStaging(Car car, RouteLocation rldSave) throws BuildFailedException {
2453        // local switcher working staging?
2454        if (_train.isLocalSwitcher() &&
2455                !car.isPassenger() &&
2456                !car.isCaboose() &&
2457                !car.hasFred() &&
2458                car.getTrack() == _terminateStageTrack) {
2459            addLine(_buildReport, SEVEN,
2460                    Bundle.getMessage("buildCanNotDropCarSameTrack", car.toString(), car.getTrack().getName()));
2461            return null;
2462        }
2463        // no need to check train and track direction into staging, already done
2464        String status = car.checkDestination(_terminateStageTrack.getLocation(), _terminateStageTrack);
2465        if (status.equals(Track.OKAY)) {
2466            return _terminateStageTrack;
2467            // only generate a new load if there aren't any other tracks
2468            // available for this car
2469        } else if (status.startsWith(Track.LOAD) &&
2470                car.getTrack() == _departStageTrack &&
2471                car.getLoadName().equals(carLoads.getDefaultEmptyName()) &&
2472                rldSave == null &&
2473                (_departStageTrack.isAddCustomLoadsAnyStagingTrackEnabled() ||
2474                        _departStageTrack.isAddCustomLoadsEnabled() ||
2475                        _departStageTrack.isAddCustomLoadsAnySpurEnabled())) {
2476            // try and generate a load for this car into staging
2477            if (generateLoadCarDepartingAndTerminatingIntoStaging(car, _terminateStageTrack)) {
2478                return _terminateStageTrack;
2479            }
2480        }
2481        addLine(_buildReport, SEVEN,
2482                Bundle.getMessage("buildCanNotDropCarBecause", car.toString(), _terminateStageTrack.getTrackTypeName(),
2483                        _terminateStageTrack.getLocation().getName(), _terminateStageTrack.getName(), status));
2484        return null;
2485    }
2486
2487    /**
2488     * Returns true if car can be picked up later in a train's route
2489     *
2490     * @param car the car
2491     * @param rl  car's route location
2492     * @param rld car's route location destination
2493     * @return true if car can be picked up later in a train's route
2494     * @throws BuildFailedException if coding issue
2495     */
2496    protected boolean checkForLaterPickUp(Car car, RouteLocation rl, RouteLocation rld) throws BuildFailedException {
2497        // is there another pick up location in the route?
2498        if (rl == rld || !rld.getName().equals(car.getLocationName())) {
2499            return false;
2500        }
2501        // don't delay adding a caboose, passenger car, or car with FRED
2502        if (car.isCaboose() || car.isPassenger() || car.hasFred()) {
2503            return false;
2504        }
2505        // no later pick up if car is departing staging
2506        if (car.getLocation().isStaging()) {
2507            return false;
2508        }
2509        if (!checkPickUpTrainDirection(car, rld)) {
2510            addLine(_buildReport, SEVEN,
2511                    Bundle.getMessage("buildNoPickupLaterDirection", car.toString(), rld.getName(), rld.getId()));
2512            return false;
2513        }
2514        if (!rld.isPickUpAllowed() && !rld.isLocalMovesAllowed() ||
2515                !rld.isPickUpAllowed() && rld.isLocalMovesAllowed() && !car.isLocalMove()) {
2516            addLine(_buildReport, SEVEN,
2517                    Bundle.getMessage("buildNoPickupLater", car.toString(), rld.getName(), rld.getId()));
2518            return false;
2519        }
2520        if (rld.getCarMoves() >= rld.getMaxCarMoves()) {
2521            addLine(_buildReport, SEVEN,
2522                    Bundle.getMessage("buildNoPickupLaterMoves", car.toString(), rld.getName(), rld.getId()));
2523            return false;
2524        }
2525        // is the track full? If so, pull immediately, prevents overloading
2526        if (car.getTrack().getLength() - car.getTrack().getUsedLength() < car.getTotalKernelLength()) {
2527            addLine(_buildReport, SEVEN, Bundle.getMessage("buildNoPickupLaterTrack", car.toString(), rld.getName(),
2528                    car.getTrackName(), rld.getId(), car.getTrack().getLength() - car.getTrack().getUsedLength(),
2529                    Setup.getLengthUnit().toLowerCase()));
2530            return false;
2531        }
2532        addLine(_buildReport, SEVEN,
2533                Bundle.getMessage("buildPickupLaterOkay", car.toString(), rld.getName(), rld.getId()));
2534        return true;
2535    }
2536
2537    /**
2538     * Returns true is cars are allowed to travel from origin to terminal
2539     *
2540     * @param car             The car
2541     * @param destinationName Destination name for this car
2542     * @return true if through cars are allowed. false if not.
2543     */
2544    protected boolean checkThroughCarsAllowed(Car car, String destinationName) {
2545        if (!_train.isAllowThroughCarsEnabled() &&
2546                !_train.isLocalSwitcher() &&
2547                !car.isCaboose() &&
2548                !car.hasFred() &&
2549                !car.isPassenger() &&
2550                car.getSplitLocationName().equals(_departLocation.getSplitName()) &&
2551                splitString(destinationName).equals(_terminateLocation.getSplitName()) &&
2552                !_departLocation.getSplitName().equals(_terminateLocation.getSplitName())) {
2553            addLine(_buildReport, FIVE, Bundle.getMessage("buildThroughTrafficNotAllow", _departLocation.getName(),
2554                    _terminateLocation.getName()));
2555            return false; // through cars not allowed
2556        }
2557        return true; // through cars allowed
2558    }
2559
2560    private boolean checkLocalMovesAllowed(Car car, Track track) {
2561        if (!_train.isLocalSwitcher() &&
2562                !_train.isAllowLocalMovesEnabled() &&
2563                car.getSplitLocationName().equals(track.getLocation().getSplitName())) {
2564            addLine(_buildReport, SEVEN,
2565                    Bundle.getMessage("buildNoLocalMoveToTrack", car.getLocationName(), car.getTrackName(),
2566                            track.getLocation().getName(), track.getName(), _train.getName()));
2567            return false;
2568        }
2569        return true;
2570    }
2571
2572    /**
2573     * Creates a car load for a car departing staging and eventually terminating
2574     * into staging.
2575     *
2576     * @param car        the car!
2577     * @param stageTrack the staging track the car will terminate to
2578     * @return true if a load was generated this this car.
2579     * @throws BuildFailedException if coding check fails
2580     */
2581    protected boolean generateLoadCarDepartingAndTerminatingIntoStaging(Car car, Track stageTrack)
2582            throws BuildFailedException {
2583        addLine(_buildReport, SEVEN, BLANK_LINE);
2584        // code check
2585        if (stageTrack == null || !stageTrack.isStaging()) {
2586            throw new BuildFailedException("ERROR coding issue, staging track null or not staging");
2587        }
2588        if (!stageTrack.isTypeNameAccepted(car.getTypeName())) {
2589            addLine(_buildReport, SEVEN,
2590                    Bundle.getMessage("buildStagingTrackType", stageTrack.getLocation().getName(), stageTrack.getName(),
2591                            car.getTypeName()));
2592            return false;
2593        }
2594        if (!stageTrack.isRoadNameAccepted(car.getRoadName())) {
2595            addLine(_buildReport, SEVEN,
2596                    Bundle.getMessage("buildStagingTrackRoad", stageTrack.getLocation().getName(), stageTrack.getName(),
2597                            car.getRoadName()));
2598            return false;
2599        }
2600        // Departing and returning to same location in staging?
2601        if (!_train.isAllowReturnToStagingEnabled() &&
2602                !Setup.isStagingAllowReturnEnabled() &&
2603                !car.isCaboose() &&
2604                !car.hasFred() &&
2605                !car.isPassenger() &&
2606                car.getSplitLocationName().equals(stageTrack.getLocation().getSplitName())) {
2607            addLine(_buildReport, SEVEN,
2608                    Bundle.getMessage("buildNoReturnStaging", car.toString(), stageTrack.getLocation().getName()));
2609            return false;
2610        }
2611        // figure out which loads the car can use
2612        List<String> loads = carLoads.getNames(car.getTypeName());
2613        // remove the default names
2614        loads.remove(carLoads.getDefaultEmptyName());
2615        loads.remove(carLoads.getDefaultLoadName());
2616        if (loads.size() == 0) {
2617            log.debug("No custom loads for car type ({}) ignoring staging track ({})", car.getTypeName(),
2618                    stageTrack.getName());
2619            return false;
2620        }
2621        addLine(_buildReport, SEVEN,
2622                Bundle.getMessage("buildSearchTrackLoadStaging", car.toString(), car.getTypeName(),
2623                        car.getLoadType().toLowerCase(), car.getLoadName(), car.getLocationName(), car.getTrackName(),
2624                        stageTrack.getLocation().getName(), stageTrack.getName()));
2625        String oldLoad = car.getLoadName(); // save car's "E" load
2626        for (int i = loads.size() - 1; i >= 0; i--) {
2627            String load = loads.get(i);
2628            log.debug("Try custom load ({}) for car ({})", load, car.toString());
2629            if (!car.getTrack().isLoadNameAndCarTypeShipped(load, car.getTypeName()) ||
2630                    !stageTrack.isLoadNameAndCarTypeAccepted(load, car.getTypeName()) ||
2631                    !_train.isLoadNameAccepted(load, car.getTypeName())) {
2632                // report why the load was rejected and remove it from consideration
2633                if (!car.getTrack().isLoadNameAndCarTypeShipped(load, car.getTypeName())) {
2634                    addLine(_buildReport, SEVEN,
2635                            Bundle.getMessage("buildTrackNotNewLoad", car.getTrackName(), load,
2636                                    stageTrack.getLocation().getName(), stageTrack.getName()));
2637                }
2638                if (!stageTrack.isLoadNameAndCarTypeAccepted(load, car.getTypeName())) {
2639                    addLine(_buildReport, SEVEN,
2640                            Bundle.getMessage("buildDestTrackNoLoad", stageTrack.getLocation().getName(),
2641                                    stageTrack.getName(), car.toString(), load));
2642                }
2643                if (!_train.isLoadNameAccepted(load, car.getTypeName())) {
2644                    addLine(_buildReport, SEVEN,
2645                            Bundle.getMessage("buildTrainNotNewLoad", _train.getName(), load,
2646                                    stageTrack.getLocation().getName(), stageTrack.getName()));
2647                }
2648                loads.remove(i);
2649                continue;
2650            }
2651            car.setLoadName(load);
2652            // does the car have a home division?
2653            if (car.getDivision() != null) {
2654                addLine(_buildReport, SEVEN,
2655                        Bundle.getMessage("buildCarHasDivisionStaging", car.toString(), car.getTypeName(),
2656                                car.getLoadType().toLowerCase(), car.getLoadName(), car.getDivisionName(),
2657                                car.getLocationName(),
2658                                car.getTrackName(), car.getTrack().getDivisionName()));
2659                // load type empty must return to car's home division
2660                // or load type load from foreign division must return to car's
2661                // home division
2662                if (car.getLoadType().equals(CarLoad.LOAD_TYPE_EMPTY) &&
2663                        car.getDivision() != stageTrack.getDivision() ||
2664                        car.getLoadType().equals(CarLoad.LOAD_TYPE_LOAD) &&
2665                                car.getTrack().getDivision() != car.getDivision() &&
2666                                car.getDivision() != stageTrack.getDivision()) {
2667                    addLine(_buildReport, SEVEN,
2668                            Bundle.getMessage("buildNoDivisionTrack", stageTrack.getTrackTypeName(),
2669                                    stageTrack.getLocation().getName(), stageTrack.getName(),
2670                                    stageTrack.getDivisionName(), car.toString(),
2671                                    car.getLoadType().toLowerCase(), car.getLoadName()));
2672                    loads.remove(i);
2673                    continue;
2674                }
2675            }
2676        }
2677        // do we need to test all car loads?
2678        boolean loadRestrictions = isLoadRestrictions();
2679        // now determine if the loads can be routed to the staging track
2680        for (int i = loads.size() - 1; i >= 0; i--) {
2681            String load = loads.get(i);
2682            car.setLoadName(load);
2683            if (!router.isCarRouteable(car, _train, stageTrack, _buildReport)) {
2684                loads.remove(i); // no remove this load
2685                addLine(_buildReport, SEVEN, Bundle.getMessage("buildStagingTrackNotReachable",
2686                        stageTrack.getLocation().getName(), stageTrack.getName(), load));
2687                if (!loadRestrictions) {
2688                    loads.clear(); // no loads can be routed
2689                    break;
2690                }
2691            } else if (!loadRestrictions) {
2692                break; // done all loads can be routed
2693            }
2694        }
2695        // Use random loads rather that the first one that works to create
2696        // interesting loads
2697        if (loads.size() > 0) {
2698            int rnd = (int) (Math.random() * loads.size());
2699            car.setLoadName(loads.get(rnd));
2700            // check to see if car is now accepted by staging
2701            String status = car.checkDestination(stageTrack.getLocation(), stageTrack);
2702            if (status.equals(Track.OKAY) || (status.startsWith(Track.LENGTH) && stageTrack != _terminateStageTrack)) {
2703                car.setLoadGeneratedFromStaging(true);
2704                car.setFinalDestination(stageTrack.getLocation());
2705                // don't set track assignment unless the car is going to this
2706                // train's staging
2707                if (stageTrack == _terminateStageTrack) {
2708                    car.setFinalDestinationTrack(stageTrack);
2709                } else {
2710                    // don't assign the track, that will be done later
2711                    car.setFinalDestinationTrack(null);
2712                }
2713                car.updateKernel(); // is car part of kernel?
2714                addLine(_buildReport, SEVEN,
2715                        Bundle.getMessage("buildAddingScheduleLoad", loads.size(), car.getLoadName(), car.toString()));
2716                return true;
2717            }
2718            addLine(_buildReport, SEVEN,
2719                    Bundle.getMessage("buildCanNotDropCarBecause", car.toString(), stageTrack.getTrackTypeName(),
2720                            stageTrack.getLocation().getName(), stageTrack.getName(), status));
2721        }
2722        car.setLoadName(oldLoad); // restore load and report failure
2723        addLine(_buildReport, SEVEN, Bundle.getMessage("buildUnableNewLoadStaging", car.toString(), car.getTrackName(),
2724                stageTrack.getLocation().getName(), stageTrack.getName()));
2725        return false;
2726    }
2727
2728    /**
2729     * Checks to see if there are any load restrictions for trains,
2730     * interchanges, and yards if routing through yards is enabled.
2731     *
2732     * @return true if there are load restrictions.
2733     */
2734    private boolean isLoadRestrictions() {
2735        boolean restrictions = isLoadRestrictionsTrain() || isLoadRestrictions(Track.INTERCHANGE);
2736        if (Setup.isCarRoutingViaYardsEnabled()) {
2737            restrictions = restrictions || isLoadRestrictions(Track.YARD);
2738        }
2739        return restrictions;
2740    }
2741
2742    private boolean isLoadRestrictions(String type) {
2743        for (Track track : locationManager.getTracks(type)) {
2744            if (!track.getLoadOption().equals(Track.ALL_LOADS)) {
2745                return true;
2746            }
2747        }
2748        return false;
2749    }
2750
2751    private boolean isLoadRestrictionsTrain() {
2752        for (Train train : trainManager.getList()) {
2753            if (!train.getLoadOption().equals(Train.ALL_LOADS)) {
2754                return true;
2755            }
2756        }
2757        return false;
2758    }
2759
2760
2761
2762    /**
2763     * report any cars left at route location
2764     *
2765     * @param rl route location
2766     */
2767    protected void showCarsNotMoved(RouteLocation rl) {
2768        if (_carIndex < 0) {
2769            _carIndex = 0;
2770        }
2771        // cars up this point have build report messages, only show the cars
2772        // that aren't
2773        // in the build report
2774        int numberCars = 0;
2775        for (int i = _carIndex; i < _carList.size(); i++) {
2776            if (numberCars == DISPLAY_CAR_LIMIT_100) {
2777                addLine(_buildReport, FIVE, Bundle.getMessage("buildOnlyFirstXXXCars", numberCars, rl.getName()));
2778                break;
2779            }
2780            Car car = _carList.get(i);
2781            // find a car at this location that hasn't been given a destination
2782            if (!car.getLocationName().equals(rl.getName()) || car.getRouteDestination() != null) {
2783                continue;
2784            }
2785            if (numberCars == 0) {
2786                addLine(_buildReport, SEVEN,
2787                        Bundle.getMessage("buildMovesCompleted", rl.getMaxCarMoves(), rl.getName()));
2788            }
2789            addLine(_buildReport, SEVEN, Bundle.getMessage("buildCarIgnored", car.toString(), car.getTypeName(),
2790                    car.getLoadType().toLowerCase(), car.getLoadName(), car.getLocationName(), car.getTrackName()));
2791            numberCars++;
2792        }
2793        addLine(_buildReport, SEVEN, BLANK_LINE);
2794    }
2795
2796    /**
2797     * Remove rolling stock from train
2798     *
2799     * @param rs the rolling stock to be removed
2800     */
2801    protected void removeRollingStockFromTrain(RollingStock rs) {
2802        // adjust train length and weight for each location that the rolling
2803        // stock is in the train
2804        boolean inTrain = false;
2805        for (RouteLocation routeLocation : _routeList) {
2806            if (rs.getRouteLocation() == routeLocation) {
2807                inTrain = true;
2808            }
2809            if (rs.getRouteDestination() == routeLocation) {
2810                break;
2811            }
2812            if (inTrain) {
2813                routeLocation.setTrainLength(routeLocation.getTrainLength() - rs.getTotalLength()); // includes
2814                                                                                                    // couplers
2815                routeLocation.setTrainWeight(routeLocation.getTrainWeight() - rs.getAdjustedWeightTons());
2816            }
2817        }
2818        rs.reset(); // remove this rolling stock from the train
2819    }
2820
2821    /**
2822     * Lists cars that couldn't be routed.
2823     */
2824    protected void showCarsNotRoutable() {
2825        // any cars unable to route?
2826        if (_notRoutable.size() > 0) {
2827            addLine(_buildReport, ONE, BLANK_LINE);
2828            addLine(_buildReport, ONE, Bundle.getMessage("buildCarsNotRoutable"));
2829            for (Car car : _notRoutable) {
2830                _warnings++;
2831                addLine(_buildReport, ONE,
2832                        Bundle.getMessage("buildCarNotRoutable", car.toString(), car.getLocationName(),
2833                                car.getTrackName(), car.getPreviousFinalDestinationName(),
2834                                car.getPreviousFinalDestinationTrackName()));
2835            }
2836            addLine(_buildReport, ONE, BLANK_LINE);
2837        }
2838    }
2839
2840    /**
2841     * build has failed due to cars in staging not having destinations this
2842     * routine removes those cars from the staging track by user request.
2843     */
2844    protected void removeCarsFromStaging() {
2845        // Code check, only called if train was departing staging
2846        if (_departStageTrack == null) {
2847            log.error("Error, called when cars in staging not assigned to train");
2848            return;
2849        }
2850        for (Car car : _carList) {
2851            // remove cars from departure staging track that haven't been
2852            // assigned to this train
2853            if (car.getTrack() == _departStageTrack && car.getTrain() == null) {
2854                // remove track from kernel
2855                if (car.getKernel() != null) {
2856                    for (Car c : car.getKernel().getCars())
2857                        c.setLocation(car.getLocation(), null);
2858                } else {
2859                    car.setLocation(car.getLocation(), null);
2860                }
2861            }
2862        }
2863    }
2864
2865    /*
2866     * Engine methods start here
2867     */
2868
2869    /**
2870     * Adds engines to the train if needed based on HPT. Note that the engine
2871     * additional weight isn't considered in this method so HP requirements can
2872     * be lower compared to the original calculation which did include the
2873     * weight of the engines.
2874     *
2875     * @param hpAvailable   the engine hp already assigned to the train for this
2876     *                      leg
2877     * @param extraHpNeeded the additional hp needed
2878     * @param rlNeedHp      where in the route the additional hp is needed
2879     * @param rl            the start of the leg
2880     * @param rld           the end of the leg
2881     * @throws BuildFailedException if unable to add engines to train
2882     */
2883    protected void addEnginesBasedHPT(int hpAvailable, int extraHpNeeded, RouteLocation rlNeedHp, RouteLocation rl,
2884            RouteLocation rld) throws BuildFailedException {
2885        if (rlNeedHp == null) {
2886            return;
2887        }
2888        int numberLocos = 0;
2889        // determine how many locos have already been assigned to the train
2890        List<Engine> engines = engineManager.getList(_train);
2891        for (Engine rs : engines) {
2892            if (rs.getRouteLocation() == rl) {
2893                numberLocos++;
2894            }
2895        }
2896
2897        addLine(_buildReport, ONE, BLANK_LINE);
2898        addLine(_buildReport, ONE, Bundle.getMessage("buildTrainReqExtraHp", extraHpNeeded, rlNeedHp.getName(),
2899                rld.getName(), numberLocos));
2900
2901        // determine engine model and road
2902        String model = _train.getEngineModel();
2903        String road = _train.getEngineRoad();
2904        if ((_train.getSecondLegOptions() & Train.CHANGE_ENGINES) == Train.CHANGE_ENGINES &&
2905                rl == _train.getSecondLegStartRouteLocation()) {
2906            model = _train.getSecondLegEngineModel();
2907            road = _train.getSecondLegEngineRoad();
2908        } else if ((_train.getThirdLegOptions() & Train.CHANGE_ENGINES) == Train.CHANGE_ENGINES &&
2909                rl == _train.getThirdLegStartRouteLocation()) {
2910            model = _train.getThirdLegEngineModel();
2911            road = _train.getThirdLegEngineRoad();
2912        }
2913
2914        while (numberLocos < Setup.getMaxNumberEngines()) {
2915            // if no engines assigned, can't use B unit as first engine
2916            if (!getEngines("1", model, road, rl, rld, numberLocos > 0)) {
2917                throw new BuildFailedException(Bundle.getMessage("buildErrorEngines", Bundle.getMessage("additional"),
2918                        rl.getName(), rld.getName()));
2919            }
2920            numberLocos++;
2921            int currentHp = _train.getTrainHorsePower(rlNeedHp);
2922            if (currentHp > hpAvailable + extraHpNeeded) {
2923                break; // done
2924            }
2925            if (numberLocos < Setup.getMaxNumberEngines()) {
2926                addLine(_buildReport, FIVE, BLANK_LINE);
2927                addLine(_buildReport, THREE,
2928                        Bundle.getMessage("buildContinueAddLocos", (hpAvailable + extraHpNeeded - currentHp),
2929                                rlNeedHp.getName(), rld.getName(), numberLocos, currentHp));
2930            } else {
2931                addLine(_buildReport, FIVE,
2932                        Bundle.getMessage("buildMaxNumberLocoAssigned", Setup.getMaxNumberEngines()));
2933            }
2934        }
2935    }
2936
2937    /**
2938     * Adds an engine to the train.
2939     *
2940     * @param engine the engine being added to the train
2941     * @param rl     where in the train's route to pick up the engine
2942     * @param rld    where in the train's route to set out the engine
2943     * @param track  the destination track for this engine
2944     */
2945    private void addEngineToTrain(Engine engine, RouteLocation rl, RouteLocation rld, Track track) {
2946        _lastEngine = engine; // needed in case there's a engine change in the
2947                              // train's route
2948        if (_train.getLeadEngine() == null) {
2949            _train.setLeadEngine(engine); // load lead engine
2950        }
2951        addLine(_buildReport, ONE, Bundle.getMessage("buildEngineAssigned", engine.toString(), rl.getName(),
2952                rld.getName(), track.getName()));
2953        engine.setDestination(track.getLocation(), track);
2954        int length = engine.getTotalLength();
2955        int weightTons = engine.getAdjustedWeightTons();
2956        // engine in consist?
2957        if (engine.getConsist() != null) {
2958            length = engine.getConsist().getTotalLength();
2959            weightTons = engine.getConsist().getAdjustedWeightTons();
2960            for (Engine cEngine : engine.getConsist().getEngines()) {
2961                if (cEngine != engine) {
2962                    addLine(_buildReport, ONE, Bundle.getMessage("buildEngineAssigned", cEngine.toString(),
2963                            rl.getName(), rld.getName(), track.getName()));
2964                    cEngine.setTrain(_train);
2965                    cEngine.setRouteLocation(rl);
2966                    cEngine.setRouteDestination(rld);
2967                    cEngine.setDestination(track.getLocation(), track, RollingStock.FORCE); // force
2968                }
2969            }
2970        }
2971        // now adjust train length and weight for each location that engines are
2972        // in the train
2973        finishAddRsToTrain(engine, rl, rld, length, weightTons);
2974    }
2975
2976    private boolean buildConsistFromSingleLocos(int reqNumberEngines, List<Engine> singleLocos, RouteLocation rl,
2977            RouteLocation rld) {
2978        addLine(_buildReport, FIVE, Bundle.getMessage("buildOptionBuildConsist", reqNumberEngines, rl.getName()));
2979        addLine(_buildReport, FIVE, Bundle.getMessage("buildOptionSingleLocos", singleLocos.size(), rl.getName()));
2980        if (singleLocos.size() >= reqNumberEngines) {
2981            int locos = 0;
2982            // first find an "A" unit
2983            for (Engine engine : singleLocos) {
2984                if (engine.isBunit()) {
2985                    continue;
2986                }
2987                if (setEngineDestination(engine, rl, rld)) {
2988                    _engineList.remove(engine);
2989                    singleLocos.remove(engine);
2990                    locos++;
2991                    break; // found "A" unit
2992                }
2993            }
2994            // did we find an "A" unit?
2995            if (locos > 0) {
2996                // now add the rest "A" or "B" units
2997                for (Engine engine : singleLocos) {
2998                    if (setEngineDestination(engine, rl, rld)) {
2999                        _engineList.remove(engine);
3000                        locos++;
3001                    }
3002                    if (locos == reqNumberEngines) {
3003                        return true; // done!
3004                    }
3005                }
3006            } else {
3007                // list the "B" units found
3008                for (Engine engine : singleLocos) {
3009                    if (engine.isBunit()) {
3010                        addLine(_buildReport, FIVE,
3011                                Bundle.getMessage("BuildEngineBunit", engine.toString(), engine.getLocationName(),
3012                                        engine.getTrackName()));
3013                    }
3014                }
3015            }
3016        }
3017        return false;
3018    }
3019
3020    /**
3021     * Used to determine the number of engines requested by the user.
3022     *
3023     * @param requestEngines Can be a number, AUTO or AUTO HPT.
3024     * @return the number of engines requested by user.
3025     */
3026    protected int getNumberEngines(String requestEngines) {
3027        int numberEngines = 0;
3028        if (requestEngines.equals(Train.AUTO)) {
3029            numberEngines = getAutoEngines();
3030        } else if (requestEngines.equals(Train.AUTO_HPT)) {
3031            numberEngines = 1; // get one loco for now, check HP requirements
3032                               // after train is built
3033        } else {
3034            numberEngines = Integer.parseInt(requestEngines);
3035        }
3036        return numberEngines;
3037    }
3038
3039    /**
3040     * Sets the destination track for an engine and assigns it to the train.
3041     *
3042     * @param engine The engine to be added to train
3043     * @param rl     Departure route location
3044     * @param rld    Destination route location
3045     * @return true if destination track found and set
3046     */
3047    protected boolean setEngineDestination(Engine engine, RouteLocation rl, RouteLocation rld) {
3048        // engine to staging?
3049        if (rld == _train.getTrainTerminatesRouteLocation() && _terminateStageTrack != null) {
3050            String status = engine.checkDestination(_terminateStageTrack.getLocation(), _terminateStageTrack);
3051            if (status.equals(Track.OKAY)) {
3052                addEngineToTrain(engine, rl, rld, _terminateStageTrack);
3053                return true; // done
3054            } else {
3055                addLine(_buildReport, SEVEN,
3056                        Bundle.getMessage("buildCanNotDropEngineToTrack", engine.toString(),
3057                                _terminateStageTrack.getTrackTypeName(),
3058                                _terminateStageTrack.getLocation().getName(), _terminateStageTrack.getName(), status));
3059            }
3060        } else {
3061            // find a destination track for this engine
3062            Location destination = rld.getLocation();
3063            List<Track> destTracks = destination.getTracksByMoves(null);
3064            if (destTracks.size() == 0) {
3065                addLine(_buildReport, THREE, Bundle.getMessage("buildNoTracksAtDestination", rld.getName()));
3066            }
3067            for (Track track : destTracks) {
3068                if (!checkDropTrainDirection(engine, rld, track)) {
3069                    continue;
3070                }
3071                if (!checkTrainCanDrop(engine, track)) {
3072                    continue;
3073                }
3074                String status = engine.checkDestination(destination, track);
3075                if (status.equals(Track.OKAY)) {
3076                    addEngineToTrain(engine, rl, rld, track);
3077                    return true;
3078                } else {
3079                    addLine(_buildReport, SEVEN,
3080                            Bundle.getMessage("buildCanNotDropEngineToTrack", engine.toString(),
3081                                    track.getTrackTypeName(),
3082                                    track.getLocation().getName(), track.getName(), status));
3083                }
3084            }
3085            addLine(_buildReport, FIVE,
3086                    Bundle.getMessage("buildCanNotDropEngToDest", engine.toString(), rld.getName()));
3087        }
3088        return false; // not able to set loco's destination
3089    }
3090
3091    /**
3092     * Returns the number of engines needed for this train, minimum 1, maximum
3093     * user specified in setup. Based on maximum allowable train length and
3094     * grade between locations, and the maximum cars that the train can have at
3095     * the maximum train length. One engine per sixteen 40' cars for 1% grade.
3096     *
3097     * @return The number of engines needed
3098     */
3099    private int getAutoEngines() {
3100        double numberEngines = 1;
3101        int moves = 0;
3102        int carLength = 40 + Car.COUPLERS; // typical 40' car
3103
3104        // adjust if length in meters
3105        if (!Setup.getLengthUnit().equals(Setup.FEET)) {
3106            carLength = 12 + Car.COUPLERS; // typical car in meters
3107        }
3108
3109        for (RouteLocation rl : _routeList) {
3110            if (rl.isPickUpAllowed() && rl != _train.getTrainTerminatesRouteLocation()) {
3111                moves += rl.getMaxCarMoves(); // assume all moves are pick ups
3112                double carDivisor = 16; // number of 40' cars per engine 1% grade
3113                // change engine requirements based on grade
3114                if (rl.getGrade() > 1) {
3115                    carDivisor = carDivisor / rl.getGrade();
3116                }
3117                log.debug("Maximum train length {} for location ({})", rl.getMaxTrainLength(), rl.getName());
3118                if (rl.getMaxTrainLength() / (carDivisor * carLength) > numberEngines) {
3119                    numberEngines = rl.getMaxTrainLength() / (carDivisor * carLength);
3120                    // round up to next whole integer
3121                    numberEngines = Math.ceil(numberEngines);
3122                    // determine if there's enough car pick ups at this point to
3123                    // reach the max train length
3124                    if (numberEngines > moves / carDivisor) {
3125                        // no reduce based on moves
3126                        numberEngines = Math.ceil(moves / carDivisor);
3127                    }
3128                }
3129            }
3130        }
3131        int nE = (int) numberEngines;
3132        if (_train.isLocalSwitcher()) {
3133            nE = 1; // only one engine if switcher
3134        }
3135        addLine(_buildReport, ONE,
3136                Bundle.getMessage("buildAutoBuildMsg", Integer.toString(nE)));
3137        if (nE > Setup.getMaxNumberEngines()) {
3138            addLine(_buildReport, THREE, Bundle.getMessage("buildMaximumNumberEngines", Setup.getMaxNumberEngines()));
3139            nE = Setup.getMaxNumberEngines();
3140        }
3141        return nE;
3142    }
3143
3144    protected boolean getConsist(String reqNumEngines, String model, String road, RouteLocation rl, RouteLocation rld)
3145            throws BuildFailedException {
3146        if (reqNumEngines.equals(Train.AUTO_HPT)) {
3147            for (int i = 2; i < Setup.getMaxNumberEngines(); i++) {
3148                if (getEngines(Integer.toString(i), model, road, rl, rld)) {
3149                    return true;
3150                }
3151            }
3152        }
3153        return false;
3154    }
3155
3156    protected void showEnginesByLocation() {
3157        // show how many engines were found
3158        addLine(_buildReport, SEVEN, BLANK_LINE);
3159        addLine(_buildReport, ONE,
3160                Bundle.getMessage("buildFoundLocos", Integer.toString(_engineList.size()), _train.getName()));
3161
3162        // only show engines once using the train's route
3163        List<String> locationNames = new ArrayList<>();
3164        for (RouteLocation rl : _train.getRoute().getLocationsBySequenceList()) {
3165            if (locationNames.contains(rl.getName())) {
3166                continue;
3167            }
3168            locationNames.add(rl.getName());
3169            int count = countRollingStockAt(rl, new ArrayList<RollingStock>(_engineList));
3170            if (rl.getLocation().isStaging()) {
3171                addLine(_buildReport, FIVE,
3172                        Bundle.getMessage("buildLocosInStaging", count, rl.getName()));
3173            } else {
3174                addLine(_buildReport, FIVE,
3175                        Bundle.getMessage("buildLocosAtLocation", count, rl.getName()));
3176            }
3177            for (Engine engine : _engineList) {
3178                if (engine.getLocationName().equals(rl.getName())) {
3179                    addLine(_buildReport, SEVEN,
3180                            Bundle.getMessage("buildLocoAtLocWithMoves", engine.toString(), engine.getTypeName(),
3181                                    engine.getModel(), engine.getLocationName(), engine.getTrackName(),
3182                                    engine.getMoves()));
3183                }
3184            }
3185            addLine(_buildReport, SEVEN, BLANK_LINE);
3186        }
3187    }
3188
3189    protected int countRollingStockAt(RouteLocation rl, List<RollingStock> list) {
3190        int count = 0;
3191        for (RollingStock rs : list) {
3192            if (rs.getLocationName().equals(rl.getName())) {
3193                count++;
3194            }
3195        }
3196        return count;
3197    }
3198
3199    protected boolean getEngines(String requestedEngines, String model, String road, RouteLocation rl,
3200            RouteLocation rld) throws BuildFailedException {
3201        return getEngines(requestedEngines, model, road, rl, rld, !USE_BUNIT);
3202    }
3203
3204    /**
3205     * Get the engines for this train at a route location. If departing from
3206     * staging engines must come from that track. Finds the required number of
3207     * engines in a consist, or if the option to build from single locos, builds
3208     * a consist for the user. When true, engines successfully added to train
3209     * for the leg requested.
3210     *
3211     * @param requestedEngines Requested number of Engines, can be number, AUTO
3212     *                         or AUTO HPT
3213     * @param model            Optional model name for the engines
3214     * @param road             Optional road name for the engines
3215     * @param rl               Departure route location for the engines
3216     * @param rld              Destination route location for the engines
3217     * @param useBunit         true if B unit engine is allowed
3218     * @return true if correct number of engines found.
3219     * @throws BuildFailedException if coding issue
3220     */
3221    protected boolean getEngines(String requestedEngines, String model, String road, RouteLocation rl,
3222            RouteLocation rld, boolean useBunit) throws BuildFailedException {
3223        // load departure track if staging
3224        Track departStageTrack = null;
3225        if (rl == _train.getTrainDepartsRouteLocation()) {
3226            departStageTrack = _departStageTrack; // get departure track from
3227                                                  // staging, could be null
3228        }
3229
3230        int reqNumberEngines = getNumberEngines(requestedEngines);
3231
3232        // if not departing staging track and engines aren't required done!
3233        if (departStageTrack == null && reqNumberEngines == 0) {
3234            return true;
3235        }
3236        // if departing staging and no engines required and none available,
3237        // we're done
3238        if (departStageTrack != null && reqNumberEngines == 0 && departStageTrack.getNumberEngines() == 0) {
3239            return true;
3240        }
3241
3242        // code check, staging track selection checks number of engines needed
3243        if (departStageTrack != null &&
3244                reqNumberEngines != 0 &&
3245                departStageTrack.getNumberEngines() != reqNumberEngines) {
3246            throw new BuildFailedException(Bundle.getMessage("buildStagingNotEngines", departStageTrack.getName(),
3247                    departStageTrack.getNumberEngines(), reqNumberEngines));
3248        }
3249
3250        // code check
3251        if (rl == null || rld == null) {
3252            throw new BuildFailedException(
3253                    Bundle.getMessage("buildErrorEngLocUnknown"));
3254        }
3255
3256        addLine(_buildReport, FIVE, Bundle.getMessage("buildBegineSearchEngines", reqNumberEngines, model, road,
3257                rl.getName(), rld.getName()));
3258
3259        int assignedLocos = 0; // the number of locos assigned to this train
3260        List<Engine> singleLocos = new ArrayList<>();
3261        for (int indexEng = 0; indexEng < _engineList.size(); indexEng++) {
3262            Engine engine = _engineList.get(indexEng);
3263            log.debug("Engine ({}) at location ({}, {})", engine.toString(), engine.getLocationName(),
3264                    engine.getTrackName());
3265
3266            // use engines that are departing from the selected staging track
3267            // (departTrack
3268            // != null if staging)
3269            if (departStageTrack != null && !departStageTrack.equals(engine.getTrack())) {
3270                continue;
3271            }
3272            // use engines that are departing from the correct location
3273            if (!engine.getLocationName().equals(rl.getName())) {
3274                log.debug("Skipping engine ({}) at location ({})", engine.toString(), engine.getLocationName());
3275                continue;
3276            }
3277            // skip engines models that train does not service
3278            if (!model.equals(Train.NONE) && !engine.getModel().equals(model)) {
3279                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeEngineModel", engine.toString(),
3280                        engine.getModel(), engine.getLocationName()));
3281                continue;
3282            }
3283            // Does the train have a very specific engine road name requirement?
3284            if (!road.equals(Train.NONE) && !engine.getRoadName().equals(road)) {
3285                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeEngineRoad", engine.toString(),
3286                        engine.getLocationName(), engine.getTrackName(), engine.getRoadName()));
3287                continue;
3288            }
3289            // skip engines on tracks that don't service the train's departure
3290            // direction
3291            if (!checkPickUpTrainDirection(engine, rl)) {
3292                continue;
3293            }
3294            // skip engines that have been assigned destinations that don't
3295            // match the requested destination
3296            if (engine.getDestination() != null && !engine.getDestinationName().equals(rld.getName())) {
3297                addLine(_buildReport, SEVEN, Bundle.getMessage("buildExcludeEngineDestination", engine.toString(),
3298                        engine.getDestinationName()));
3299                continue;
3300            }
3301            // don't use non lead locos in a consist
3302            if (engine.getConsist() != null) {
3303                if (engine.isLead()) {
3304                    addLine(_buildReport, SEVEN,
3305                            Bundle.getMessage("buildEngineLeadConsist", engine.toString(),
3306                                    engine.getConsist().getName(), engine.getConsist().getEngines().size()));
3307                } else {
3308                    continue;
3309                }
3310            }
3311            // departing staging, then all locos must go!
3312            if (departStageTrack != null) {
3313                if (!setEngineDestination(engine, rl, rld)) {
3314                    return false;
3315                }
3316                _engineList.remove(indexEng--);
3317                if (engine.getConsist() != null) {
3318                    assignedLocos = assignedLocos + engine.getConsist().getSize();
3319                } else {
3320                    assignedLocos++;
3321                }
3322                continue;
3323            }
3324            // can't use B units if requesting one loco
3325            if (!useBunit && reqNumberEngines == 1 && engine.isBunit()) {
3326                addLine(_buildReport, SEVEN,
3327                        Bundle.getMessage("buildExcludeEngineBunit", engine.toString(), engine.getModel()));
3328                continue;
3329            }
3330            // is this engine part of a consist?
3331            if (engine.getConsist() == null) {
3332                // single engine, but does the train require a consist?
3333                if (reqNumberEngines > 1) {
3334                    addLine(_buildReport, SEVEN,
3335                            Bundle.getMessage("buildExcludeEngineSingle", engine.toString(), reqNumberEngines));
3336                    singleLocos.add(engine);
3337                    continue;
3338                }
3339                // engine is part of a consist
3340            } else if (engine.getConsist().getSize() == reqNumberEngines) {
3341                log.debug("Consist ({}) has the required number of engines", engine.getConsist().getName()); // NOI18N
3342            } else if (reqNumberEngines != 0) {
3343                addLine(_buildReport, SEVEN,
3344                        Bundle.getMessage("buildExcludeEngConsistNumber", engine.toString(),
3345                                engine.getConsist().getName(), engine.getConsist().getSize()));
3346                continue;
3347            }
3348            // found a loco or consist!
3349            assignedLocos++;
3350
3351            // now find terminal track for engine(s)
3352            addLine(_buildReport, FIVE,
3353                    Bundle.getMessage("buildEngineRoadModelType", engine.toString(), engine.getRoadName(),
3354                            engine.getModel(), engine.getTypeName(), engine.getLocationName(), engine.getTrackName(),
3355                            rld.getName()));
3356            if (setEngineDestination(engine, rl, rld)) {
3357                _engineList.remove(indexEng--);
3358                return true; // normal exit when not staging
3359            }
3360        }
3361        // build a consist out of non-consisted locos
3362        if (assignedLocos == 0 && reqNumberEngines > 1 && _train.isBuildConsistEnabled()) {
3363            if (buildConsistFromSingleLocos(reqNumberEngines, singleLocos, rl, rld)) {
3364                return true; // normal exit when building with single locos
3365            }
3366        }
3367        if (assignedLocos == 0) {
3368            String locationName = rl.getName();
3369            if (departStageTrack != null) {
3370                locationName = locationName + ", " + departStageTrack.getName();
3371            }
3372            addLine(_buildReport, FIVE, Bundle.getMessage("buildNoLocosFoundAtLocation", locationName));
3373        } else if (departStageTrack != null && (reqNumberEngines == 0 || reqNumberEngines == assignedLocos)) {
3374            return true; // normal exit assigning from staging
3375        }
3376        // not able to assign engines to train
3377        return false;
3378    }
3379
3380    /**
3381     * Removes engine from train and attempts to replace it with engine or
3382     * consist that meets the HP requirements of the train.
3383     *
3384     * @param hpNeeded   How much hp is needed
3385     * @param leadEngine The lead engine for this leg
3386     * @param model      The engine's model
3387     * @param road       The engine's road
3388     * @throws BuildFailedException if new engine not found
3389     */
3390    protected void getNewEngine(int hpNeeded, Engine leadEngine, String model, String road)
3391            throws BuildFailedException {
3392        // save lead engine's rl, and rld
3393        RouteLocation rl = leadEngine.getRouteLocation();
3394        RouteLocation rld = leadEngine.getRouteDestination();
3395        removeEngineFromTrain(leadEngine);
3396        _engineList.add(0, leadEngine); // put engine back into the pool
3397        if (hpNeeded < 50) {
3398            hpNeeded = 50; // the minimum HP
3399        }
3400        int hpMax = hpNeeded;
3401        // largest single engine HP known today is less than 15,000.
3402        // high end modern diesel locos approximately 5000 HP.
3403        // 100 car train at 100 tons per car and 2 HPT requires 20,000 HP.
3404        // will assign consisted engines to train.
3405        boolean foundLoco = false;
3406        List<Engine> rejectedLocos = new ArrayList<>();
3407        hpLoop: while (hpMax < 20000) {
3408            hpMax += hpNeeded / 2; // start off looking for an engine with no
3409                                   // more than 50% extra HP
3410            log.debug("Max hp {}", hpMax);
3411            for (Engine engine : _engineList) {
3412                if (rejectedLocos.contains(engine)) {
3413                    continue;
3414                }
3415                // don't use non lead locos in a consist
3416                if (engine.getConsist() != null && !engine.isLead()) {
3417                    continue;
3418                }
3419                if (engine.getLocation() != rl.getLocation()) {
3420                    continue;
3421                }
3422                if (!model.equals(Train.NONE) && !engine.getModel().equals(model)) {
3423                    continue;
3424                }
3425                if (!road.equals(Train.NONE) && !engine.getRoadName().equals(road) ||
3426                        road.equals(Train.NONE) && !_train.isLocoRoadNameAccepted(engine.getRoadName())) {
3427                    continue;
3428                }
3429                int engineHp = engine.getHpInteger();
3430                if (engine.getConsist() != null) {
3431                    for (Engine e : engine.getConsist().getEngines()) {
3432                        if (e != engine) {
3433                            engineHp = engineHp + e.getHpInteger();
3434                        }
3435                    }
3436                }
3437                if (engineHp > hpNeeded && engineHp <= hpMax) {
3438                    addLine(_buildReport, FIVE,
3439                            Bundle.getMessage("buildLocoHasRequiredHp", engine.toString(), engineHp, hpNeeded));
3440                    if (setEngineDestination(engine, rl, rld)) {
3441                        foundLoco = true;
3442                        break hpLoop;
3443                    } else {
3444                        rejectedLocos.add(engine);
3445                    }
3446                }
3447            }
3448        }
3449        if (!foundLoco && !_train.isBuildConsistEnabled()) {
3450            throw new BuildFailedException(Bundle.getMessage("buildErrorEngHp", rl.getLocation().getName()));
3451        }
3452    }
3453
3454    protected void removeEngineFromTrain(Engine engine) {
3455        // replace lead engine?
3456        if (_train.getLeadEngine() == engine) {
3457            _train.setLeadEngine(null);
3458        }
3459        if (engine.getConsist() != null) {
3460            for (Engine e : engine.getConsist().getEngines()) {
3461                removeRollingStockFromTrain(e);
3462            }
3463        } else {
3464            removeRollingStockFromTrain(engine);
3465        }
3466    }
3467
3468    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(TrainBuilderBase.class);
3469
3470}