Defining Fields Within the File
Prev | Appendix C. GPSBabel XCSV Style Files | Next

## Defining Fields Within the File

A field defines data. There are two different classifications of FIELDS, IFIELD (file input) and OFIELD (file output). In the absence of any OFIELDS, IFIELDS are use as both input and output. The existence of OFIELDS is primarily to allow more flexible mapping of GPSBabel data to output data (say, for instance, to map the internal GPSBabel "description" variable to two or more fields on output). For all practical purposes, IFIELDS and OFIELDS are defined the same way in the style file.

The following per-field options are defined:

- "no_delim_before" is supported on in OFIELD tags to specify that this field should be written without a field delimiter before it. It's useful for limited field concatenation.

- "absolute" is supported on OFIELD tags for lat and lon to indicate that only absolute values (never negative) are to be printed.

- "optional" is supported only OFIELD tags and indicates that the field may or may not be available in the source data. If the field is absent, no trailing field separator is written.

  This attribute is most useful when paired with "no_delim_before" as it allows you to concatenate fields without concern for whether those fields are actually populated or not.

There are several different types of fields that may be defined. Each field consists of three pieces of information: the FIELD TYPE, a DEFAULT VALUE, and a PRINTF CONVERSION (for output). In many cases, not all pieces are used, but all 3 pieces are required. Additionally, an fourth field is supported that modifies the behaviour of the field being described.

FIELDS should be defined in the style file in the logical order that they appear in the data, from left to right. This is the order in which they are parsed from input and written to output.

The fields used by the XCSV parser are as follows:

### IGNORE

IGNORE fields are, guess what, ignored on input. Internally, IGNORE fields are treated as CHARACTER data, and as such, require a printf conversion for a character array.

examples:

       IFIELD IGNORE,"","%14.14s"   # (writes a 14 character blank field)
       IFIELD IGNORE,"","%s"        # (writes a blank field on output)

### CONSTANT

CONSTANT fields are, of course, constant. They are ignored on input, however they write CONSTANT data on output. As such, they require a DEFAULT VALUE and a printf conversion for a character array.

examples:

       IFIELD CONSTANT,"FFFFFF","%s"   # (writes "FFFFFF" in the field)
       IFIELD CONSTANT,"01/01/70","%s" # (a constant date field)

### INDEX

An INDEX field is used ONLY on output. The INDEX constant defines a field that, at output, contains the sequence number of the waypoint being written, starting at 0. An index is managed internally as an INTEGER and requires an INTEGER printf conversion. An INDEX has one special property. The DEFAULT VALUE of the index is added to the index on each iteration (to allow indexes starting at 1, 100, etc..).

examples:

       IFIELD INDEX,"0","%04d"     # (Starts counting at zero)
       IFIELD INDEX,"","%04d"      # (Starts counting at zero)
       IFIELD INDEX,"1","%04d"     # (Starts counting at one)

### SHORTNAME

A SHORTNAME is generally the waypoint name of the data being processed. SHORTNAME maps directly to the GPSBabel variable ->shortname. A SHORTNAME is CHARACTER data and requires a character array printf conversion.

example:

       IFIELD SHORTNAME,"","%s"

### DESCRIPTION

A DESCRIPTION is generally a long description of the waypoint. A DESCRIPTION maps to the GPSBabel variable ->description and is otherwise handled exactly like a SHORTNAME.

examples:

       IFIELD DESCRIPTION,"","%s"

### NOTES

NOTES are generally everything else about a waypoints. NOTES map to the GPSBabel variable ->notes and is otherwise handled exactly like a SHORTNAME.

### URL

URL is a URL for the waypoint. URL maps to the GPSBabel variable ->url and is otherwise handled exactly like a SHORTNAME.

example:

       IFIELD URL,"","%s"

### URL_LINK_TEXT

URL_LINK_TEXT is a textual description of where a URL points. URL_LINK_TEXT maps to the GPSBabel variable ->url_link_text and is otherwise handled exactly like a SHORTNAME.

example:

       IFIELD URL_LINK_TEXT,"","%s"

### ICON_DESCR

ICON_DESCR is a textual description of an icon type for a waypoint. ICON_DESCR maps to the GPSBabel variable ->icon_desc and is otherwise handled exactly like a SHORTNAME.

example:

       IFIELD ICON_DESCR,"","%s"

### LAT_DECIMAL

LAT_DECIMAL defines LATITUDE in DECIMAL format. Note that this is a PURE signed decimal format (i.e. -91.0000). This data is handled internally as a DOUBLE PRECISION FLOAT and requires a FLOATING POINT printf conversion.

example:

       IFIELD LAT_DECIMAL,"","%f"

### LON_DECIMAL

See LAT_DECIMAL, except LON_DECIMAL defines LONGITUDE.

### LAT_INT32DEG

LAT_INT32DEG defines LATITUDE in what I call INT32DEGREES. This value is a signed LONG INTEGER and requires a LONG INTEGER printf conversion. (This format is only used by some DeLorme products.)

example:

       IFIELD LAT_INT32DEG,"","%ld"

### LON_INT32DEG

See LON_INT32DEG except LON_INT32DEG defines LONGITUDE.

### LAT_DECIMALDIR / LAT_DIRDECIMAL

LAT_DECIMALDIR and LAT_DIRDECIMAL define LATITUDE in DECIMAL format with the added bonus of a 'N/S' or 'E/W' direction character. This data is handled internally as a DOUBLE PRECISION FLOAT and a single CHARACTER and requires a FLOATING POINT as well as a CHARACTER printf conversion. The only difference between the two is whether the directional character appears before (LAT_DIRDECIMAL) or after (LAT_DECIMALDIR) the decimal number.

examples:

       IFIELD LAT_DECIMALDIR,"","%f %c"     #  (writes 31.333 N)
       IFIELD LAT_DIRDECIMAL,"","%c %f"     #  (writes N 31.333)

### LON_DECIMALDIR / LON_DIRDECIMAL

Same as LAT_DECIMALDIR / LAT_DIRDECIMAL except LON_ defines LONGITUDE.

### LAT_DIR / LON_DIR

LAT_DIR returns the single character 'N' or 'S' depending on the hemisphere of the latitude. LON_DIR returns 'E' or 'W' depending on the hemisphere of the longitude.

### LAT_HUMAN_READABLE

LAT_HUMAN_READABLE defines LATITUDE in a human-readable format. This format is probably the most expressive format. It is similar to LAT_DECIMALDIR in that it requires multiple printf conversions, but it is far more flexible as to the contents of those conversions. On read, the printf conversions are ignored and GPSBabel attempts to determine the latitude and longitude based on what is in the file.

examples:

       #  (writes N 31 40.000)
       IFIELD LAT_HUMAN_READABLE,"","%c %d %f"
       #  (writes "31 deg 40.000 min N")
       IFIELD LAT_HUMAN_READABLE,"","%d deg %f min %c"
       #  Note that this string will confuse the reading routine due
       #  to the letter "n" in "min" and the letter "e" in "deg."
       # (writes 31 40 00.000N)
       IFIELD LAT_HUMAN_READABLE,"","%d %d %f%c"

### MAP_EN_BNG

MAP_EN_BNG converts coordinates from/to British National Grid (BNG).

The only supported order of the items is: Map,Easting,Northing. During output all coordinates have to be located within this limited area.

examples:

       IFIELD MAP_EN_BNG,"","%s%5d %5d"   #  (writes i.e. "SJ00001 00001")
       IFIELD MAP_EN_BNG,"","%s %d %d"    #  (writes i.e. "TQ 888 999")

### LON_HUMAN_READABLE

See LAT_HUMAN_READABLE except LON_HUMAN_READABLE defines LONGITUDE.

### LATLON_HUMAN_READABLE

LATLON_HUMAN_READABLE is like LAT_HUMAN_READABLE and LON_HUMAN_READABLE except that it reads and writes both latitude and longitude as a single field. On write, the same format specifier is used for both coordinates. On read, GPSBabel does exactly the same thing it does for LAT_HUMAN_READABLE or LON_HUMAN_READABLE.

example:

       IFIELD LATLON_HUMAN_READABLE,"","%c %d %f"
               # (writes "N 31 40.126 W 85 09.62" as a single field)

### LAT_NMEA

Defines the latitude in the format used by the NMEA standard which is degrees multiplied by 100 plus decimal minutes.

example:

       IFIELD  LAT_NMEA, "%f", "%08.3f"     # (writes  3558.322)

### LAT_DDMMDIR

Derived from the LAT_NMEA latitude format, with degrees * 100 plus decimal minutes, but using an additional specifier to position the 'N' or 'S' instead of a leading minus sign (or absence thereof) to give direction from zero.

     IFIELD LAT_DDMMDIR, "%f", "%08.3f%c" # (writes "5334.192S" giving -53.56987 degrees latitude)

### LON_NMEA

Defines the longitude in the format used by the NMEA standard which is degrees multiplied by 100 plus decimal minutes.

Example:

       IFIELD  LON_NMEA, "%f", "%010.3f"  # (writes -08708.082)

### LON_DDMMDIR

Derived from the LON_NMEA longitude format, with degrees * 100 plus decimal minutes, but using an additional character format character to position the 'E' or 'W' instead of a leading minus sign (or absence thereof) to give direction from zero.

Example:

     IFIELD LON_DDMMDIR, "%f", "%010.3f%c" # (writes "01232.745W" giving -12.54575 degrees
    longitude)

### LAT_10EX / LON_10EX

Defines the latitude or longitude in the format used i.e. by TomTom Navigator itinerary files. It is degress multiplied by 10 power X. X have to be replaced with a valid decimal value. A factor of 10000 would be generated by LAT_10E5 as shown in the examples below.

examples:

       IFIELD  LAT_10E5, "%f", "%.f"       # (writes  3558322)

       IFIELD  LON_10E5, "%f", "%.f"       # (writes -8708082)

### ALT_FEET

ALT_FEET is the position's ALTITUDE in FEET. This value is treated as a SIGNED DOUBLE PRECISION FLOAT and requires a FLOATING POINT printf conversion.

example:

       IFIELD ALT_FEET,"","%.0f"

### ALT_METERS

ALT_METERS is identical to ALT_FEET with the exception that the altitude is in METERS.

### HEART_RATE

Heart rate, measured in beats per minute. Only valid for units with heart rate monitor features (i.e. Garmin Forerunner 301).

example:

       IFIELD HEART_RATE,"","%d"

### CADENCE

Cadence in revolutions per minute. Only valid for units with heart rate monitor features (i.e. Garmin Edge 305).

example:

       IFIELD CADENCE,"","%d"

### EXCEL_TIME

EXCEL_TIME is the waypoint's creation time, if any. This is actually the decimal days since 1/1/1900 and is handled internally as a DOUBLE PRECISION FLOAT and requires a FLOATING POINT printf conversion.

example:

       IFIELD EXCEL_TIME,"","%11.5f"

### TIMET_TIME

TIMET_TIME is the waypoint's creation time, if any. This is actually the integer seconds since 1/1/1970 (let's not start the holy war) and is handled internally as a LONG INTEGER and requires a LONG INTEGER printf conversion.

example:

       IFIELD TIMET_TIME,"","%ld"

### YYYYMMDD_TIME

YYYYMMDD_TIME is the waypoint's creation time, if any. It's a single decimal field containing four digits of year, two digits of month, and two digits of date. Internally it is a LONG INTEGER and thus requires a LONG INTEGER printf conversion.

example:

       IFIELD YYYYMMDD_TIME,"","%ld"

### GMT_TIME

GMT_TIME is the waypoint's creation time, in UTC time zone. It uses the strptime conversion format tags.

example:

       IFIELD GMT_TIME,"","%m/%d/%Y %I:%M:%D %p"

Search the web for 'strptime man page' for details strptime, but one such page can be found at http://www.die.net/doc/linux/man/man3/strptime.3.html

### LOCAL_TIME

LOCAL_TIME is the waypoint's creation time, in the local time zone. It uses strptime conversion format tags. See GMT_TIME for a reference.

example:

       IFIELD LOCAL_TIME,"","%y-%m-%d"

### HMSG_TIME

HMSG_TIME parses up to three time parts and am/pm string to add this value to the previously parsed *_TIME field that contains only a date. On output, will print the time in UTC.

example:

       IFIELD HMSG_TIME,"","%d:%d:%d %s"

### HMSL_TIME

HMSG_TIME parses up to three time parts and am/pm string to add this value to the previously parsed *_TIME field that contains only a date. On output, will print the time in local time.

example:

       IFIELD HMSL_TIME,"","%dh%dm"

### ISO_TIME

ISO_TIME is the waypoint's creation time, in ISO 8601 format, which include time zone information. It is expected to be in the format yyyy-mm-ddThh:mm:sszzzzz where zzzzzz is the local time offset or the character Z for UTC time. On output, UTC 'Z' time zone will always be used.

example:

       IFIELD ISO_TIME,"","%s"

### ISO_TIME_MS

ISO_TIME_MS is much like ISO_TIME, but expresses milliseconds at the end of the timestamp. It is thus in the format yyyy-mm-ddThh:mm:ss.SSSzzzzz where 'SSS' is milliseconds and zzzzzz is the local time offset or the character Z for UTC time. On output, UTC 'Z' time zone will always be used.

example:

       IFIELD ISO_TIME_MS,"","%s"

### GEOCACHE_DIFF

GEOCACHE_DIFF is valid only for geocaches and represents a DOUBLE PRECISION FLOAT. This is the geocache "difficulty" rating as defined by Groundspeak. A "three and a half star" cache would therefore be "3.5"

example:

       IFIELD GEOCACHE_DIFF,"","%3.1f"

### GEOCACHE_TERR

GEOCACHE_TERR is valid only for geocaches and represents a DOUBLE PRECISION FLOAT. This is the geocache "terrain" rating as defined by Groundspeak. A "three and a half star" cache would therefore be "3.5"

example:

       IFIELD GEOCACHE_TERR,"","%3.1f"

### GEOCACHE_CONTAINER

GEOCACHE_CONTAINER is valid only for geocaches and is heavily influenced by the Groundspeak container types. Examples would include "Micro" and "Virtual".

example:

       GEOCACHE_CONTAINER,"","%s"

### GEOCACHE_TYPE

GEOCACHE_TYPE is valid only for geocaches and is heavily influenced by the Groundspeak cache types. Examples would include "Event cache" and "Multi-Cache".

example:

       GEOCACHE_TYPE,"","%s"

### GEOCACHE_PLACER

GEOCACHE_PLACER is a string containing the name of the placer of a geocache.

example:

       GEOCACHE_PLACER,"","%s"

### GEOCACHE_ISAVAILABLE

GEOCACHE_ISAVAILABLE is a string containing "True" or "False" indicating whether a geocache is currently available or not.

example:

       GEOCACHE_ISAVAILABLE,"","%s"

### GEOCACHE_ISARCHIVED

GEOCACHE_ISARCHIVED is a string containing "True" or "False" indicating whether a geocache has been archived.

example:

       GEOCACHE_ISARCHIVED,"","%s"

### GEOCACHE_LAST_FOUND

A long integer in format YYYYMMDD containing the last time this geocache was found.

example:

       GEOCACHE_LAST_FOUND,"","%ld"

### GEOCACHE_HINT

The hint for this geocache. No additional transformation (such as rot13) will be performed on this string.

example:

       GEOCACHE_HINT,"","%s"

### PATH_DISTANCE_MILES

PATH_DISTANCE_MILES outputs the total length of the route or track from the start point to the current point, in miles. This and the altitude could be used to create an elevation profile. PATH_DISTANCE_MILES is a DOUBLE PRECISION FLOAT.

PATH_DISTANCE_MILES is not valid as an input field.

PATH_DISTANCE_MILES is only meaningful if the data comes from a track or a route; waypoint data will generate essentially meaningless output.

example:

       PATH_DISTANCE_MILES,"","%f"

### PATH_DISTANCE_KM

PATH_DISTANCE_KM is like PATH_DISTANCE_MILES except it outputs the length in kilometers.

### PATH_SPEED

Speed in meters per second. Gpsbabel does NOT calculate this data by default; it is read from the input file if present. (If not present, it may be calculated with the track filter.)

example:

       PATH_SPEED,"","%f"

### PATH_SPEED_KPH

Like PATH_SPEED but means kilometers per hour.

example:

       PATH_SPEED_KPH,"","%.1f"

### PATH_SPEED_MPH

Like PATH_SPEED but means miles per hour.

example:

       PATH_SPEED_MPH,"","%.1f"

### PATH_SPEED_KNOTS

Like PATH_SPEED but means knots (nautical).

example:

       PATH_SPEED_KNOTS,"","%.1f"

### PATH_COURSE

Course in degerees. Gpsbabel does not calculate this data by default; it is read from the input file if present. (If not present, it may be calculated with the track filter.)

example:

       PATH_COURSE,"","%f"

### GPS_HDOP / GPS_VDOP / GPS_PDOP

GPS horizontal / vertical / positional dilution of precision parameters. Needs float conversion.

example:

       GPS_HDOP,"","%f"

### GPS_SAT

Number of satellites used for determination of the position. Needs integer conversion.

example:

       GPS_SAT,"","%d"

### GPS_FIX

Type of fix (see GPX spec or track filter). Needs string conversion.

example:

       GPS_FIX,"","%s"

### TRACK_NAME

The name of the track currently being operated on. Needs string conversion.

example:

    TRACK_NAME, "", "%s"

### ROUTE_NAME

The name of the route currently being operated on. Needs string conversion.

example:

    ROUTE_NAME, "", "%s"

### STREET_NAME

Street address including house number. Notice that this is not used for any geocoding, it's merely textual description associated with a position.

example:

    STREET_ADDR, "", "%s"

### CITY

The name of a city. Sometimes part of "Points of Interest". This is simple textual data associated with a position, no geocoding will be done..

example:

    CITY, "", "%s"

### COUNTRY

The name of a country associated with a position.

example:

    COUNTRY, "", "%s"

### FACILITY

The name of a facility to associate with a position.

example:

    FACILITY, "", "%s"

### PHONE_NR

A phone number associated with a position. This is just textual data attached for convenience.

example:

    PHONE_NR, "", "%s"

### POSTAL_CODE

A postal code to associate with a position. It is freeform text and is not used by GPSBabel for any geocoding or such.

example:

    POSTAL_CODE, "", "%s"

### FILENAME

The name of the input file from where the points were loaded. This field is available only on output.

example:

    OFIELD FILENAME, "", "%s"

### FORMAT

The name of the input format from where format the points came. This field is available only on output.

example:

    OFIELD FORMAT, "", "%s"

Prev | Up | Next
Defining the Layout of the File | Home | Examples