.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodDBFilter, BroodDBFilter


.. _OEBioisostere_OEBroodDBFilter:

.. oe:class:: OEBroodDBFilter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodDBFilter

   This class defines objects that can be used to check if a 
   :ref:`database packet <OEBioisostere_OEBroodDBPacket>` contains
   fragments relevant to a certain :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`.

   The :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>` class defines the following public methods:
    * :oe:meth:`Setup<OEBioisostere::OEBroodDBFilter::Setup>`



   .. _OEBioisostere_OEBroodDBFilter_Constructors:
   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEBroodDBFilter()
            OEBroodDBFilter(const OEBroodDBFilter &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodDBFilter() -> OEBroodDBFilter
            OEBroodDBFilter(arg2: OEBroodDBFilter) -> OEBroodDBFilter

      Default and copy constructors.


   .. _OEBioisostere_OEBroodDBFilter_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodDBFilter &operator=(const OEBroodDBFilter &)

      Assignment operator.


   .. _OEBioisostere_OEBroodDBFilter_Setup:
   .. oe:method:: Setup

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Setup(const OEBroodQuery& query,
                       const OEBroodGeneralOptions& scoreOpts = OEBroodGeneralOptions())
            bool Setup(OEChem::OEMCMolBase& mol,
                       const OEBroodGeneralOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Setup(query: OEBroodQuery,
                  opts: OEBroodGeneralOptions = OEBroodGeneralOptions()) -> bool

      This method associates the filter with either a specific
      :ref:`OEBroodQuery<OEBioisostere_OEBroodQuery>` or a prepared
      :ref:`OEMCMolBase <OEChem_OEMCMolBase>`, along with
      :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>`,
      to initialize packet-level filtering constraints.
