org.ka2ddo.aprs

Class UltimeterRawMessage

java.lang.Object

org.ka2ddo.ax25.AX25Message

org.ka2ddo.aprs.Message

org.ka2ddo.aprs.UltimeterRawMessage

All Implemented Interfaces:

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

public class UltimeterRawMessage
extends Message

This class represents a message decoded from a Peet Bros Ultimeter weather station (APRS protocol specification chapter 12). It also can decode Peet Bros messages from a local weather station without going through APRS first, so this same code can be used in both use cases.

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.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
UltimeterRawMessage(byte[] body, int offset, java.lang.String tp, long rcvTimestamp) Constructor for Ultimeter raw weather message when decoding a binary AX.25 frame.

Method Summary

Modifier and Type	Method and Description
boolean	isSymbolInferred() Report whether the non-null APRS symbol reported by this message is explicit or inferred from destination or source callsign.
java.lang.String	paramString() Descriptive text about this message, to be included in the toString() method's response.
static boolean	parseWeatherLine(java.lang.String line, java.util.Map<java.lang.Enum,java.lang.Object> currentWeather, long msgRcptTime) Decode a line of text supposedly containing one of the Ultimeter weather station ASCII text formats, as documented on the Peet Bros website.

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, 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

Constructor Detail

UltimeterRawMessage

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

Constructor for Ultimeter raw weather 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

Method Detail

parseWeatherLine

public static boolean parseWeatherLine(java.lang.String line,
                                       java.util.Map<java.lang.Enum,java.lang.Object> currentWeather,
                                       long msgRcptTime)

Decode a line of text supposedly containing one of the Ultimeter weather station ASCII text formats, as documented on the Peet Bros website.

Parameters:

line - String containing a weather report

currentWeather - a Map to store the weather parameters in

msgRcptTime - time weather sentence was received in Java milliseconds since Jan 1 19780 UTC

Returns:

boolean true if message was successfully parsed

paramString

public java.lang.String paramString()

Descriptive text about this message, to be included in the toString() method's response. This method may be overridden, and the override may concatenate the results of the superclass's paramString) method with additional text of its own. This default implementation returns the free-text comment of this APRS message.

Overrides:

paramString in class Message

Returns:

String describing the contents of this message

See Also:

Message.toString(), Message.getComment()

isSymbolInferred

public boolean isSymbolInferred()

Report whether the non-null APRS symbol reported by this message is explicit or inferred from destination or source callsign. Intended to be overridden by message types which can infer a symbol but can't explicitly specify the symbol.

Overrides:

isSymbolInferred in class Message

Returns:

boolean true if symbol is inferred