Package org.ka2ddo.yaac.filter
Class OperatorPresentFilter
java.lang.Object
org.ka2ddo.yaac.filter.Filter
org.ka2ddo.yaac.filter.OperatorPresentFilter
- All Implemented Interfaces:
Cloneable
This filter optionally eliminates all messages from unmanned stations. Note this may not be
a particularly useful filter, as very few APRS stations use the 'O' overlay to indicate there
is a human operator at the station.
- Author:
- Andrew Pavlin, KA2DDO
-
Field Summary
Fields inherited from class org.ka2ddo.yaac.filter.Filter
RESULT_NEUTRAL, RESULT_PASS, RESULT_REJECT, RESULT_WEAK_PASS, RESULT_WEAK_REJECT
-
Constructor Summary
ConstructorDescriptionCreate a Filter that optionally omits unmanned stations. -
Method Summary
Modifier and TypeMethodDescriptionint
acceptAX25Frame
(AX25Frame frame) Indicate whether the specified message should be displayed.int
acceptMessage
(AX25Message axmsg) Indicate whether the specified message should be displayed.int
Indicate whether the specified station should be displayed.void
Register a listener for changes of this Filter.boolean
Specifies that this filter may reject some stations, messages, and/or frames.clone()
Creates and returns a copy of this object.Report a tag name used to look up JavaHelp for a filter editor.Get the ResourceBundle resource name for looking up the localized name of this Filter.Get the class name of a dynamically loadable class for the the GUI for this filter.boolean
isState()
Report whether this filter is rejecting unmanned stations.void
Deregisters a listener.void
setState
(boolean state) Specify whether this filter should reject unmanned stations.void
Reset the filter to a configuration that would pass the maximum amount of messages, packets, and stations.
-
Constructor Details
-
OperatorPresentFilter
public OperatorPresentFilter()Create a Filter that optionally omits unmanned stations.
-
-
Method Details
-
isState
public boolean isState()Report whether this filter is rejecting unmanned stations.- Returns:
- boolean true if stations not reporting the manned 'O' symbol overlay in their symbol will be rejected
-
setState
public void setState(boolean state) Specify whether this filter should reject unmanned stations.- Parameters:
state
- boolean true if stations not reporting the manned 'O' symbol overlay in their symbol will be rejected
-
acceptAX25Frame
Indicate whether the specified message should be displayed.- Specified by:
acceptAX25Frame
in classFilter
- Parameters:
frame
- the timestamped AX25 frame record to analyze- Returns:
- RESULT_xxx constant indicating if message information should be displayed
-
acceptMessage
Indicate whether the specified message should be displayed.- Specified by:
acceptMessage
in classFilter
- Parameters:
axmsg
- the AX25Message record to analyze- Returns:
- RESULT_xxx constant indicating if message information should be displayed
-
acceptStation
Indicate whether the specified station should be displayed.- Specified by:
acceptStation
in classFilter
- Parameters:
ss
- StationState record to analyze- Returns:
- RESULT_xxx constant indicating if station information should be displayed
-
getFilterTypeTagName
Get the ResourceBundle resource name for looking up the localized name of this Filter.- Specified by:
getFilterTypeTagName
in classFilter
- Returns:
- String resource name
-
getFilterHelpTagName
Report a tag name used to look up JavaHelp for a filter editor.- Specified by:
getFilterHelpTagName
in classFilter
- Returns:
- String name (as defined in HelpMap.jhm) for this filter's online help, or null if there is no filter specific help
-
setToPassall
public void setToPassall()Reset the filter to a configuration that would pass the maximum amount of messages, packets, and stations.- Specified by:
setToPassall
in classFilter
-
canRejectSome
public boolean canRejectSome()Specifies that this filter may reject some stations, messages, and/or frames. Used to tell combining filters whether a sub-filter is in passall mode and therefore doesn't need to be checked for every call to the combiner, thereby saving CPU time when filtering when most filters are in passall mode.- Overrides:
canRejectSome
in classFilter
- Returns:
- boolean true if this filter is currently capable of rejecting something
- See Also:
-
getFilterUIName
Get the class name of a dynamically loadable class for the the GUI for this filter. The name is allowed to have a wildcard '*' in it where a GUI type ("gui" for standard Java or "android" for Android) can be substituted.- Specified by:
getFilterUIName
in classFilter
- Returns:
- String name of GUI class for this filter
-
addFilterChangeListener
Register a listener for changes of this Filter.- Specified by:
addFilterChangeListener
in classFilter
- Parameters:
l
- FilterChangeListener to register
-
removeFilterChangeListener
Deregisters a listener. The listener will no longer be informed of changes to this filter.- Specified by:
removeFilterChangeListener
in classFilter
- Parameters:
l
- FilterChangeListener to deregister
-
clone
Creates and returns a copy of this object.- Overrides:
clone
in classFilter
- Returns:
- a clone of this instance.
- Throws:
CloneNotSupportedException
- if the object's class does not support theCloneable
interface. Subclasses that override theclone
method can also throw this exception to indicate that an instance cannot be cloned.- See Also:
-