org.mbari.siam.utils
Class HeadingFilter

java.lang.Object
  extended by org.mbari.siam.utils.Filter
      extended by org.mbari.siam.utils.HeadingFilter

public class HeadingFilter
extends Filter

This filter produces the resulting heading from its two (XY) inputs. The output is recalculated whenever any of the inputs changes.


Field Summary
protected  int _output
           
static int OUTPUT_DEGREES
           
static int OUTPUT_RADIANS
           
 double PI
           
 
Fields inherited from class org.mbari.siam.utils.Filter
_log4j, ACTION_CANCEL, ACTION_OK, DEFAULT_ID, DEFAULT_NAME
 
Constructor Summary
HeadingFilter()
           
HeadingFilter(FilterInput xInput, FilterInput yInput, int mode)
           
HeadingFilter(int id, FilterInput xInput, FilterInput yInput, int mode)
           
HeadingFilter(java.lang.String name, FilterInput xInput, FilterInput yInput, int mode)
           
HeadingFilter(java.lang.String name, int id)
           
HeadingFilter(java.lang.String name, int id, FilterInput xInput, FilterInput yInput, int mode)
           
 
Method Summary
protected  int doFilterAction(double value)
          Perform the filter function with the new input value.
 void setInputs(FilterInput xInput, FilterInput yInput)
           
 void setMode(int mode)
           
 
Methods inherited from class org.mbari.siam.utils.Filter
addInput, addInputs, attach, doubleValue, floatValue, getID, getInput, getInput, indexOf, inputCount, inputGate, intValue, longValue, name, outputGate, removeAllInputs, removeInput, reset, setID, setName, toString, triggerIn, triggerOut
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OUTPUT_RADIANS

public static final int OUTPUT_RADIANS
See Also:
Constant Field Values

OUTPUT_DEGREES

public static final int OUTPUT_DEGREES
See Also:
Constant Field Values

_output

protected int _output

PI

public final double PI
Constructor Detail

HeadingFilter

public HeadingFilter()

HeadingFilter

public HeadingFilter(java.lang.String name,
                     int id)

HeadingFilter

public HeadingFilter(FilterInput xInput,
                     FilterInput yInput,
                     int mode)
              throws InvalidPropertyException
Throws:
InvalidPropertyException

HeadingFilter

public HeadingFilter(java.lang.String name,
                     FilterInput xInput,
                     FilterInput yInput,
                     int mode)
              throws InvalidPropertyException
Throws:
InvalidPropertyException

HeadingFilter

public HeadingFilter(int id,
                     FilterInput xInput,
                     FilterInput yInput,
                     int mode)
              throws InvalidPropertyException
Throws:
InvalidPropertyException

HeadingFilter

public HeadingFilter(java.lang.String name,
                     int id,
                     FilterInput xInput,
                     FilterInput yInput,
                     int mode)
              throws InvalidPropertyException
Throws:
InvalidPropertyException
Method Detail

setInputs

public void setInputs(FilterInput xInput,
                      FilterInput yInput)
               throws InvalidPropertyException
Throws:
InvalidPropertyException

setMode

public void setMode(int mode)
             throws InvalidPropertyException
Throws:
InvalidPropertyException

doFilterAction

protected int doFilterAction(double value)
Perform the filter function with the new input value. Sets member variable _filterValue, which will be passed to the output by triggerOut() if the output gating conditions are met. Overrides base class default.

Specified by:
doFilterAction in class Filter


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.