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

.. oe:namespace:: OESpruce

.. attention::

      |TWOLANGUAGE|


.. _OESpruce_OEBioUnitExtractionOptions:

.. oe:class:: OEBioUnitExtractionOptions

   .. oe:api::

      class OEBioUnitExtractionOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for biounit extraction for use in the
   :oe:func:`OESpruce::OEExtractBioUnits` function.

   .. admonition:: Code Example

      * :ref:`spruce_examples_extract_biounits_ref` example
      * :ref:`spruce_examples_extract_biounits_remarks` example

   .. oe:method:: Constructors

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

         .. oe:api::

            OEBioUnitExtractionOptions()
            OEBioUnitExtractionOptions(const OEBioUnitExtractionOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBioUnitExtractionOptions() -> OEBioUnitExtractionOptions
            OEBioUnitExtractionOptions(arg2: OEBioUnitExtractionOptions) -> OEBioUnitExtractionOptions

      Default and copy constructor that constructs a `OEBioUnitExtractionOptions` object.

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

      .. oe:api::

         OEBioUnitExtractionOptions &operator=(const OEBioUnitExtractionOptions &)

      Assignment operator.

   .. oe:method:: GetMaxAtoms

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

         .. oe:api::

            unsigned GetMaxAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxAtoms() -> int

      Returns the maximum number of atoms for the extracted biounit.

   .. oe:method:: GetMaxParts

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

         .. oe:api::

            unsigned GetMaxParts() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxParts() -> int

      Returns the maximum number of parts for a given transformation required to generate a biounit.

   .. oe:method:: GetMinScore

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

         .. oe:api::

            unsigned GetMinScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinScore() -> int

      Returns the minimum score required for the biounit extraction's sequence alignment.

   .. oe:method:: GetPreferAuthorRecord

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

         .. oe:api::

            bool GetPreferAuthorRecord() const

      .. oe:language:: python

         .. oe:api:: python

            GetPreferAuthorRecord() -> bool

      Returns the boolean whether or not to prefer the author or software record for biounit extraction.

   .. oe:method:: GetSuperpose

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

         .. oe:api::

            bool GetSuperpose() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperpose() -> bool

      Returns the boolean whether or not to superpose the output biounit to the input reference structure.

.. _OESpruce_OEBioUnitExtractionOptions_SetMaxAtoms:

   .. oe:method:: SetMaxAtoms

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

         .. oe:api::

            bool SetMaxAtoms(unsigned maxAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxAtoms(value: int) -> bool

      Sets the maximum number of atoms allowed for the extracted biounit.

.. _OESpruce_OEBioUnitExtractionOptions_SetMaxParts:

   .. oe:method:: SetMaxParts

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

         .. oe:api::

            bool SetMaxParts(unsigned maxParts)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxParts(value: int) -> bool

      Sets the maximum number of parts allowed for a given transformation required to generate a biounit.

.. _OESpruce_OEBioUnitExtractionOptions_SetMinScore:

   .. oe:method:: SetMinScore

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

         .. oe:api::

            bool SetMinScore(const unsigned value)

      .. oe:language:: python

         .. oe:api:: python

            SetMinScore(value: int) -> bool

      Sets the minimum score required for the biounit extraction's sequence alignment.

.. _OESpruce_OEBioUnitExtractionOptions_SetPreferAuthorRecord:

   .. oe:method:: SetPreferAuthorRecord

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

         .. oe:api::

            bool SetPreferAuthorRecord(bool preferAuthor)

      .. oe:language:: python

         .. oe:api:: python

            SetPreferAuthorRecord(value: bool) -> bool

      Sets the boolean of whether or not to prefer the author or software record for biounit extraction.

.. _OESpruce_OEBioUnitExtractionOptions_SetSuperpose:

   .. oe:method:: SetSuperpose

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

         .. oe:api::

            bool SetSuperpose(bool superpose)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperpose(value: bool) -> bool

      Sets the boolean whether or not to superpose the output biounit to the input reference structure.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
