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

.. oe:namespace:: OESpruce



.. _OESpruce_OEMakeDesignUnitOptions:

.. oe:class:: OEMakeDesignUnitOptions

   .. attention::

      |TWOLANGUAGE|

   The :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class holds other options classes that are used during the structure preparation processes. The
   organization of those options classes is illustrated in the figure below. Default constructing this options class, constructs all the necessary
   options classes in the illustration, which can then be accessed and modified.
   This class stores the optional parameter sets for design unit construction for use in the :oe:func:`OESpruce::OEMakeDesignUnits` and
   :oe:func:`OESpruce::OEMakeDesignUnit` functions.

   .. _figure_OEMakeDesignUnitOptions_Organization:

   .. figure:: ../images/OEMakeDUOptionsOrg.*
      :align:  center

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMakeDesignUnitOptions()
            OEMakeDesignUnitOptions(const OEMakeDesignUnitOptions &)
            OEMakeDesignUnitOptions(const OEDesignUnitSplitOptions& splitOpts,
                                    const OEDesignUnitPrepOptions& prepOpts,
                                    const OEBioUnitExtractionOptions& buExtractOpts)

      .. oe:language:: python

         .. oe:api:: python

            OEMakeDesignUnitOptions() -> OEMakeDesignUnitOptions
            OEMakeDesignUnitOptions(splitOpts: OEDesignUnitSplitOptions,
                                    prepOpts: OEDesignUnitPrepOptions,
                                    buExtractOpts: OEBioUnitExtractionOptions) -> OEMakeDesignUnitOptions
            OEMakeDesignUnitOptions(arg2: OEMakeDesignUnitOptions) -> OEMakeDesignUnitOptions

      Default, copy, and advanced constructor that constructs a `OEMakeDesignUnitOptions` object. The advanced constructor take three separate sub-options classes as arguments: an options class that controls componentization of the system (:ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`), an options class that controls prep (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`), and an options class that controls biounit extraction (:ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`).

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

      .. oe:api::

         OEMakeDesignUnitOptions &operator=(const OEMakeDesignUnitOptions &)

      Assignment operator.

   .. _OESpruce_OEMakeDesignUnitOptions_GetBioUnitExtractionOptions:

   .. oe:method:: GetBioUnitExtractionOptions



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

         .. oe:api::

            OEBioUnitExtractionOptions& GetBioUnitExtractionOptions()
            const OEBioUnitExtractionOptions& GetBioUnitExtractionOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetBioUnitExtractionOptions() -> OEBioUnitExtractionOptions

      Returns a reference to the stored biounit extraction options (:ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`) class.

   .. _OESpruce_OEMakeDesignUnitOptions_GetPrepOptions:


   .. oe:method:: GetPrepOptions


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

         .. oe:api::

            OEDesignUnitPrepOptions& GetPrepOptions()
            const OEDesignUnitPrepOptions& GetPrepOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPrepOptions() -> OEDesignUnitPrepOptions

      Returns a reference to the stored design unit prep options (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`) class.

   .. _OESpruce_OEMakeDesignUnitOptions_GetSplitOptions:


   .. oe:method:: GetSplitOptions


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

         .. oe:api::

            OEDesignUnitSplitOptions& GetSplitOptions()
            const OEDesignUnitSplitOptions& GetSplitOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSplitOptions() -> OEDesignUnitSplitOptions

      Returns a reference to the stored options for splitting options (:ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`) class.

   .. _OESpruce_OEMakeDesignUnitOptions_GetSuperpose:


   .. 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 design units onto a common reference.

   .. _OESpruce_OEMakeDesignUnitOptions_GetSuperpositionMethod:


   .. oe:method:: GetSuperpositionMethod


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

         .. oe:api::

            unsigned GetSuperpositionMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuperpositionMethod() -> int

      Returns the stored superposition method taken from the :oe:constns:`OESpruce::OESuperpositionType` namespace.

   .. _OESpruce_OEMakeDesignUnitOptions_SetBioUnitExtractionOptions:


   .. oe:method:: SetBioUnitExtractionOptions


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

         .. oe:api::

            void SetBioUnitExtractionOptions(const OESpruce::OEBioUnitExtractionOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetBioUnitExtractionOptions(opts: OEBioUnitExtractionOptions) -> None

      Sets the biounit extraction options class (:ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>`).

   .. _OESpruce_OEMakeDesignUnitOptions_SetPrepOptions:


   .. oe:method:: SetPrepOptions


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

         .. oe:api::

            void SetPrepOptions(const OESpruce::OEDesignUnitPrepOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetPrepOptions(opts: OEDesignUnitPrepOptions) -> None

      Sets the design unit prep options class (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`).

   .. _OESpruce_OEMakeDesignUnitOptions_SetSplitOptions:


   .. oe:method:: SetSplitOptions


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

         .. oe:api::

            void SetSplitOptions(const OESpruce::OEDesignUnitSplitOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetSplitOptions(opts: OEDesignUnitSplitOptions) -> None

      Sets the system molecular componentization options class (:ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>`).

   .. _OESpruce_OEMakeDesignUnitOptions_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 of whether or not to superpose design units to a common reference.

   .. _OESpruce_OEMakeDesignUnitOptions_SetSuperpositionMethod:


   .. oe:method:: SetSuperpositionMethod


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

         .. oe:api::

            bool SetSuperpositionMethod(unsigned superposeMethod)

      .. oe:language:: python

         .. oe:api:: python

            SetSuperpositionMethod(value: int) -> bool

      Sets the superposition method from a value in the :oe:constns:`OESpruce::OESuperpositionType` namespace.


   .. seealso::

      * :ref:`OEBioUnitExtractionOptions <OESpruce_OEBioUnitExtractionOptions>` class
      * :ref:`OEDesignUnitSplitOptions <OESpruce_OEDesignUnitSplitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>` class
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class
      * :ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>` class
      * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class
