org.ka2ddo.aprs

Class Query

java.lang.Object

org.ka2ddo.ax25.AX25Message

org.ka2ddo.aprs.Message

org.ka2ddo.aprs.Query

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<AX25Message>, CommentedMessage, ScopeableMessage, SendableMessage

public class Query
extends Message
implements ScopeableMessage

This class defines a broadcast general Query message (APRS protocol specification chapter 15). Queries can be both transmitted and received.

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

Modifier and Type	Field and Description
java.lang.String	queryType Query type (text between question marks '?' in the message).
double	rangeDistance Radius of range limit in statute miles.
double	rangeLatitude Latitude in fractional degrees North of center of query range limit.
double	rangeLongitude Longitude in fractional degrees East of center of query range limit.

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 and Description
Query(byte[] body, int offset, java.lang.String tp, long rcvTimestamp) Constructor for Query message when decoding a binary AX.25 frame.
Query(java.lang.String queryType) Constructor for locally-originated (outbound) general Query message.

Method Summary

Modifier and Type	Method and Description
void	disableForTransmit() Specify that message should no longer be transmitted.
byte[]	getBody(boolean countTransmission, ProtocolFamily protocolId, AX25Frame frame) Get an instance of this message, suitable for transmitting.
Scope	getScope() Get the transmission scope for this message (so the digipeat path can be derived).
boolean	isEnabled() Test if message should still be transmitted.
java.lang.String	paramString() Descriptive text about this message, to be included in the toString() method's response.

Methods inherited from class org.ka2ddo.aprs.Message

bodyEquals, compareTo, decodeDatestamp, decodeHurricaneParams, decodeTimestamp, decodeWeatherParams, decodeWeatherParams, dup, encodeTimestamp, extractComment, extractComment, extractSymbol, formatBody, getComment, getExtensionString, getMsgType, getPrecedence, 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, hasPosition, 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

Field Detail

queryType

public final java.lang.String queryType

Query type (text between question marks '?' in the message).

rangeLatitude

public double rangeLatitude

Latitude in fractional degrees North of center of query range limit.

rangeLongitude

public double rangeLongitude

Longitude in fractional degrees East of center of query range limit.

rangeDistance

public double rangeDistance

Radius of range limit in statute miles.

Constructor Detail

Query

public Query(byte[] body,
             int offset,
             java.lang.String tp,
             long rcvTimestamp)

Constructor for Query message when decoding a binary AX.25 frame.

Parameters:

body - byte array of frame body

offset - int array index offset for start of message (non-zero for encapsulated messages)

tp - third-party relay String for encapsulated messages, or null for no third-party wrapper

rcvTimestamp - Unix time when message was actually received by YAAC

Query

public Query(java.lang.String queryType)

Constructor for locally-originated (outbound) general Query message.

Parameters:

queryType - String of general query to make

Method Detail

paramString

public java.lang.String paramString()

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

Overrides:

paramString in class Message

Returns:

String describing the contents of this message

See Also:

Message.toString()

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 - ignored, because queries are always the same

protocolId - AX.25 protocol to format message in

frame - AX25Frame into which the message will be placed, so any alternate AX25Message can be linked to it

Returns:

byte array of message

See Also:

AX25Frame.parsedAX25Msg

isEnabled

public boolean isEnabled()

Test if message should still be transmitted.

Specified by:

isEnabled in interface SendableMessage

Returns:

boolean true if message should still be transmitted

disableForTransmit

public void disableForTransmit()

Specify that message should no longer be transmitted.

Specified by:

disableForTransmit in interface SendableMessage

getScope

public Scope getScope()

Get the transmission scope for this message (so the digipeat path can be derived).

Specified by:

getScope in interface ScopeableMessage

Returns:

Scope of this message