Package nl.tudelft.simulation.language.filters

Interface FilterInterface

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractFilter, CompositeFilter, MaxPointFilter, ModulusFilter, ZeroFilter
public interface FilterInterface extends Serializable
The FilterInterface is a general interface for all filters in DSOL. Filters can be based on xY combinations, class information ,etc. etc. The API of implementing filters will explain what it expects as input.

Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:
Niels Lang , Peter Jacobs

  • Method Details

    • accept

      boolean accept(Object entry)
      a filter defines whether to accept a value in a chart.
      Parameters:
      entry - Object; the entry to filter
      Returns:
      whether to accept this entry

    • setInverted

      void setInverted(boolean inverted)
      inverts the filter.
      Parameters:
      inverted - boolean; whether to invert the filter

    • isInverted

      boolean isInverted()
      is the filter inverted?
      Returns:
      whether the filter is inverted.

    • getCriterion

      String getCriterion()
      returns a string representation of the criterion.
      Returns:
      the string representing the criterion

    • and

      FilterInterface and(FilterInterface filter)
      adds filter to this filter and returns the composed filter.
      Parameters:
      filter - FilterInterface; the filter to add
      Returns:
      the composed filter

    • or

      FilterInterface or(FilterInterface filter)
      creates a new composite filter which is one or two.
      Parameters:
      filter - FilterInterface; the filter to add
      Returns:
      the composed filter