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

.. oe:namespace:: OESpruce



.. _OESpruce_OEDesignUnitPrepOptions:

.. oe:class:: OEDesignUnitPrepOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEDesignUnitPrepOptions : public OESystem::OEOptions

   This class stores the optional parameter sets used in design unit preparation for use in the :oe:cls:`OESpruce::OEMakeDesignUnitOptions` class.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEDesignUnitPrepOptions()
            OEDesignUnitPrepOptions(const OEDesignUnitPrepOptions &)
            OEDesignUnitPrepOptions(const OEDesignUnitBuildOptions& buildOpts,
                                    const OESpruce::OEProtonateDesignUnitOptions& protonateOpts,
                                    const OEDesignUnitEnumerateSitesOptions& enumOpts)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitPrepOptions() -> OEDesignUnitPrepOptions
            OEDesignUnitPrepOptions(buildOpts: OEDesignUnitBuildOptions,
                                    protonateOpts: OEProtonateDesignUnitOptions,
                                    enumOpts: OEDesignUnitEnumerateSitesOptions) -> OEDesignUnitPrepOptions
            OEDesignUnitPrepOptions(arg2: OEDesignUnitPrepOptions) -> OEDesignUnitPrepOptions

      Default, copy, and advanced constructor that constructs a `OEDesignUnitPrepOptions` object. The advanced constructor take three separate sub-options classes as arguments: an options class that controls prep (:ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>`), an options class that controls the building options (:ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`), and an options class that controls alternate location handling (:ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`).

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

      .. oe:api::

         OEDesignUnitPrepOptions &operator=(const OEDesignUnitPrepOptions &)

      Assignment operator.

   .. oe:method:: GetAssignPartialChargesAndRadii

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

         .. oe:api::

            bool GetAssignPartialChargesAndRadii() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignPartialChargesAndRadii() -> bool

      Returns the boolean whether or not to assign partial charges and radii.

   .. oe:method:: GetBuildOptions

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

         .. oe:api::

            OEDesignUnitBuildOptions& GetBuildOptions()
            const OEDesignUnitBuildOptions& GetBuildOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildOptions() -> OEDesignUnitBuildOptions

      Returns a reference to the stored build options (:ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`) class.

   .. oe:method:: GetChargeEngine

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

         .. oe:api::

            OEProton::OEDesignUnitCharges& GetChargeEngine()

      .. oe:language:: python

         .. oe:api:: python

            GetChargeEngine() -> OEDesignUnitCharges

      Returns a reference to the stored charge engine (:ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`) class.

   .. oe:method:: GetEnumerateSitesOptions

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

         .. oe:api::

            OEDesignUnitEnumerateSitesOptions& GetEnumerateSitesOptions()
            const OEDesignUnitEnumerateSitesOptions& GetEnumerateSitesOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumerateSitesOptions() -> OEDesignUnitEnumerateSitesOptions

      Returns a reference to the stored design unit site enumeration options (:ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`) class.

   .. oe:method:: GetProtonate

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

         .. oe:api::

            bool GetProtonate() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtonate() -> bool

      Returns the boolean of whether or not to protonate the design unit.

   .. oe:method:: GetStrictProtonationMode

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

         .. oe:api::

            bool GetStrictProtonationMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictProtonationMode() -> bool

      Returns the boolean of whether to fail design unit preparation if the protonation stage fails

   .. oe:method:: GetProtonateOptions

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

         .. oe:api::

            OESpruce::OEProtonateDesignUnitOptions& GetProtonateOptions()
            const OESpruce::OEProtonateDesignUnitOptions& GetProtonateOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetProtonateOptions() -> OEProtonateDesignUnitOptions

      Returns a reference to the stored design unit protonation options (:ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`) class.

.. _OESpruce_OEDesignUnitPrepOptions_SetAssignPartialChargesAndRadii:

   .. oe:method:: SetAssignPartialChargesAndRadii

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

         .. oe:api::

            bool SetAssignPartialChargesAndRadii(bool assignPartialChargesAndRadii)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignPartialChargesAndRadii(value: bool) -> bool

      Sets the boolean of whether or not to assign partial charges and radii.

   .. oe:method:: SetBuildOptions

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

         .. oe:api::

            void SetBuildOptions(const OEDesignUnitBuildOptions& buildOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildOptions(opts: OEDesignUnitBuildOptions) -> None

      Sets the design unit building options class (:ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>`).

   .. oe:method:: SetChargeEngine

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

         .. oe:api::

            void SetChargeEngine(OEProton::OEDesignUnitCharges chargeEngine)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeEngine(chargeEngine: OEDesignUnitCharges) -> None

      Sets the charging engine when charges are added (:ref:`OEDesignUnitCharges <OEProton_OEDesignUnitCharges>`).

   .. oe:method:: SetEnumerateSitesOptions

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

         .. oe:api::

            void SetEnumerateSitesOptions(const OEDesignUnitEnumerateSitesOptions& enumOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumerateSitesOptions(opts: OEDesignUnitEnumerateSitesOptions) -> None

      Sets the design unit site enumeration options class (:ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`).

.. _OESpruce_OEDesignUnitPrepOptions_SetProtonate:

   .. oe:method:: SetProtonate

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

         .. oe:api::

            bool SetProtonate(const bool protonate)

      .. oe:language:: python

         .. oe:api:: python

            SetProtonate(value: bool) -> bool

      Sets the boolean of whether or not to protonate the design unit.

   .. oe:method:: SetStrictProtonationMode

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

         .. oe:api::

            bool SetStrictProtonationMode(bool strictProtonate)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictProtonationMode(value: bool) -> bool

      Sets the boolean of whether or not to fail design unit preparation if the protonation stage fails

   .. oe:method:: SetProtonateOptions

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

         .. oe:api::

            void SetProtonateOptions(const OESpruce::OEProtonateDesignUnitOptions& protonateOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetProtonateOptions(opts: OEProtonateDesignUnitOptions) -> None

      Sets the design unit protonation options class (:ref:`OEProtonateDesignUnitOptions <OESpruce_OEProtonateDesignUnitOptions>`).

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` 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
