|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--wonderly.jeaprs.aprs.data.APRS
This class represents all of the parameters that are part of the JeAPRS
application environment. However, these properties are also common to most
types of APRS applications. This class is thus a properties management class
that has setters and getters for all the properties. What JeAPRS modules do
is get a reference to the single instance of this class for themselves to use.
The getPropertiesInstance()
method is a static method
that allows the rest of the modules in the system to get a reference to the single
instance. Many clien apps in JeAPRS refer to their reference as 'APRS'.
Note that this is a class local variable in their context, not a static reference
to this class! Thus there are declarions of the form APRS APRS
in
these classes.
Applications using the JeAPRS library may find that there are other types of global data properties that need to be used between modules. This clas can be subclassed in those applications to provide the extra parameters. This class may also be extended over time to contain other properties as experience indicates the need.
Field Summary | |
int |
beaconSecs
|
static int |
POSIT_INFO_CSESPD
Send the course and speed extra data with a posit |
static int |
POSIT_INFO_DF
Send direction finding extra data with a posit |
static int |
POSIT_INFO_NONE
Send no extra data with a posit |
static int |
POSIT_INFO_PHG
Send power, height and gain extra data with a posit |
static int |
POSIT_INFO_RADIORNG
Send radio range extra data with a posit |
boolean |
traceInPkt
|
boolean |
traceOutPkt
|
Method Summary | |
void |
addBadPacketListener(wonderly.jeaprs.aprs.BadPacketListener lis)
|
void |
addDirectStation(java.lang.String call)
|
void |
addHeardStation(java.lang.String call)
Used to add a station's call to the set of calls heard by this station. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener lis)
Adds a property Change listener to be notified when properties in this object are changed |
int |
getAltitude()
|
int |
getBeaconInterval()
|
java.lang.String |
getBeaconMessage()
|
java.lang.String |
getCommPort()
Set the name of the Serial communications port to use for TNC access |
java.lang.String |
getConfigFile()
Gets the name of the application configuration file. |
int |
getCourse()
|
java.lang.String |
getCurrentCall()
Returns the currently refered to call sign based on the user selecting call signs from maps, tables or otherwise. |
java.lang.String |
getDefaultMap()
|
int |
getDFPower()
|
int |
getDirectivity()
|
int |
getDirectStationCount()
|
java.util.Enumeration |
getDirectStations()
|
java.util.Date |
getDirectStationTime(java.lang.String call)
|
int |
getGain()
|
wonderly.jeaprs.aprs.packet.APRSGps |
getLastGPS()
Returns the last valid NMEA sentence data. |
java.lang.String |
getMaidenHead()
Returns the Maiden Head grid square string for this station |
long |
getMapLat()
|
long |
getMapLon()
|
int |
getMaxHeardStations()
|
java.lang.String |
getMyCall()
Get the call sign to use for this station |
long |
getMyLat()
|
long |
getMyLon()
|
boolean |
getOpenDefaultMap()
|
java.lang.String |
getPath()
Get the UNPROTO path to use for this station |
int |
getPositInfoType()
|
int |
getPower()
|
static wonderly.jeaprs.aprs.data.APRS |
getPropertiesInstance()
|
int |
getRadioRange()
|
boolean |
getSendMaidenHeadInStatus()
|
boolean |
getSendPosits()
|
boolean |
getSendStatus()
|
int |
getSpeed()
|
int |
getStatInterval()
Minutes interval between stat transmissions |
int |
getStationHeight()
|
java.lang.String |
getStatusMessage()
|
int |
getStrength()
|
char |
getSymChar()
|
char |
getSymTable()
|
wonderly.jeaprs.aprs.data.APRSUI |
getUI()
Gets the current APRSUI object used by this application |
java.lang.String |
getUnProto()
|
boolean |
getUseRelativeDirection()
For mobile ops, the direction indication of other stations can either be relative to the course of the mobile, or relative to north. |
java.util.Enumeration |
heardStations()
Enumerations the stations heard by this station either direct or via a digipeater. |
boolean |
isBeaconMessaging()
|
boolean |
isCheckMemory()
If some features are memory intensive, they should check this return value to see if the user wants them to consider their memory use. |
boolean |
isDigipeating()
|
boolean |
isDirty()
|
boolean |
isKissMode()
|
boolean |
isLowMemory()
|
boolean |
isMessagingAvailable()
Does this station has APRS text messaging facilities. |
boolean |
isSendingCseSpd()
|
boolean |
isSendingDF()
|
boolean |
isSendingPHP()
|
boolean |
isSendingRange()
|
boolean |
isSendTimeStatus()
|
boolean |
isStartup()
Is the JeAPRS system starting up. |
boolean |
isStatusMessaging()
|
boolean |
isTimeInPosit()
|
boolean |
isTraceInPackets()
|
boolean |
isTraceOutPackets()
|
void |
logBadPacket(byte[] arr,
java.lang.Throwable ex)
|
void |
notifyPropertyChange(java.beans.PropertyChangeEvent ev)
Used to notify all listeners when a property change occurs. |
void |
removeBadPacketListener(wonderly.jeaprs.aprs.BadPacketListener lis)
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener lis)
Removes a property change listener |
void |
setAltitude(int feet)
|
void |
setBeaconInterval(int secs)
|
void |
setBeaconMessage(java.lang.String str)
Sets the posit beacon message string to use |
void |
setBeaconMessaging(boolean how)
Set whether or not a message is sent when a posit beacon is sent. |
void |
setCheckMemory(boolean how)
Used to control whether low memory conditions should control memory intensive features |
void |
setCommPort(java.lang.String port)
Get the name of the Serial communications port to use for TNC access |
void |
setConfigFile(java.lang.String name)
Set the name of the config file to use for this application |
void |
setCourse(int course)
Sets the current course of the station. |
void |
setCurrentCall(java.lang.String call)
Sets currently selected call sign being referred to. |
void |
setDefaultMap(java.lang.String name)
|
void |
setDFPower(int rng)
|
void |
setDigipeating(boolean how)
|
void |
setDirectivity(int dir)
Sets the encoded directivity of the station's antenna |
void |
setDirty(boolean how)
sets the modified/dirty state of this object so that the application will know to save its contents |
void |
setGain(int gain)
Sets the encoded gain associated with the stations antenna |
void |
setKissMode(boolean how)
Configures whether JeAPRS is operating in Kiss mode. |
void |
setLastGPS(wonderly.jeaprs.aprs.packet.APRSGps gps)
Sets the current GPS information pertaining to this station. |
void |
setLowMemory(boolean how)
This method is used by code in the application which can determine whether the application is running in a low memory environment. |
void |
setMaidenHead(java.lang.String str)
Sets the MaidenHead grid string used for the location of this station. |
void |
setMapLat(long lat)
Set last map latitude in seconds (include fractions of a second) |
void |
setMapLon(long lon)
Set last map longitude in seconds (include fractions of a second) |
void |
setMaxHeardStations(int max)
Sets the maximum number of heard stations that should be tracked by the application. |
void |
setMessagingAvailable(boolean how)
set whether this station has APRS text messaging facilities |
void |
setMyCall(java.lang.String newCall)
Sets the call sign to use for this station |
void |
setMyLat(long lat)
Set latitude in seconds (include fractions of a second) |
void |
setMyLon(long lon)
Set longitude in seconds (include fractions of a second) |
void |
setOpenDefaultMap(boolean how)
|
void |
setPath(java.lang.String newPath)
Sets the UNPROTO path to use for packet transmissions from this station. |
void |
setPositInfoType(int how)
|
void |
setPower(int power)
Sets the APRS power value. |
void |
setRadioFrequency(wonderly.jeaprs.aprs.data.RadioFrequency freq)
This method is used to set radios to particular frequencies. |
void |
setRadioRange(int rng)
|
void |
setSendingCseSpd(boolean how)
|
void |
setSendingDF(boolean how)
|
void |
setSendingPHP(boolean how)
|
void |
setSendingRange(boolean how)
|
void |
setSendMaidenHeadInStatus(boolean how)
|
void |
setSendPosits(boolean how)
Set whether this station sends out position reports |
void |
setSendStatus(boolean how)
Set whether this station sends out status reports |
void |
setSendTimeStatus(boolean how)
|
void |
setSpeed(int speed)
Sets the current speed of the station. |
void |
setStartup(boolean how)
Set the startup state of the system |
void |
setStatInterval(int val)
Returns minute interval for status messages |
void |
setStationHeight(int height)
Sets the encoded station's antenna height |
void |
setStatusMessage(java.lang.String str)
Sets the status message to use for the status for this station. |
void |
setStatusMessaging(boolean how)
Set whether or not status messages/packets are sent for this station |
void |
setStrength(int strength)
Sets the encoded signal strength |
void |
setSymChar(char sym)
Sets the symbol to use for this stations icon. |
void |
setSymTable(char tab)
Sets the symbol table character to use either '/' or '\\' for denoting the symbol table to use for the symbol associated with this station, or one of the letters, 'A'-'Z' or numbers '0'-'9' to overlay a symbol from the alternate symbol table with such a character. |
void |
setTimeInPosit(boolean how)
|
void |
setTraceInPackets(boolean how)
|
void |
setTraceOutPackets(boolean how)
|
void |
setUI(wonderly.jeaprs.aprs.data.APRSUI ui)
Sets the APRSUI object to be used by this application |
void |
setUnProto(java.lang.String val)
Set the UnProto string used for TNC initialization. |
void |
setUseRelativeDirection(boolean how)
Sets whether directions to other stations should be indicated as relative to the course of this station or relative to north. |
void |
writeProperties()
Called to notify the application that the properties should be saved on exit. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int POSIT_INFO_NONE
public static final int POSIT_INFO_CSESPD
public static final int POSIT_INFO_PHG
public static final int POSIT_INFO_RADIORNG
public static final int POSIT_INFO_DF
public int beaconSecs
public boolean traceInPkt
public boolean traceOutPkt
Method Detail |
public boolean isTraceInPackets()
public void setTraceInPackets(boolean how)
public boolean isTraceOutPackets()
public void setTraceOutPackets(boolean how)
public boolean isStartup()
public void setStartup(boolean how)
isStartup()
public void setRadioFrequency(wonderly.jeaprs.aprs.data.RadioFrequency freq)
public void setUnProto(java.lang.String val)
public java.lang.String getUnProto()
public void addDirectStation(java.lang.String call)
public java.util.Enumeration getDirectStations()
public int getDirectStationCount()
public java.util.Date getDirectStationTime(java.lang.String call)
public void addBadPacketListener(wonderly.jeaprs.aprs.BadPacketListener lis)
public void removeBadPacketListener(wonderly.jeaprs.aprs.BadPacketListener lis)
public void logBadPacket(byte[] arr, java.lang.Throwable ex)
public static wonderly.jeaprs.aprs.data.APRS getPropertiesInstance()
public java.lang.String getDefaultMap()
public void setDefaultMap(java.lang.String name)
public boolean getOpenDefaultMap()
public void setOpenDefaultMap(boolean how)
public boolean isKissMode()
public void setKissMode(boolean how)
APRS
public boolean isSendTimeStatus()
public boolean isMessagingAvailable()
public void setMessagingAvailable(boolean how)
public boolean isTimeInPosit()
public void setTimeInPosit(boolean how)
public void setSendTimeStatus(boolean how)
public int getPositInfoType()
public void setPositInfoType(int how)
public int getRadioRange()
public int getAltitude()
public void setAltitude(int feet)
public void setDigipeating(boolean how)
public boolean isDigipeating()
public boolean isSendingPHP()
public boolean isSendingCseSpd()
public boolean isSendingRange()
public boolean isSendingDF()
public void setSendingPHP(boolean how)
public void setSendingCseSpd(boolean how)
public void setSendingRange(boolean how)
public void setSendingDF(boolean how)
public void setRadioRange(int rng)
public int getDFPower()
public void setDFPower(int rng)
public java.util.Enumeration heardStations()
public void addHeardStation(java.lang.String call)
public int getMaxHeardStations()
public void setMaxHeardStations(int max)
heardStations()
will always track all
heard stations so that such information is available. But the application
should use getMaxHeardStations()
to control how many total stations
that it shows the user in displays.
public void addPropertyChangeListener(java.beans.PropertyChangeListener lis)
public void removePropertyChangeListener(java.beans.PropertyChangeListener lis)
public void notifyPropertyChange(java.beans.PropertyChangeEvent ev)
public void setUI(wonderly.jeaprs.aprs.data.APRSUI ui)
public wonderly.jeaprs.aprs.data.APRSUI getUI()
public boolean getUseRelativeDirection()
public void setUseRelativeDirection(boolean how)
how
- true for course relative direction to others, false for relative to north.getUseRelativeDirection()
public boolean isCheckMemory()
isLowMemory()
to limit
their memory use as much as possible.
public void setCheckMemory(boolean how)
how
- true to cause memory availability to be checked.public boolean isLowMemory()
public void setLowMemory(boolean how)
how
- true if memory is scarce and features should be limited because of thissetCheckMemory(boolean)
public java.lang.String getConfigFile()
public void setConfigFile(java.lang.String name)
public java.lang.String getCommPort()
public void setCommPort(java.lang.String port)
port
- the name of the port as in COM1, COM2 or even /dev/ttyS1 in linuxpublic void setCurrentCall(java.lang.String call)
public java.lang.String getCurrentCall()
setCurrentCall(String)
public wonderly.jeaprs.aprs.packet.APRSGps getLastGPS()
public void setLastGPS(wonderly.jeaprs.aprs.packet.APRSGps gps)
public java.lang.String getMyCall()
public java.lang.String getPath()
public void setPath(java.lang.String newPath)
public void setMyCall(java.lang.String newCall)
getMyCall()
public void setMaidenHead(java.lang.String str)
public java.lang.String getMaidenHead()
public boolean getSendMaidenHeadInStatus()
public void setSendMaidenHeadInStatus(boolean how)
public void setPower(int power)
public int getPower()
public void setStrength(int strength)
public int getStrength()
public void setStationHeight(int height)
public int getStationHeight()
public void setCourse(int course)
public int getCourse()
public void setSpeed(int speed)
setCourse(int)
public int getSpeed()
public void setGain(int gain)
public int getGain()
public void setDirectivity(int dir)
public int getDirectivity()
public void setSymTable(char tab)
public void setSymChar(char sym)
setSymTable(char)
public char getSymTable()
public char getSymChar()
public java.lang.String getStatusMessage()
public void setStatusMessage(java.lang.String str)
public boolean isStatusMessaging()
public void setStatusMessaging(boolean how)
public boolean isBeaconMessaging()
public void setBeaconMessaging(boolean how)
public java.lang.String getBeaconMessage()
public void setBeaconMessage(java.lang.String str)
public void setSendPosits(boolean how)
public boolean getSendPosits()
public void setSendStatus(boolean how)
public boolean getSendStatus()
public void setMyLon(long lon)
public long getMyLon()
public void setBeaconInterval(int secs)
public int getBeaconInterval()
public void setMyLat(long lat)
public long getMyLat()
public void setMapLon(long lon)
public long getMapLon()
public void setMapLat(long lat)
public long getMapLat()
public int getStatInterval()
public void setStatInterval(int val)
public boolean isDirty()
setDirty(false)
was called, false if notpublic void setDirty(boolean how)
public void writeProperties()
setDirty(true)
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |