pt.lsts.imc

Class GpsFix

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.GpsFix

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class GpsFix
extends IMCMessage

IMC Message GPS Fix (253)
Report of a GPS fix.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GpsFix.TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static int	GFV_VALID_COG
static int	GFV_VALID_DATE
static int	GFV_VALID_HACC
static int	GFV_VALID_HDOP
static int	GFV_VALID_POS
static int	GFV_VALID_SOG
static int	GFV_VALID_TIME
static int	GFV_VALID_VACC
static int	GFV_VALID_VDOP
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
GpsFix()
GpsFix(IMCDefinition defs)
GpsFix(IMCMessage msg)
GpsFix(int validity, GpsFix.TYPE type, int utc_year, short utc_month, short utc_day, float utc_time, double lat, double lon, float height, short satellites, float cog, float sog, float hdop, float vdop, float hacc, float vacc)

Method Summary

Modifier and Type	Method and Description
static GpsFix	clone(IMCMessage msg)
static GpsFix	create(java.lang.Object... values)
double	getCog()
double	getHacc()
double	getHdop()
double	getHeight()
double	getLat()
double	getLon()
short	getSatellites()
double	getSog()
GpsFix.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
short	getUtcDay()
short	getUtcMonth()
double	getUtcTime()
int	getUtcYear()
double	getVacc()
int	getValidity()
double	getVdop()
GpsFix	setCog(double cog)
GpsFix	setHacc(double hacc)
GpsFix	setHdop(double hdop)
GpsFix	setHeight(double height)
GpsFix	setLat(double lat)
GpsFix	setLon(double lon)
GpsFix	setSatellites(short satellites)
GpsFix	setSog(double sog)
GpsFix	setType(GpsFix.TYPE type)
GpsFix	setTypeStr(java.lang.String type)
GpsFix	setTypeVal(short type)
GpsFix	setUtcDay(short utc_day)
GpsFix	setUtcMonth(short utc_month)
GpsFix	setUtcTime(double utc_time)
GpsFix	setUtcYear(int utc_year)
GpsFix	setVacc(double vacc)
GpsFix	setValidity(int validity)
GpsFix	setVdop(double vdop)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageInfo, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseJson, parseXml, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GFV_VALID_DATE

public static final int GFV_VALID_DATE

See Also:

Constant Field Values

GFV_VALID_TIME

public static final int GFV_VALID_TIME

See Also:

Constant Field Values

GFV_VALID_POS

public static final int GFV_VALID_POS

See Also:

Constant Field Values

GFV_VALID_COG

public static final int GFV_VALID_COG

See Also:

Constant Field Values

GFV_VALID_SOG

public static final int GFV_VALID_SOG

See Also:

Constant Field Values

GFV_VALID_HACC

public static final int GFV_VALID_HACC

See Also:

Constant Field Values

GFV_VALID_VACC

public static final int GFV_VALID_VACC

See Also:

Constant Field Values

GFV_VALID_HDOP

public static final int GFV_VALID_HDOP

See Also:

Constant Field Values

GFV_VALID_VDOP

public static final int GFV_VALID_VDOP

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

GpsFix

public GpsFix()

GpsFix

public GpsFix(IMCMessage msg)

GpsFix

public GpsFix(IMCDefinition defs)

GpsFix

public GpsFix(int validity,
              GpsFix.TYPE type,
              int utc_year,
              short utc_month,
              short utc_day,
              float utc_time,
              double lat,
              double lon,
              float height,
              short satellites,
              float cog,
              float sog,
              float hdop,
              float vdop,
              float hacc,
              float vacc)

Method Detail

create

public static GpsFix create(java.lang.Object... values)

clone

public static GpsFix clone(IMCMessage msg)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getValidity

public int getValidity()

Returns:

Validity (bitfield) - uint16_t

setValidity

public GpsFix setValidity(int validity)

Parameters:

validity - Validity (bitfield)

getType

public GpsFix.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public GpsFix setType(GpsFix.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public GpsFix setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public GpsFix setTypeVal(short type)

Parameters:

type - Type (integer value)

getUtcYear

public int getUtcYear()

Returns:

UTC Year - uint16_t

setUtcYear

public GpsFix setUtcYear(int utc_year)

Parameters:

utc_year - UTC Year

getUtcMonth

public short getUtcMonth()

Returns:

UTC Month - uint8_t

setUtcMonth

public GpsFix setUtcMonth(short utc_month)

Parameters:

utc_month - UTC Month

getUtcDay

public short getUtcDay()

Returns:

UTC Day - uint8_t

setUtcDay

public GpsFix setUtcDay(short utc_day)

Parameters:

utc_day - UTC Day

getUtcTime

public double getUtcTime()

Returns:

UTC Time of Fix (s) - fp32_t

setUtcTime

public GpsFix setUtcTime(double utc_time)

Parameters:

utc_time - UTC Time of Fix (s)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public GpsFix setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public GpsFix setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getHeight

public double getHeight()

Returns:

Height above WGS-84 ellipsoid (m) - fp32_t

setHeight

public GpsFix setHeight(double height)

Parameters:

height - Height above WGS-84 ellipsoid (m)

getSatellites

public short getSatellites()

Returns:

Number of Satellites - uint8_t

setSatellites

public GpsFix setSatellites(short satellites)

Parameters:

satellites - Number of Satellites

getCog

public double getCog()

Returns:

Course Over Ground (rad) - fp32_t

setCog

public GpsFix setCog(double cog)

Parameters:

cog - Course Over Ground (rad)

getSog

public double getSog()

Returns:

Speed Over Ground (m/s) - fp32_t

setSog

public GpsFix setSog(double sog)

Parameters:

sog - Speed Over Ground (m/s)

getHdop

public double getHdop()

Returns:

Horizontal Dilution of Precision - fp32_t

setHdop

public GpsFix setHdop(double hdop)

Parameters:

hdop - Horizontal Dilution of Precision

getVdop

public double getVdop()

Returns:

Vertical Dilution of Precision - fp32_t

setVdop

public GpsFix setVdop(double vdop)

Parameters:

vdop - Vertical Dilution of Precision

getHacc

public double getHacc()

Returns:

Horizontal Accuracy Estimate (m) - fp32_t

setHacc

public GpsFix setHacc(double hacc)

Parameters:

hacc - Horizontal Accuracy Estimate (m)

getVacc

public double getVacc()

Returns:

Vertical Accuracy Estimate (m) - fp32_t

setVacc

public GpsFix setVacc(double vacc)

Parameters:

vacc - Vertical Accuracy Estimate (m)