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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBScreenOptions, DBScreenOptions


.. _OEBioisostere_OEDBScreenOptions:

.. oe:class:: OEDBScreenOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

     class OEDBScreenOptions : public OESystem::OEOptions

   This class provides an interface to setup options related to 
   screening two-dimensional Brood databases in
   :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>`.

   The :ref:`OEDBScreenOptions <OEBioisostere_OEDBScreenOptions>` class defines the following public methods:
    * :oe:meth:`GetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::GetMinFreqHeavy>` and
      :oe:meth:`SetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::SetMinFreqHeavy>`
    * :oe:meth:`GetMinFrequency<OEBioisostere::OEDBScreenOptions::GetMinFrequency>` and
      :oe:meth:`SetMinFrequency<OEBioisostere::OEDBScreenOptions::SetMinFrequency>`

   

   .. _OEBioisostere_OEDBScreenOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEDBScreenOptions()
            OEDBScreenOptions(const OEDBScreenOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEDBScreenOptions() -> OEDBScreenOptions
            OEDBScreenOptions(arg2: OEDBScreenOptions) -> OEDBScreenOptions

      Default and copy constructors.


   .. _OEBioisostere_OEDBScreenOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEDBScreenOptions &operator=(const OEDBScreenOptions&)

      Assignment operator.


   .. _OEBioisostere_OEDBScreenOptions_GetMinFreqHeavy:
   .. oe:method:: GetMinFreqHeavy

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

         .. oe:api::

            unsigned GetMinFreqHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFreqHeavy() -> int

      See :oe:meth:`SetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::SetMinFreqHeavy>` method.


   .. _OEBioisostere_OEDBScreenOptions_GetMinFrequency:
   .. oe:method:: GetMinFrequency

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

         .. oe:api::

            unsigned GetMinFrequency() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFrequency() -> int

      See :oe:meth:`SetMinFrequency<OEBioisostere::OEDBScreenOptions::SetMinFrequency>` method.


   .. _OEBioisostere_OEDBScreenOptions_SetMinFreqHeavy:
   .. oe:method:: SetMinFreqHeavy

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

         .. oe:api::

            bool SetMinFreqHeavy(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMinFreqHeavy(value: int) -> bool

      Sets the **fragment size defined by the number of heavy atoms** affecting minimum frequency.
      The `minimum frequency` is only applicable to fragments larger this size defined here.
      **Default: 1.**


   .. _OEBioisostere_OEDBScreenOptions_SetMinFrequency:
   .. oe:method:: SetMinFrequency

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

         .. oe:api::

            bool SetMinFrequency(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMinFrequency(value: int) -> bool

      Sets the **Minimum frequency** required for a fragment to be kept. The  ``Minimum frequency``
      is only applicable to fragments larger than size defined in
      :oe:meth:`SetMinFreqHeavy<OEBioisostere::OEDBScreenOptions::SetMinFreqHeavy>`.
      The ``frequency`` is the number of parent molecule a specific fragment belongs to,
      in a database.  A value of zero indicates that all fragments should be kept.
      **Default: 0.**
