org.transitime.avl.calAmp

Class MiniEventReport

java.lang.Object

org.transitime.avl.calAmp.Report

org.transitime.avl.calAmp.MiniEventReport

public class MiniEventReport
extends Report

Contains info for a CalAmp mini event report which is a simple GPS report. Documentation is at https://puls.calamp.com/wiki/LM_Direct_Reference_Guide# Mini_Event_Report_Message_.28Message_Type_10.29

Author:

SkiBu Smith

Method Summary

Modifier and Type	Method and Description
byte	getCommunicationState()
long	getEpochTime() Actually the message time, not the true GPS fix time, but it should be the same.
byte	getEventCode()
byte	getFixStatus()
java.lang.String	getFixStatusStr() Returns string representing the error status of the fix.
short	getHeading()
byte	getInputs()
double	getLat()
double	getLon()
int	getMessageTime() Actually the message time, not the true GPS fix time, but it should be the same.
static MiniEventReport	getMiniEventReport(OptionsHeader optionsHeader, MessageHeader messageHeader, byte[] bytes, int offset) Reads MiniEventReport from byte stream starting at the offset, which should be just past the message header.
short	getNumberSatellites()
float	getSpeed()
boolean	isValidGps() Whether GPS fix is actually valid.
void	process() Converts the CalAmp MiniEventReport into a an AvlReport and processes it.
java.lang.String	toString()

Methods inherited from class org.transitime.avl.calAmp.Report

main, parseReport

Methods inherited from class java.lang.Object

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

Method Detail

getMiniEventReport

public static MiniEventReport getMiniEventReport(OptionsHeader optionsHeader,
                                                 MessageHeader messageHeader,
                                                 byte[] bytes,
                                                 int offset)

Reads MiniEventReport from byte stream starting at the offset, which should be just past the message header.

Parameters:

optionsHeader -

messageHeader -

bytes -

offset -

Returns:

The MiniEventReport

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMessageTime

public int getMessageTime()

Actually the message time, not the true GPS fix time, but it should be the same. Only message time is available for mini event reports.

Returns:

epoch time in seconds

getEpochTime

public long getEpochTime()

Actually the message time, not the true GPS fix time, but it should be the same. Only message time is available for mini event reports.

Returns:

epoch time in msec

getLat

public double getLat()

getLon

public double getLon()

getHeading

public short getHeading()

Returns:

Speed in degrees clockwise from true north

getSpeed

public float getSpeed()

Returns:

Speed in meters/second

getFixStatus

public byte getFixStatus()

getFixStatusStr

public java.lang.String getFixStatusStr()

Returns string representing the error status of the fix. If not an error status then null is returned.

Returns:

Fix status if error, otherwise null

isValidGps

public boolean isValidGps()

Whether GPS fix is actually valid. Looks at top 4 bits of fixStatus to determine if Invalid Time, Invalid Fix, Last Known, or Historic are set. If any of those bits are set then the fix is considered invalid.

Returns:

true if GPS is not valid

getNumberSatellites

public short getNumberSatellites()

getCommunicationState

public byte getCommunicationState()

getInputs

public byte getInputs()

getEventCode

public byte getEventCode()

process

public void process()

Converts the CalAmp MiniEventReport into a an AvlReport and processes it.

Specified by:

process in class Report