BeaconData

java.lang.Object
- org.ka2ddo.yaac.io.BeaconData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, AX25FrameSource, SendableMessage, GpsDataListener
```
public class BeaconData
extends java.lang.Object
implements AX25FrameSource, GpsDataListener, java.lang.Cloneable, SendableMessage, java.io.Serializable
```
This class contains all the data associated with a beacon message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BeaconData.BeaconType` Enum defining the APRS message formats that YAAC can use for position beacons.
`static class`	`BeaconData.PositionType` Enum specifying the specific APRS Position Report message type code used for BeaconType.POSITION and BeaconType.COMPRESSED beacon messages in APRS.

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`beaconName` The human-readable identifier for this particular BeaconData object
`XmitEncoding`	`ctcss` Specification of tone or digital squelch used by this repeater.
`java.lang.String[]`	`digipeaters` Digipeater alias combinations to be used for transmitting this beacon, in proportional pathing preference order.
`byte`	`directionality` PHG for compass octant of antenna directionality.
`static java.lang.String[]`	`DIRECTIVITY` Display directionality octant strings for the PHG directionality value.
`boolean`	`enabled` Indicate whether this particular beacon should be transmitted.
`float`	`fixedAltitudeM` The fixed altitude of this station in meters above mean sea level.
`java.lang.String`	`freeText` Free-text comment to be appended after all standard-formatted beacon fields.
`byte`	`gain` PHG code for antenna gain in dB.
`byte`	`height` PHG code for antenna height about average terrain elevation.
`double`	`latitude` Fixed position latitude in fractional degrees North.
`double`	`longitude` Fixed position longitude in fractional degrees East.
`double`	`monitorFreq` The frequency in megaHertz on which this station is doing audio monitoring (zero if no audio monitor).
`static java.lang.String`	`MYCALL` Name for default BeaconData record.
`static java.lang.String`	`NOCALL` Reserved "callsign" for not-yet-specified callsign.
`short`	`offset` The repeater shift direction and magnitude for the repeater input frequency of this station (+1 or -1 for default shift, + or - with an actual number in kiloHertz for non-standard shift).
`BeaconData.PositionType`	`positionType` The sub-variant of human-readable position report message format to use.
`byte`	`power` PHG code for power level.
`boolean`	`reportAltitude` Specify whether altitude (fixed or GPS-reported) should be reported in position reports.
`boolean`	`reportSpeed` Specify whether local GPS speed should be reported in position reports.
`boolean`	`showDFS` Specifies whether DFS (direction finding signal) information should be reported in the position report's free-text comment.
`boolean`	`showPHG` Specify whether PHG (power-height-gain) should be reported in the position report's free-text comment.
`short`	`status` MicE status to report when generating MicE format position reports.
`char`	`symbolCode` The APRS symbol code for this station's symbol.
`char`	`symTableId` The APRS symbol table ID for this station's symbol; this may be an overlay character.
`BeaconData.BeaconType`	`type` APRS format to use for encoding position beacon packet.
`boolean`	`useGpsForPosition` Specifies whether this beacon should ignore its fixed latitude and longitude and use the current position reported by the local GPS receiver.
`boolean`	`useWeather` Specify whether local weather data should be transmitted in the beacon.

Constructor Summary

Constructors
Constructor and Description

BeaconData()

Constructors
Constructor and Description
`BeaconData()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBeaconChangeListener(BeaconChangeListener l)` Register to be informed when the beacon parameters are changed.
`void`	`cancelTransmission()` Cancel all upcoming transmissions of the beacon.
`java.lang.Object`	`clone()` Creates and returns a copy of this object.
`void`	`copyInto(BeaconData bd, java.util.prefs.Preferences root, java.lang.String beaconName)` Copy the contents of this BeaconData object into the specified one, and tell the other one that it was changed if any changes occur.
`AX25Message`	`dup()` Creates and returns a copy of this Message.
`byte[]`	`getBody(boolean countTransmission, byte protocolId, AX25Frame frame)` Get an instance of this message, suitable for transmitting.
`Connector`	`getConnector()` Specify the PortConnector this message should be transmitted through.
`AX25Frame`	`getFrame(boolean incrementXmtCount, BeaconData.BeaconType overrideType, byte protocolId)` Get the AX25Frame of the data to transmit.
`AX25Frame[]`	`getFrames(boolean incrementXmtCount, byte protocolId, java.lang.String senderCallsign)` Get one or more AX25Frames of the data to transmit.
`int`	`getNumTransmitsBeforeDecay()` Get the number of cycles for a complete iteration over the proportional pathing digipeat path set.
`void`	`gpsDataUpdated(GPSDistributor distributor, GpsFix currentFix, boolean isLocal, java.lang.String source)` Do not call.
`boolean`	`isEnabled()` Test if message should still be transmitted.
`boolean`	`isMatchingBeacon(java.lang.String[] allowedBeacons)` Test whether or not this particular beacon is on the approved list for a given APRS or OpenTRAC transmit port.
`void`	`queueForTransmission()` Queue the beacon for transmission after the next transmission interval.
`void`	`queueNow()` Queue the beacon for immediate transmission.
`static BeaconData`	`readFromPreferences(java.util.prefs.Preferences root, java.lang.String beaconName)` Load the beacon settings from Java Preferences.
`void`	`removeBeaconChangeListener(BeaconChangeListener l)` Unregister from being informed when the beacon parameters are changed.
`void`	`resetTransmitCount()` Reinitialize the transmission and backoff counters as if the station was newly on the air.
`void`	`satDataUpdated(GPSDistributor distributor, SatelliteCatalog satCatalog, boolean isLocal, java.lang.String source)` Do not call.
`java.lang.String`	`toString()`
`void`	`writeToPreferences(java.util.prefs.Preferences root, java.lang.String beaconName)` Store the current beacon settings in Java Preferences.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MYCALL
```
public static final java.lang.String MYCALL
```
    Name for default BeaconData record.
    
    See Also:
    
    Constant Field Values
  - NOCALL
```
public static final java.lang.String NOCALL
```
    Reserved "callsign" for not-yet-specified callsign.
    
    See Also:
    
    Constant Field Values
  - beaconName
```
public java.lang.String beaconName
```
    The human-readable identifier for this particular BeaconData object
  - type
```
public BeaconData.BeaconType type
```
    APRS format to use for encoding position beacon packet.
  - positionType
```
public BeaconData.PositionType positionType
```
    The sub-variant of human-readable position report message format to use.
    
    See Also:
    
    BeaconData.BeaconType.POSITION
  - enabled
```
public boolean enabled
```
    Indicate whether this particular beacon should be transmitted.
  - useGpsForPosition
```
public boolean useGpsForPosition
```
    Specifies whether this beacon should ignore its fixed latitude and longitude and use the current position reported by the local GPS receiver.
    
    See Also:
    
    GpsFix, GPSDistributor
  - latitude
```
public double latitude
```
    Fixed position latitude in fractional degrees North.
  - longitude
```
public double longitude
```
    Fixed position longitude in fractional degrees East.
  - reportSpeed
```
public boolean reportSpeed
```
    Specify whether local GPS speed should be reported in position reports.
    
    See Also:
    
    useGpsForPosition
  - reportAltitude
```
public boolean reportAltitude
```
    Specify whether altitude (fixed or GPS-reported) should be reported in position reports.
    
    See Also:
    
    fixedAltitudeM, useGpsForPosition
  - fixedAltitudeM
```
public float fixedAltitudeM
```
    The fixed altitude of this station in meters above mean sea level.
    
    See Also:
    
    reportAltitude
  - symTableId
```
public char symTableId
```
    The APRS symbol table ID for this station's symbol; this may be an overlay character.
  - symbolCode
```
public char symbolCode
```
    The APRS symbol code for this station's symbol.
  - monitorFreq
```
public double monitorFreq
```
    The frequency in megaHertz on which this station is doing audio monitoring (zero if no audio monitor).
  - offset
```
public short offset
```
    The repeater shift direction and magnitude for the repeater input frequency of this station (+1 or -1 for default shift, + or - with an actual number in kiloHertz for non-standard shift).
  - ctcss
```
public XmitEncoding ctcss
```
    Specification of tone or digital squelch used by this repeater.
  - status
```
public short status
```
    MicE status to report when generating MicE format position reports.
  - showPHG
```
public boolean showPHG
```
    Specify whether PHG (power-height-gain) should be reported in the position report's free-text comment.
  - showDFS
```
public boolean showDFS
```
    Specifies whether DFS (direction finding signal) information should be reported in the position report's free-text comment.
  - power
```
public byte power
```
    PHG code for power level.
  - height
```
public byte height
```
    PHG code for antenna height about average terrain elevation.
  - gain
```
public byte gain
```
    PHG code for antenna gain in dB.
  - directionality
```
public byte directionality
```
    PHG for compass octant of antenna directionality.
  - freeText
```
public java.lang.String freeText
```
    Free-text comment to be appended after all standard-formatted beacon fields.
  - useWeather
```
public boolean useWeather
```
    Specify whether local weather data should be transmitted in the beacon.
  - digipeaters
```
public java.lang.String[] digipeaters
```
    Digipeater alias combinations to be used for transmitting this beacon, in proportional pathing preference order.
  - DIRECTIVITY
```
public static final java.lang.String[] DIRECTIVITY
```
    Display directionality octant strings for the PHG directionality value.
    
    See Also:
    
    directionality
- Constructor Detail
  - BeaconData
```
public BeaconData()
```
- Method Detail
  - getBody
```
public byte[] getBody(boolean countTransmission,
                      byte 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 ID to generate the message in, or 0 for default protocol; currently, only NOLVL3 (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
  - getFrames
```
public AX25Frame[] getFrames(boolean incrementXmtCount,
                             byte protocolId,
                             java.lang.String senderCallsign)
```
    Get one or more AX25Frames of the data to transmit.
    
    Specified by:
    
    getFrames in interface AX25FrameSource
    
    Parameters:
    
    incrementXmtCount - indicate whether the transmit counter (used to cycle through proportional pathing) should be incremented
    
    protocolId - indicate the protocol to generate this frame for (not relevant for digipeated frames); zero to indicate current protocol
    
    senderCallsign - String of local callsign sending this message (may be ignored if digipeating a message from another station)
    
    Returns:
    
    array of AX25Frame objects to transmit, or null indicating nothing to transmit in the specified protocol
  - getFrame
```
public AX25Frame getFrame(boolean incrementXmtCount,
                          BeaconData.BeaconType overrideType,
                          byte protocolId)
```
    Get the AX25Frame of the data to transmit.
    
    Parameters:
    
    incrementXmtCount - indicate whether the transmit counter (used to cycle through proportional pathing) should be incremented
    
    overrideType - BeaconType to use to encode this beacon position report, or null to use configured format
    
    protocolId - indicate the protocol to generate this frame for (not relevant for digipeated frames); zero to indicate current protocol
    
    Returns:
    
    array of AX25Frame objects to transmit, or null indicating nothing to transmit in the specified protocol
  - getNumTransmitsBeforeDecay
```
public int getNumTransmitsBeforeDecay()
```
    Get the number of cycles for a complete iteration over the proportional pathing digipeat path set.
    
    Specified by:
    
    getNumTransmitsBeforeDecay in interface AX25FrameSource
    
    Returns:
    
    number of transmissions to do one cycle of proportional pathing (value is 2^(N-1) where N is number of path choices)
  - resetTransmitCount
```
public void resetTransmitCount()
```
    Reinitialize the transmission and backoff counters as if the station was newly on the air.
  - getConnector
```
public Connector getConnector()
```
    Specify the PortConnector this message should be transmitted through.
    
    Specified by:
    
    getConnector in interface AX25FrameSource
    
    Returns:
    
    null for all applicable ports (PortConnector.CAP_XMT_PACKET_DATA and not rejecting this specific packet)
    
    See Also:
    
    Connector.CAP_XMT_PACKET_DATA
  - gpsDataUpdated
```
public void gpsDataUpdated(GPSDistributor distributor,
                           GpsFix currentFix,
                           boolean isLocal,
                           java.lang.String source)
```
    Do not call. Listener that is called by the GPSDistributor when the GPS data has been updated.
    
    Specified by:
    
    gpsDataUpdated in interface GpsDataListener
    
    Parameters:
    
    distributor - instance of the GPSDistributor
    
    currentFix - current position data reported by the local GPS
    
    isLocal - boolean true if this is GPS data for the local station, false if for a remote GPS receiver
    
    source - String name assigned to remote GPS receiver, or null if for the local receiver
  - satDataUpdated
```
public void satDataUpdated(GPSDistributor distributor,
                           SatelliteCatalog satCatalog,
                           boolean isLocal,
                           java.lang.String source)
```
    Do not call. Listener that is called when the satellite constellation in use changes.
    
    Specified by:
    
    satDataUpdated in interface GpsDataListener
    
    Parameters:
    
    distributor - instance of the GPSDistributor
    
    satCatalog - updated SatelliteCatalog instance
    
    isLocal - boolean true if this is GPS data for the local station, false if for a remote GPS receiver
    
    source - String name assigned to remote GPS receiver, or null if for the local receiver
  - addBeaconChangeListener
```
public void addBeaconChangeListener(BeaconChangeListener l)
```
    Register to be informed when the beacon parameters are changed.
    
    Parameters:
    
    l - BeaconChangeListener to register
  - removeBeaconChangeListener
```
public void removeBeaconChangeListener(BeaconChangeListener l)
```
    Unregister from being informed when the beacon parameters are changed.
    
    Parameters:
    
    l - BeaconChangeListener to unregister
  - writeToPreferences
```
public void writeToPreferences(java.util.prefs.Preferences root,
                               java.lang.String beaconName)
                        throws java.util.prefs.BackingStoreException
```
    Store the current beacon settings in Java Preferences.
    
    Parameters:
    
    root - the Preferences node that is the base for YAAC configuration data
    
    beaconName - String name of this beacon instance
    
    Throws:
    
    java.util.prefs.BackingStoreException - if Preferences could not be updated
  - readFromPreferences
```
public static BeaconData readFromPreferences(java.util.prefs.Preferences root,
                                             java.lang.String beaconName)
                                      throws java.util.prefs.BackingStoreException
```
    Load the beacon settings from Java Preferences.
    
    Parameters:
    
    root - the Preferences node that is the base for YAAC configuration data
    
    beaconName - the String name of the beacon instance to load
    
    Returns:
    
    a filled-in BeaconData structure
    
    Throws:
    
    java.util.prefs.BackingStoreException - if the beacon Preferences could not be read
  - queueNow
```
public void queueNow()
```
    Queue the beacon for immediate transmission.
  - queueForTransmission
```
public void queueForTransmission()
```
    Queue the beacon for transmission after the next transmission interval.
  - cancelTransmission
```
public void cancelTransmission()
```
    Cancel all upcoming transmissions of the beacon.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a copy of this object. Note this overrides the default clone() only to change the access control and remove the exception.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this instance.
  - copyInto
```
public void copyInto(BeaconData bd,
                     java.util.prefs.Preferences root,
                     java.lang.String beaconName)
```
    Copy the contents of this BeaconData object into the specified one, and tell the other one that it was changed if any changes occur.
    
    Parameters:
    
    bd - target BeaconData to copy into
    
    root - base Preferences object into which updated BeaconData should be saved (or null to not save)
    
    beaconName - String name of the target BeaconData instance
  - dup
```
public AX25Message dup()
```
    Creates and returns a copy of this Message. Since BeaconData is not actually a message, this returns the message type that would be used to transmit the beacon. Not very efficient, but implemented to meet the interface specification.
    
    Specified by:
    
    dup in interface SendableMessage
    
    Returns:
    
    the AX25Message used to transmit this beacon
  - isMatchingBeacon
```
public boolean isMatchingBeacon(java.lang.String[] allowedBeacons)
```
    Test whether or not this particular beacon is on the approved list for a given APRS or OpenTRAC transmit port. Note that an empty beacon name list matches the default beacon (MYCALL).
    
    Parameters:
    
    allowedBeacons - String array of acceptable beacon names for the port
    
    Returns:
    
    boolean true if this beacon can be transmitted through the requesting port

Class BeaconData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MYCALL

NOCALL

beaconName

type

positionType

enabled

useGpsForPosition

latitude

longitude

reportSpeed

reportAltitude

fixedAltitudeM

symTableId

symbolCode

monitorFreq

offset

ctcss

status

showPHG

showDFS

power

height

gain

directionality

freeText

useWeather

digipeaters

DIRECTIVITY

Constructor Detail

BeaconData

Method Detail

getBody

getFrames

getFrame

getNumTransmitsBeforeDecay

resetTransmitCount

getConnector

gpsDataUpdated

satDataUpdated

addBeaconChangeListener

removeBeaconChangeListener

writeToPreferences

readFromPreferences

queueNow

queueForTransmission

cancelTransmission

toString

isEnabled

clone

copyInto

dup

isMatchingBeacon