|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ka2ddo.yaac.filter.Filter
org.ka2ddo.yaac.filter.RadiusFilter
public class RadiusFilter
This class implements a filter based on radius from a specified location (defaulting to the beacon location for the station).
Field Summary | |
---|---|
StationTracker |
TRACKER
|
Fields inherited from class org.ka2ddo.yaac.filter.Filter |
---|
RESULT_NEUTRAL, RESULT_PASS, RESULT_REJECT, RESULT_WEAK_PASS, RESULT_WEAK_REJECT |
Constructor Summary | |
---|---|
RadiusFilter(java.lang.String prefPrefix)
Create a RadiusFilter instance with the specified prefix for the persistence parameter names. |
Method Summary | |
---|---|
int |
acceptAX25Frame(AX25Frame frame)
Indicate whether the specified message should be displayed. |
int |
acceptLatLon(double lat,
double lon)
|
int |
acceptMessage(AX25Message msg)
Indicate whether the specified message should be displayed. |
int |
acceptStation(StationState ss)
Indicate whether the specified station should be displayed. |
void |
addFilterChangeListener(FilterChangeListener l)
Register a listener for changes of this Filter. |
java.lang.Object |
clone()
Creates and returns a copy of this object. |
protected void |
fireFilterChange()
|
java.lang.String |
getFilterHelpTagName()
Report a tag name used to look up JavaHelp for a filter editor. |
java.lang.String |
getFilterTypeTagName()
Report a tag name used to look up the labelling for an editor panel for this editor instance in a ResourceBundle of translated names. |
java.lang.String |
getFilterUIName()
Get the class name of a dynamically loadable class for the the GUI for this filter. |
double |
getLatitude()
Get the latitude center of this filter. |
double |
getLongitude()
Get the longitude center of this filter. |
double |
getRadiusInKM()
Get the current radius in kilometers. |
boolean |
isEnabled()
Test if this RadiusFilter is enabled. |
boolean |
isUseHome()
Test if this RadiusFilter will use the local station's current position or an explicitly configured position. |
void |
removeFilterChangeListener(FilterChangeListener l)
Deregisters a listener. |
void |
setEnabled(boolean enabled)
Specify whether this RadiusFilter is enabled. |
void |
setLatitude(double latitude)
Programmatically change the center point latitude of this RadiusFilter. |
void |
setLongitude(double longitude)
Programmatically change the center point longitude of this RadiusFilter. |
void |
setPrefPrefix(java.lang.String prefPrefix)
Change the persisted parameter prefix for this instance of RadiusFilter. |
void |
setRadiusInKM(double radiusInKM)
Set the current radius in kilometers. |
void |
setToPassall()
Reset the filter to a configuration that would pass the maximum amount of messages, packets, and stations. |
void |
setUseHome(boolean useHome)
Specify if this RadiusFilter will use the local station's current position or an explicitly configured position. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final StationTracker TRACKER
Constructor Detail |
---|
public RadiusFilter(java.lang.String prefPrefix)
prefPrefix
- prefix String (can be empty string "") or null to indicate this filter should not be persistedMethod Detail |
---|
public java.lang.String getFilterUIName()
getFilterUIName
in class Filter
public void setPrefPrefix(java.lang.String prefPrefix)
setPrefPrefix
in interface PersistingFilter
prefPrefix
- prefix String (can be empty string "") or null to indicate this filter should not be persistedpublic double getLatitude()
public void setLatitude(double latitude)
latitude
- latitude in fractional degrees Northpublic double getLongitude()
public void setLongitude(double longitude)
longitude
- longitude in fractional degrees Eastpublic boolean isEnabled()
public void setEnabled(boolean enabled)
enabled
- boolean true if filter should affect processed messagespublic void setToPassall()
setToPassall
in class Filter
public boolean isUseHome()
public void setUseHome(boolean useHome)
useHome
- boolean true if the Radius Filter will use the current GPS position
(if available) or the configured fixed beacon position, false if the
explicitly configured position will be usedpublic double getRadiusInKM()
public void setRadiusInKM(double radiusInKM)
radiusInKM
- radius in kilometerspublic int acceptAX25Frame(AX25Frame frame)
acceptAX25Frame
in class Filter
frame
- the timestamped AX25 frame record to analyze
public int acceptLatLon(double lat, double lon)
public int acceptMessage(AX25Message msg)
acceptMessage
in class Filter
msg
- the APRS Message record to analyze
public int acceptStation(StationState ss)
acceptStation
in class Filter
ss
- StationState record to analyze
public java.lang.String getFilterTypeTagName()
getFilterTypeTagName
in class Filter
public java.lang.String getFilterHelpTagName()
getFilterHelpTagName
in class Filter
public void addFilterChangeListener(FilterChangeListener l)
addFilterChangeListener
in class Filter
l
- FilterChangeListener to registerpublic void removeFilterChangeListener(FilterChangeListener l)
removeFilterChangeListener
in class Filter
l
- FilterChangeListener to deregisterprotected void fireFilterChange()
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
will be true, and that the expression:x.clone() != x
will be true, but these are not absolute requirements. While it is typically the case that:x.clone().getClass() == x.getClass()
will be true, this is not an absolute requirement. By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass(). By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.x.clone().equals(x)
clone
in class Filter
java.lang.CloneNotSupportedException
- if the object's class does not
support the Cloneable
interface. Subclasses
that override the clone
method can also
throw this exception to indicate that an instance cannot
be cloned.Cloneable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |