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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEHitlistBuilderOptions, HitlistBuilderOptions


.. _OEBioisostere_OEHitlistBuilderOptions:

.. oe:class:: OEHitlistBuilderOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHitlistBuilderOptions : public OESystem::OEOptions

   This class defines configuration options for the :ref:`OEHitlistBuilder <OEBioisostere_OEHitlistBuilder>`
   and consolidates options from general, hit list, and build option groups.

   The :ref:`OEHitlistBuilderOptions <OEBioisostere_OEHitlistBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetBuildOptions<OEBioisostere::OEHitlistBuilderOptions::GetBuildOptions>` and
      :oe:meth:`SetBuildOptions<OEBioisostere::OEHitlistBuilderOptions::SetBuildOptions>`
    * :oe:meth:`GetGeneralOptions<OEBioisostere::OEHitlistBuilderOptions::GetGeneralOptions>` and
      :oe:meth:`SetGeneralOptions<OEBioisostere::OEHitlistBuilderOptions::SetGeneralOptions>`
    * :oe:meth:`GetHitlistOptions<OEBioisostere::OEHitlistBuilderOptions::GetHitlistOptions>` and
      :oe:meth:`SetHitlistOptions<OEBioisostere::OEHitlistBuilderOptions::SetHitlistOptions>`



   .. _OEBioisostere_OEHitlistBuilderOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEHitlistBuilderOptions()
            OEHitlistBuilderOptions(const OEHitlistBuilderOptions&)
            OEHitlistBuilderOptions& operator=(const OEHitlistBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEHitlistBuilderOptions() -> OEHitlistBuilderOptions
            OEHitlistBuilderOptions(arg2: OEHitlistBuilderOptions) -> OEHitlistBuilderOptions

      Default and copy constructors.


   .. _OEBioisostere_OEHitlistBuilderOptions_GetBuildOptions:

   .. oe:method:: GetBuildOptions

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

         .. oe:api::

            const OEBroodBuildOptions& GetBuildOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildOptions() -> OEBroodBuildOptions

      This method returns the :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>` contained in this object.

      See the :oe:meth:`SetBuildOptions<OEBioisostere::OEHitlistBuilderOptions::SetBuildOptions>` method.


   .. _OEBioisostere_OEHitlistBuilderOptions_GetGeneralOptions:

   .. oe:method:: GetGeneralOptions

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

         .. oe:api::

            const OEBroodGeneralOptions& GetGeneralOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetGeneralOptions() -> OEBroodGeneralOptions

      This method returns the :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` contained in this object.

      See the :oe:meth:`SetGeneralOptions<OEBioisostere::OEHitlistBuilderOptions::SetGeneralOptions>` method.


   .. _OEBioisostere_OEHitlistBuilderOptions_GetHitlistOptions:

   .. oe:method:: GetHitlistOptions

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

         .. oe:api::

            const OEBroodHitlistOptions& GetHitlistOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitlistOptions() -> OEBroodHitlistOptions

      This method returns the :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` contained in this object.

      See the :oe:meth:`SetHitlistOptions<OEBioisostere::OEHitlistBuilderOptions::SetHitlistOptions>` method.


   .. _OEBioisostere_OEHitlistBuilderOptions_SetBuildOptions:

   .. oe:method:: SetBuildOptions

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

         .. oe:api::

            void SetBuildOptions(const OEBroodBuildOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildOptions(opts: OEBroodBuildOptions) -> None

      This method sets the :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>` to be used.


   .. _OEBioisostere_OEHitlistBuilderOptions_SetGeneralOptions:

   .. oe:method:: SetGeneralOptions

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

         .. oe:api::

            void SetGeneralOptions(const OEBroodGeneralOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetGeneralOptions(opts: OEBroodGeneralOptions) -> None

      This method sets the :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` to be used.


   .. _OEBioisostere_OEHitlistBuilderOptions_SetHitlistOptions:

   .. oe:method:: SetHitlistOptions

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

         .. oe:api::

            void SetHitlistOptions(const OEBroodHitlistOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetHitlistOptions(opts: OEBroodHitlistOptions) -> None

      This method sets the :ref:`OEBroodHitlistOptions <OEBioisostere_OEBroodHitlistOptions>` to be used.

