/*
This file is part of RouteConverter.
RouteConverter is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
RouteConverter 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 RouteConverter; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Copyright (C) 2007 Christian Pesch. All Rights Reserved.
*/
package slash.navigation.columbus;
import slash.navigation.base.ParserContext;
import slash.navigation.base.WaypointType;
import slash.navigation.base.Wgs84Position;
import java.io.File;
import java.io.PrintWriter;
import java.util.HashSet;
import java.util.Set;
import java.util.prefs.Preferences;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static java.lang.Math.abs;
import static java.util.Arrays.asList;
import static slash.common.io.Transfer.escape;
import static slash.common.io.Transfer.formatDoubleAsString;
import static slash.common.io.Transfer.formatIntAsString;
import static slash.common.io.Transfer.parseDouble;
import static slash.common.io.Transfer.trim;
import static slash.navigation.base.RouteComments.isPositionDescription;
import static slash.navigation.common.NavigationConversion.formatAccuracyAsString;
/**
* Reads and writes Columbus GPS Professional (.csv) files.
*
* Header: INDEX,TAG,DATE,TIME,LATITUDE N/S,LONGITUDE E/W,HEIGHT,SPEED,HEADING,FIX MODE,VALID,PDOP,HDOP,VDOP,VOX
* Format: 8 ,T,090508,075646,48.174411N,016.284588E,-235 ,0 ,0 ,3D,SPS ,1.6 ,1.3 ,0.9 ,
*
* @author Christian Pesch
*/
public class ColumbusGpsProfessionalFormat extends ColumbusGpsFormat {
private static final Preferences preferences = Preferences.userNodeForPackage(ColumbusGpsProfessionalFormat.class);
private static final String HEADER_LINE = "INDEX,TAG,DATE,TIME,LATITUDE N/S,LONGITUDE E/W,HEIGHT,SPEED,HEADING,FIX MODE,VALID,PDOP,HDOP,VDOP,VOX";
private static final Pattern HEADER_PATTERN = Pattern.
compile("INDEX,TAG,DATE,TIME,LATITUDE N/S,LONGITUDE E/W,(HEIGHT|ALTITUDE),SPEED,HEADING,FIX MODE,VALID,PDOP,HDOP,VDOP,VOX");
private static final Pattern LINE_PATTERN = Pattern.
compile(BEGIN_OF_LINE +
SPACE_OR_ZERO + "(\\d+)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([" + VALID_TAG_VALUES + "])" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "(\\d*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "(\\d*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([\\d\\.]+)([NS])" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([\\d\\.]+)([WE])" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([-\\d]+)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "(\\d+)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "(\\d+)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([^" + SEPARATOR + "]*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([^" + SEPARATOR + "]*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([\\d\\.]*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([\\d\\.]*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([\\d\\.]*)" + SPACE_OR_ZERO + SEPARATOR +
SPACE_OR_ZERO + "([^" + SEPARATOR + "]*)" + SPACE_OR_ZERO +
END_OF_LINE);
private static final Set<String> VALID_FIX_MODES = new HashSet<>(asList("2D", "3D"));
private static final Set<String> VALID_VALID = new HashSet<>(asList("SPS", "DGPS"));
public String getName() {
return "Columbus GPS Professional (*" + getExtension() + ")";
}
protected Pattern getLinePattern() {
return LINE_PATTERN;
}
private boolean hasValidField(String line, String field, Set<String> validValues) {
if (field != null && !validValues.contains(field)) {
log.severe("Field for '" + line + "' is invalid. Contains '" + field + "' but expecting '" + validValues + "'");
return preferences.getBoolean("ignoreInvalidFix", false);
}
return true;
}
protected boolean hasValidFix(String line, Matcher matcher) {
return hasValidField(line, trim(matcher.group(12)), VALID_FIX_MODES) &&
hasValidField(line, trim(matcher.group(13)), VALID_VALID);
}
protected String getHeader() {
return HEADER_LINE;
}
protected Pattern getHeaderPattern() {
return HEADER_PATTERN;
}
protected Wgs84Position parsePosition(String line, ParserContext context) {
Matcher lineMatcher = LINE_PATTERN.matcher(line);
if (!lineMatcher.matches())
throw new IllegalArgumentException("'" + line + "' does not match");
WaypointType waypointType = parseTag(trim(lineMatcher.group(2)));
String date = lineMatcher.group(3);
String time = lineMatcher.group(4);
Double latitude = parseDouble(lineMatcher.group(5));
String northOrSouth = lineMatcher.group(6);
if ("S".equals(northOrSouth) && latitude != null)
latitude = -latitude;
Double longitude = parseDouble(lineMatcher.group(7));
String westOrEasth = lineMatcher.group(8);
if ("W".equals(westOrEasth) && longitude != null)
longitude = -longitude;
String height = lineMatcher.group(9);
String speed = lineMatcher.group(10);
String heading = lineMatcher.group(11);
String pdop = lineMatcher.group(14);
String hdop = lineMatcher.group(15);
String vdop = lineMatcher.group(16);
String description = parseDescription(removeZeros(lineMatcher.group(17)), removeZeros(lineMatcher.group(1)), waypointType);
Wgs84Position position = new Wgs84Position(longitude, latitude, parseDouble(height), parseDouble(speed),
parseDateAndTime(date, time), description,
context.getFile() != null ? new File(context.getFile().getParentFile(), description) : null);
position.setWaypointType(waypointType);
position.setHeading(parseDouble(heading));
position.setPdop(parseDouble(pdop));
position.setHdop(parseDouble(hdop));
position.setVdop(parseDouble(vdop));
return position;
}
protected void writePosition(Wgs84Position position, PrintWriter writer, int index, boolean firstPosition) {
String date = fillWithZeros(formatDate(position.getTime()), 6);
String time = fillWithZeros(formatTime(position.getTime()), 6);
String latitude = formatDoubleAsString(abs(position.getLatitude()), 6);
String northOrSouth = position.getLatitude() != null && position.getLatitude() < 0.0 ? "S" : "N";
String longitude = formatDoubleAsString(abs(position.getLongitude()), 6);
String westOrEast = position.getLongitude() != null && position.getLongitude() < 0.0 ? "W" : "E";
String height = fillWithZeros(position.getElevation() != null ? formatIntAsString(position.getElevation().intValue()) : "0", 5);
String speed = fillWithZeros(position.getSpeed() != null ? formatIntAsString(position.getSpeed().intValue()) : "0", 4);
String heading = fillWithZeros(position.getHeading() != null ? formatIntAsString(position.getHeading().intValue()) : "0", 3);
String pdop = fillWithZeros(position.getPdop() != null ? formatAccuracyAsString(position.getPdop()) : "", 5);
String hdop = fillWithZeros(position.getHdop() != null ? formatAccuracyAsString(position.getHdop()) : "", 5);
String vdop = fillWithZeros(position.getVdop() != null ? formatAccuracyAsString(position.getVdop()) : "", 5);
String description = !isPositionDescription(position.getDescription()) ? position.getDescription() : "";
writer.println(fillWithZeros(Integer.toString(index + 1), 6) + SEPARATOR +
formatTag(position) + SEPARATOR +
date + SEPARATOR + time + SEPARATOR +
latitude + northOrSouth + SEPARATOR +
longitude + westOrEast + SEPARATOR +
height + SEPARATOR +
speed + SEPARATOR +
heading + SEPARATOR +
"3D" + SEPARATOR +
"SPS" + SEPARATOR +
pdop + SEPARATOR +
hdop + SEPARATOR +
vdop + SEPARATOR +
fillWithZeros(escape(description, SEPARATOR, ';'), 8));
}
}