Package adams.data.filter

Class TimeseriesWindow

  • All Implemented Interfaces:
    CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Filter>, SizeOfHandler, Filter<Timeseries>, Serializable, Comparable
    public class TimeseriesWindow
extends AbstractFilter<Timeseries>
    Leaves only the specified window in the timeseries (borders included).
    The matching can be inverted, i.e., everything but the window is returned.

    Valid options are: 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 
    -start <adams.core.base.BaseDateTime> (property: start)
    The timestamp for the first data point in series to keep.
    default: -INF
 
    -end <adams.core.base.BaseDateTime> (property: end)
    The timestamp for the last data point in series to keep.
    default: +INF
 
    -invert <boolean> (property: invert)
    If enabled, everything but the window is kept.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Start

        protected BaseDateTime m_Start
        the starting point.

      • m_Invert

        protected boolean m_Invert
        whether to invert the matching.

    • Constructor Detail

      • TimeseriesWindow

        public TimeseriesWindow()

    • Method Detail

      • setStart

        public void setStart​(BaseDateTime value)
        Sets the start timestamp for series.
        Parameters:
        value - the timestamp

      • getStart

        public BaseDateTime getStart()
        The start timestamp of series.
        Returns:
        the timestamp

      • startTipText

        public String startTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setEnd

        public void setEnd​(BaseDateTime value)
        Sets the end timestamp for series.
        Parameters:
        value - the timestamp

      • getEnd

        public BaseDateTime getEnd()
        The end timestamp of series.
        Returns:
        the timestamp

      • endTipText

        public String endTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setInvert

        public void setInvert​(boolean value)
        Sets whether to invert the matching.
        Parameters:
        value - true if to invert

      • getInvert

        public boolean getInvert()
        Returns whether the matching is inverted.
        Returns:
        true if inverted

      • invertTipText

        public String invertTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.