org.ka2ddo.aprs

Interface ExtraAPRSInfoSourceDispatcher.APRSIfc

Enclosing class:

ExtraAPRSInfoSourceDispatcher

public static interface ExtraAPRSInfoSourceDispatcher.APRSIfc

This interface defines a source of additional information in APRS free-text comment format. The implementation is responsible to ensure that its additions do not make the resulting packet exceed the maximum body length for an APRS packet.

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
void	addDataToFreeTextComment(java.lang.String objectName, java.lang.StringBuilder commentBuilder, int lengthOfComment) Add any additional information to the text body of the APRS packet that this implementation deems necessary.

Method Detail

addDataToFreeTextComment

void addDataToFreeTextComment(java.lang.String objectName,
                              java.lang.StringBuilder commentBuilder,
                              int lengthOfComment)

Add any additional information to the text body of the APRS packet that this implementation deems necessary. The implementor is required to ensure the total packet length (length of commentBuilder upon entry plus the trailing lengthOfComment plus whatever this code adds) does not exceed the maximum length for an APRS packet (generally, 256 bytes minus about 40 bytes for I-gate third-party header text).

Parameters:

objectName - String name of object being reported, or null if the local station is being reported

commentBuilder - StringBuilder used to assemble the packet body

lengthOfComment - int number of bytes the caller wants to tack on after all extension implementors are done stretching the packet