Tc issue 262

transitclock/pom.xml

@@ -90,7 +90,12 @@
 		<dependency>
 			<groupId>com.esri.geometry</groupId>
 			<artifactId>esri-geometry-api</artifactId>
-			<version>1.1</version>
+			<version>2.2.4</version>
+		</dependency>
+		<dependency>
+			<groupId>com.bmw-carit</groupId>
+			<artifactId>barefoot</artifactId>
+			<version>0.1.5</version>
 		</dependency>
 
 

transitclock/src/main/java/org/transitclock/configData/CoreConfig.java

@@ -49,6 +49,10 @@ public static int getDaysPopulateHistoricalCache() {
 	private static IntegerConfigValue daysPopulateHistoricalCache =
 			new IntegerConfigValue("transitclock.cache.core.daysPopulateHistoricalCache", 0,
 					"How many days data to read in to populate historical cache on start up.");
+
+	public static BooleanConfigValue useDefaultSpatialMatcher = new BooleanConfigValue("transitclock.cache.core.useDefaultSpatialMatcher", false, "Set to true to use default matcher");
+
+	public static BooleanConfigValue useBarefootSpatialMatcher = new BooleanConfigValue("transitclock.cache.core.useBarefootSpatialMatcher", true, "Set to true to use default matcher");
 	/**
 	 * When in playback mode or some other situations don't want to store
 	 * generated data such as arrivals/departures, events, and such to the

transitclock/src/main/java/org/transitclock/core/ArrivalDepartureGeneratorDefaultImpl.java

@@ -625,7 +625,7 @@ private void estimateArrivalsDeparturesWithoutPreviousMatch(
 
 			// Determine departure time for first stop of trip
 			SpatialMatch beginningOfTrip = new SpatialMatch(0, block,
-					tripIndex, 0, 0, 0.0, 0.0);
+					tripIndex, 0, 0, 0.0, 0.0, SpatialMatch.MatchType.TRANSITCLOCK);
 			long travelTimeFromFirstStopToMatch = TravelTimes.getInstance()
 					.expectedTravelTimeBetweenMatches(vehicleId, avlReportTime,
 							beginningOfTrip, newMatch);

transitclock/src/main/java/org/transitclock/core/AvlProcessor.java

@@ -440,13 +440,20 @@ public void matchNewFixForPredictableVehicle(VehicleState vehicleState) {
 		logger.debug("STARTOFMATCHING");
 		logger.debug("Matching already predictable vehicle using new AVL "
 				+ "report. The old spatial match is {}", vehicleState);
+
+		List<SpatialMatch> spatialMatches = new ArrayList<>();
 
 		// Find possible spatial matches
-		List<SpatialMatch> spatialMatches = SpatialMatcher
-				.getSpatialMatches(vehicleState);
+		if(CoreConfig.useDefaultSpatialMatcher.getValue())		
+			spatialMatches.addAll(SpatialMatcher
+				.getSpatialMatches(vehicleState));
+
+		if(CoreConfig.useBarefootSpatialMatcher.getValue())			
+			spatialMatches.add(vehicleState.getMapMatchedSpatialMatch());					
+
 		logger.debug("For vehicleId={} found the following {} spatial "
-				+ "matches: {}", vehicleState.getVehicleId(),
-				spatialMatches.size(), spatialMatches);
+				+ "matches: {} ", vehicleState.getVehicleId(),
+				spatialMatches.size(), spatialMatches);				
 
 		// Find best temporal match of the spatial matches
 		TemporalMatch bestTemporalMatch = TemporalMatcher.getInstance()
@@ -824,7 +831,7 @@ private boolean matchVehicleToBlockAssignment(Block block,
 						block, block.getTripIndex(trip), 0, // stopPathIndex
 						0, // segmentIndex
 						distanceToSegment,
-						0.0); // distanceAlongSegment
+						0.0,SpatialMatch.MatchType.TRANSITCLOCK); // distanceAlongSegment
 
 				bestMatch = new TemporalMatch(beginningOfTrip,
 						new TemporalDifference(0));

transitclock/src/main/java/org/transitclock/core/Indices.java

@@ -17,6 +17,7 @@
 package org.transitclock.core;
 
 import java.io.Serializable;
+import java.util.Objects;
 
 import org.transitclock.applications.Core;
 import org.transitclock.db.structs.ArrivalDeparture;
@@ -634,4 +635,11 @@ public boolean controlPoint() {
 		return false;
 	}
 
+	@Override
+	public int hashCode() {
+		return Objects.hash(block, segmentIndex, stopPathIndex, tripIndex);
+	}
+
+
+
 }

transitclock/src/main/java/org/transitclock/core/MapMatcher.java

@@ -0,0 +1,12 @@
+package org.transitclock.core;
+
+import java.util.Date;
+
+import org.transitclock.db.structs.AvlReport;
+import org.transitclock.db.structs.Block;
+import org.transitclock.db.structs.Location;
+
+public interface MapMatcher {
+	void setMatcher(Block block,  Date assignmentTime);	
+	SpatialMatch getSpatialMatch(AvlReport avlReport);
+}

transitclock/src/main/java/org/transitclock/core/MapMatcherFactory.java

@@ -0,0 +1,51 @@
+/*
+ * This file is part of Transitime.org
+ * 
+ * Transitime.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License (GPL) as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * any later version.
+ *
+ * Transitime.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Transitime.org .  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.transitclock.core;
+
+import org.transitclock.config.StringConfigValue;
+import org.transitclock.utils.ClassInstantiator;
+
+/**
+ * For instantiating a map matcher object that matches avl locations to trip shapes 
+ * 
+ * @author Sean Óg Crudden
+ * 
+ */
+public class MapMatcherFactory {
+
+	// The name of the class to instantiate
+	private static StringConfigValue className = 
+			new StringConfigValue("transitclock.core.mapMatcherClass", 
+					"org.transitclock.core.barefoot.BareFootMapMatcher",
+					"Specifies the name of the class used for map matching.");
+
+	/********************** Member Functions **************************/
+
+	public static MapMatcher getInstance() {
+
+
+		try {
+			return ClassInstantiator.instantiate(className.getValue(), 
+						MapMatcher.class);
+		} catch (Exception e) {
+
+			e.printStackTrace();
+		}
+		return null;		
+	}
+}

transitclock/src/main/java/org/transitclock/core/SpatialMatch.java

@@ -49,6 +49,12 @@ public class SpatialMatch {
 	protected final double distanceAlongSegment;
 	protected final VehicleAtStopInfo atStop;
 	protected final Location predictedLocation;
+	protected final MatchType type;
+
+	public enum MatchType { 
+		TRANSITCLOCK,
+		BAREFOOT
+	} ; 
 
 	private static final Logger logger = 
 			LoggerFactory.getLogger(SpatialMatch.class);
@@ -58,7 +64,7 @@ public class SpatialMatch {
 
 	public SpatialMatch(long avlTime, Block block,
 			int tripIndex, int stopPathIndex, int segmentIndex,
-			double distanceToSegment, double distanceAlongSegment) {
+			double distanceToSegment, double distanceAlongSegment, MatchType type) {
 		this.avlTime = avlTime;
 		this.block = block;
 		this.tripIndex = tripIndex;
@@ -69,7 +75,12 @@ public SpatialMatch(long avlTime, Block block,
 
 		// Determine whether at stop
 		this.atStop = atStop();
-		this.predictedLocation = computeLocation();
+		this.predictedLocation = computeLocation();		
+		this.type=type;
+	}
+
+	public MatchType getType() {
+		return type;
 	}
 
 	/**
@@ -145,6 +156,7 @@ public SpatialMatch(SpatialMatch toCopy, Trip newTrip) {
 		}
 		// recomupte predictedLocation for above reasons as well
 		this.predictedLocation = toCopy.computeLocation(toCopy.getIndices(), toCopy.distanceAlongSegment);
+		this.type=toCopy.type;
 	}
 
 	/**
@@ -167,6 +179,7 @@ public SpatialMatch(SpatialMatch toCopy, Indices newIndices,
 		this.distanceAlongSegment = distanceAlongSegment;
 		this.atStop = toCopy.atStop;
 		this.predictedLocation = computeLocation(newIndices, distanceAlongSegment);
+		this.type = toCopy.type;
 	}
 
 	/**
@@ -184,6 +197,7 @@ protected SpatialMatch(SpatialMatch toCopy) {
 		this.distanceAlongSegment = toCopy.distanceAlongSegment;
 		this.atStop = toCopy.atStop;
 		this.predictedLocation = toCopy.predictedLocation;
+		this.type = toCopy.type;
 	}
 
 	/**
@@ -452,7 +466,7 @@ public SpatialMatch getMatchAtJustBeforeNextStop() {
 				m.getStopPathIndex(),
 				segmentIndex, 
 				Double.NaN, // distanceToSegment not set to a valid value
-				segmentLength);
+				segmentLength, this.type);
 	}
 
 	/**
@@ -511,7 +525,7 @@ public SpatialMatch getMatchAtPreviousStop() {
 				indices.getStopPathIndex(),
 				indices.getSegmentIndex(),
 				Double.NaN,       // distanceToSegment not set to a valid value
-				segmentVectorLength); 
+				segmentVectorLength, this.type); 
 	}
 
 	/**

transitclock/src/main/java/org/transitclock/core/SpatialMatcher.java

@@ -68,7 +68,7 @@ public class SpatialMatcher {
 	private SpatialMatch smallestDistanceSpatialMatch = null;
 
 	// For keeping track of what kind of spatial matching being done
-	public enum MatchingType {STANDARD_MATCHING, AUTO_ASSIGNING_MATCHING};
+	public enum MatchingType {STANDARD_MATCHING, AUTO_ASSIGNING_MATCHING, BAREFOOT_MATCHING};
 
 	private static final Logger logger = 
 			LoggerFactory.getLogger(SpatialMatcher.class);
@@ -618,7 +618,8 @@ private void processPossiblePotentialMatch(AvlReport avlReport,
 				potentialMatchIndices.getStopPathIndex(),
 				potentialMatchIndices.getSegmentIndex(), 
 				distanceToSegment,
-				distanceAlongSegment);
+				distanceAlongSegment,
+				SpatialMatch.MatchType.TRANSITCLOCK);
 		logger.debug("For vehicleId={} examining match to see if it should " +
 				"be included in list of spatial matches. {}", 
 				avlReport.getVehicleId(), spatialMatch);
@@ -732,6 +733,7 @@ && withinAllowableDistanceOfLayover(avlReport.getVehicleId(),
 	 */
 	public static List<SpatialMatch>
 			getSpatialMatches(VehicleState vehicleState) {
+
 		// Some convenience variables
 		TemporalMatch previousMatch = vehicleState.getMatch();
 		SpatialMatcher spatialMatcher = new SpatialMatcher();
@@ -855,7 +857,8 @@ && withinAllowableDistanceOfLayover(avlReport.getVehicleId(),
 					indexOfLastStopPath,
 					indexOfLastSegment, 
 					Double.NaN, // distanceToSegment set to a non-valid value
-					segmentLength);
+					segmentLength,
+					SpatialMatch.MatchType.TRANSITCLOCK);
 
 			// Add that match to list of possible SpatialMatches
 			logger.debug("Because vehicleId={} within specified distance " +

transitclock/src/main/java/org/transitclock/core/TemporalMatcher.java

@@ -102,7 +102,8 @@ private static TemporalDifference determineHowFarOffScheduledTime(
 				0,    // stopPathIndex 
 				0,    // segmentIndex 
 				0.0,  // distanceToSegment
-				0.0); // distanceAlongSegment
+				0.0,
+				SpatialMatch.MatchType.TRANSITCLOCK); // distanceAlongSegment
 		int tripStartTimeSecs = spatialMatch.getTrip().getStartTime();
 		int travelTimeForCurrentTrip = 
 				TravelTimes.getInstance().expectedTravelTimeBetweenMatches(vehicleId, 

transitclock/src/main/java/org/transitclock/core/VehicleState.java

@@ -23,7 +23,6 @@
 import java.util.List;
 import java.util.NoSuchElementException;
 import java.util.Objects;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.transitclock.configData.CoreConfig;
@@ -66,6 +65,9 @@ public class VehicleState {
 	// First is most recent
 	private LinkedList<AvlReport> avlReportHistory =
 			new LinkedList<AvlReport>();
+
+
+
 	private List<IpcPrediction> predictions;
 	private TemporalDifference realTimeSchedAdh;
 
@@ -100,7 +102,8 @@ public class VehicleState {
 	private HoldingTime holdingTime=null;
 	//Used for schedPred AVL. Identify if trip is canceled.
 	private boolean isCanceled;
-
+
+	MapMatcher mapMatcher = null;
 
 	public Headway getHeadway() {
 		return headway;
@@ -109,8 +112,6 @@ public void setHeadway(Headway headway) {
 		this.headway = headway;
 	}
 
-
-
 	public HoldingTime getHoldingTime() {
 		return holdingTime;
 	}
@@ -131,8 +132,9 @@ public void incrementTripCounter() {
 
 	public VehicleState(String vehicleId) {
 		this.vehicleId = vehicleId;
+
 	}
-
+	
 	/**
 	 * Sets the block assignment for vehicle. Also, this is how it is specified
 	 * whether a vehicle is predictable or not.
@@ -163,9 +165,23 @@ public void setBlock(Block newBlock, BlockAssignmentMethod assignmentMethod,
 		this.assignmentMethod = assignmentMethod;
 		this.assignmentId = assignmentId;
 		this.predictable = predictable;
-		this.assignmentTime = getAvlReport().getDate();
+		this.assignmentTime = getAvlReport().getDate();		
+
+		this.mapMatcher=(MapMatcher) MapMatcherFactory.getInstance();
+		mapMatcher.setMatcher(block, assignmentTime);		
+
+	}
+
+	public SpatialMatch getMapMatchedSpatialMatch()
+	{
+		if(mapMatcher!=null)
+			return mapMatcher.getSpatialMatch(getAvlReport());
+		else
+			return null;
 	}
+
 
+
 	/**
 	 * Sets the block for this VehicleState to null. Also sets assignmentId
 	 * to null and predictable to false.