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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodHitlistOptions, BroodHitlistOptions


.. _OEBioisostere_OEBroodHitlistOptions:

.. oe:class:: OEBroodHitlistOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodHitlistOptions : public OESystem::OEOptions

   This class provides an interface to set up options used when generating
   a hitlist in :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
   from a set of :ref:`Brood scores <OEBioisostere_OEBroodScore>`.

   The :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` class defines the following public methods:
    * :oe:meth:`GetGenerateIdea<OEBioisostere::OEBroodHitlistOptions::GetGenerateIdea>` and
      :oe:meth:`SetGenerateIdea<OEBioisostere::OEBroodHitlistOptions::SetGenerateIdea>`
    * :oe:meth:`GetMaxHits<OEBioisostere::OEBroodHitlistOptions::GetMaxHits>` and
      :oe:meth:`SetMaxHits<OEBioisostere::OEBroodHitlistOptions::SetMaxHits>`

   

   .. _OEBioisostere_OEBroodHitlistOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodHitlistOptions()
            OEBroodHitlistOptions(const OEBroodHitlistOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodHitlistOptions() -> OEBroodHitlistOptions
            OEBroodHitlistOptions(arg2: OEBroodHitlistOptions) -> OEBroodHitlistOptions

      Default and copy constructors.


   .. _OEBioisostere_OEBroodHitlistOptions_operator=:
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBroodHitlistOptions &operator=(const OEBroodHitlistOptions &)

      Assignment operator.


   .. _OEBioisostere_OEBroodHitlistOptions_GetGenerateIdea:
   .. oe:method:: GetGenerateIdea

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

         .. oe:api::

            bool GetGenerateIdea() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenerateIdea() -> bool

      See :oe:meth:`SetGenerateIdea<OEBioisostere::OEBroodHitlistOptions::SetGenerateIdea>` method.


   .. _OEBioisostere_OEBroodHitlistOptions_GetMaxHits:
   .. oe:method:: GetMaxHits

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

         .. oe:api::

            unsigned GetMaxHits() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHits() -> int

      See :oe:meth:`SetMaxHits<OEBioisostere::OEBroodHitlistOptions::SetMaxHits>` method.


   .. _OEBioisostere_OEBroodHitlistOptions_SetGenerateIdea:
   .. oe:method:: SetGenerateIdea

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

         .. oe:api::

            bool SetGenerateIdea(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetGenerateIdea(value: bool) -> bool

      Sets whether **cluster information** is generated for the created
      hitlist.
      **Default: True.**


   .. _OEBioisostere_OEBroodHitlistOptions_SetMaxHits:
   .. oe:method:: SetMaxHits

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

         .. oe:api::

            bool SetMaxHits(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHits(value: int) -> bool

      Sets the **maximum number of hits** to generate.
      **Default: 1000.**
