Package org.ka2ddo.aprs

Class MicE

java.lang.Object

org.ka2ddo.ax25.AX25Message

org.ka2ddo.aprs.Message

org.ka2ddo.aprs.PositionMessage

org.ka2ddo.aprs.MicE

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AX25Message>, CommentedMessage, SendableMessage

public class MicE
extends PositionMessage
implements SendableMessage

This class defines a Mic-E message (APRS protocol specification chapter 10).

Author:

Andrew Pavlin, KA2DDO

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.ax25.AX25Message

AX25Message.Precedence

Field Summary

Fields inherited from class org.ka2ddo.aprs.PositionMessage

abc, altitude, altitudeUnit, COMPRESSED_LAT_SCALING, CONV_MPH_TO_METERS_PER_SEC, DHM, enabledForTransmit, fLatitude, fLatPrecision, fLongitude, fmtMonitorFreq, HMS, HUNDREDTH_MINUTE_F, isCustom, latitude, LN_BASE1_08, longitude, ONE_DEGREE_F, ONE_MINUTE_F, TEN_MINUTES_F, TENTH_MINUTE_F

Fields inherited from class org.ka2ddo.aprs.Message

appendCR, APRS_AND_OPENTRAC_AND_RAW, APRS_AND_RAW, comment, msgType, S_PERMANENT, S_PERMANENT_UC, symbolCode, symTableId

Fields inherited from class org.ka2ddo.ax25.AX25Message

APRS_AND_OPENTRAC, ax25Frame, extensions, invalid, originatingCallsign, originatingDest, PERMANENT, rcptTime, thirdParty, timestamp, UTC

Constructor Summary

Constructors

Constructor	Description
MicE(byte[] body, int offset, String thirdParty, AX25Callsign dest, long rcvTimestamp)	Decode a Mic-E message from a byte array,
MicE(long now)	Alternate constructor for creating a locally-originated MicE message.

Method Summary

Modifier and Type	Method	Description
void	disableForTransmit()	Specify that message should no longer be transmitted.
static String	encodeDestination(double latitude, double longitude, byte status, boolean isCustom)	Build the tocall destination "callsign" for a Mic-E message, containing the latitude, the status, and part of the longitude information.
byte[]	getBody(boolean countTransmission, ProtocolFamily protocolId, AX25Frame frame)	Get an instance of this message, suitable for transmitting.
char	getMicETypeCode()	Get the Mic-E type code of the transmitter (if one exists).
AX25Message.Precedence	getPrecedence()	Report the traffic-handling precedence for this message instance.
String	getRadioModel()	Get the model string (if any) decoded from the Mic-E model type codes in the free-text field.
static boolean	isUseExperimentalYAACModelCode()	Test whether locally-generated Mic-E messages should use an experimental model code for YAAC.
String	paramString()	Descriptive text about this message, to be included in the toString() method's response.
static void	setUseExperimentalYAACModelCode(boolean useExperimentalYAACModelCode)	Specify whether locally-generated Mic-E messages should use an experimental model code for YAAC.

Methods inherited from class org.ka2ddo.aprs.PositionMessage

appendAreaParameters, appendRepeaterParameters, appendSignpostParameters, bodyEquals, createObjectFromThisPosition, decodeDataExtension, decodeLatitude, decodeLongitude, decodeOnlyLatitude, decodeOnlyLongitude, encodeLatitudeCompressed, encodeLatitudePlainText, encodeLongitudeCompressed, encodeLongitudePlainText, extractCompressedLatitude, extractCompressedLongitude, extractLatitude, extractLongitude, getAbc, getAltitude, getAltitudeUnit, getLatitude, getLatitudeAccuracy, getLongitude, hasPosition, isCustom, isEnabled, isShowDate, isUsingCompressedFormat, looksLikeFrequency, looksLikeFrequency, setAbc, setAmbiguity, setCustom, setLatitude, setLocation, setLongitude, setShowDate, testIfValidCompressedLocation

Methods inherited from class org.ka2ddo.aprs.Message

compareTo, decodeDatestamp, decodeHurricaneParams, decodeTimestamp, decodeWeatherParams, decodeWeatherParams, dup, encodeTimestamp, extractComment, extractComment, extractSymbol, formatBody, getComment, getExtensionString, getMsgType, getProtocols, getSymbolCode, getSymTableId, hasWeather, inferSymbol, isAppendCR, isSymbolInferred, looksLikeLongFormatLatitude, setAppendCR, setComment, setSymbolCode, setSymTableId, toString

Methods inherited from class org.ka2ddo.ax25.AX25Message

equals, extractSource, getAx25Frame, getExtension, getFirstDigipeat, getLastDigipeat, getNthDigipeat, getOriginalDestination, getOriginalSource, getOriginatingCallsign, getOriginatingDest, getRcptTime, getReadOnlyExtensionMap, getTimestamp, hashCode, hasThisFirstDigi, indexOf, indexOf, isDirect, isInvalid, isRf, onlyDigits, onlyDigits, onlyDigitsOrMinus, onlyDigitsOrPeriod, onlyDigitsOrSpace, onlyDigitsPlus, onlyPeriods, setAx25Frame, setInvalid, setOriginatingCallsign, setRcptTime, setTimestamp, split, storeExtension

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ka2ddo.ax25.SendableMessage

dup, isEnabled

Constructor Details

MicE

public MicE(byte[] body,
 int offset,
 String thirdParty,
 AX25Callsign dest,
 long rcvTimestamp)

Decode a Mic-E message from a byte array,

Parameters:

body - byte array containing the Mic-E message

offset - index into the byte array where the Mic-E message starts

thirdParty - third-party routing path, or null if not routed from another network

dest - destination callsign (to extract part of the position and status information from)

rcvTimestamp - time in Java milliseconds since 1 Jan 1970 UTC when this message was received

MicE

public MicE(long now)

Alternate constructor for creating a locally-originated MicE message.

Parameters:

now - current time in milliseconds since midnight Jan 1 1970 UTC

Method Details

paramString

public String paramString()

Descriptive text about this message, to be included in the toString() method's response.

Overrides:

paramString in class PositionMessage

Returns:

String describing the contents of this message

See Also:

• Message.toString()

getRadioModel

public String getRadioModel()

Get the model string (if any) decoded from the Mic-E model type codes in the free-text field.

Returns:

model String, or null if no known model

getPrecedence

public AX25Message.Precedence getPrecedence()

Report the traffic-handling precedence for this message instance.

Overrides:

getPrecedence in class Message

Returns:

Precedence level for this Message

encodeDestination

public static String encodeDestination(double latitude,
 double longitude,
 byte status,
 boolean isCustom)

Build the tocall destination "callsign" for a Mic-E message, containing the latitude, the status, and part of the longitude information.

Parameters:

latitude - latitude in fractional degrees North

longitude - longitude in fractional degrees East

status - Mic-E status code in the range 0 to 7

isCustom - boolean true if this is a custom status code instead of a standard status code

Returns:

tocall destination callsign String to use with transmitted Mic-E message

getBody

public byte[] getBody(boolean countTransmission,
 ProtocolFamily protocolId,
 AX25Frame frame)

Get an instance of this message, suitable for transmitting.

Specified by:

getBody in interface SendableMessage

Parameters:

countTransmission - number of times the message has been transmitted.

protocolId - ProtocolFamily to generate the message in; currently, only APRS and OPENTRAC are supported.

frame - AX25Frame into which the message will be placed; the decoded message (as opposed to the byte array encoding) should be stored into the field frame.parsedAX25Msg

Returns:

byte array of message, or null if message body cannot be generated in specified protocol, or retransmission count has been exceeded.

See Also:

• AX25Frame.parsedAX25Msg

disableForTransmit

public void disableForTransmit()

Specify that message should no longer be transmitted.

Specified by:

disableForTransmit in interface SendableMessage

getMicETypeCode

public char getMicETypeCode()

Get the Mic-E type code of the transmitter (if one exists).

Returns:

type code character

isUseExperimentalYAACModelCode

public static boolean isUseExperimentalYAACModelCode()

Test whether locally-generated Mic-E messages should use an experimental model code for YAAC.

Returns:

boolean true if locally originated Mic-E messages have a model code

setUseExperimentalYAACModelCode

public static void setUseExperimentalYAACModelCode(boolean useExperimentalYAACModelCode)

Specify whether locally-generated Mic-E messages should use an experimental model code for YAAC.

Parameters:

useExperimentalYAACModelCode - boolean true if locally originated Mic-E messages have a model code