org.ka2ddo.aprs

Class StationCapabilities

java.lang.Object

org.ka2ddo.ax25.AX25Message

org.ka2ddo.aprs.Message

org.ka2ddo.aprs.StationCapabilities

All Implemented Interfaces:

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

public class StationCapabilities
extends Message
implements SendableMessage

This class decodes a Station Capabilities message (APRS protocol specification chapter 15).

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[]	capabilityArray Ordered array of capability Strings for an APRS station.

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
StationCapabilities(byte[] body, int offset, java.lang.String tp, long rcvTimestamp) Constructor for Station Capabilities message when decoding a binary AX.25 frame.
StationCapabilities(java.util.List<java.lang.String> params) Constructor for building an outgoing Station Capabilities message.
StationCapabilities(java.lang.String[] params) Constructor for building an outgoing Station Capabilities 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.
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

capabilityArray

public java.lang.String[] capabilityArray

Ordered array of capability Strings for an APRS station.

Constructor Detail

StationCapabilities

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

Constructor for Station Capabilities 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

StationCapabilities

public StationCapabilities(java.lang.String[] params)

Constructor for building an outgoing Station Capabilities message.

Parameters:

params - array of capability Strings

StationCapabilities

public StationCapabilities(java.util.List<java.lang.String> params)

Constructor for building an outgoing Station Capabilities message.

Parameters:

params - List of capability Strings

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 - number of times the message has been transmitted

protocolId - AX.25 protocol type for this message

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