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

.. oe:namespace:: OESpruce



.. _OESpruce_OEDesignUnitBuildOptions:

.. oe:class:: OEDesignUnitBuildOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEDesignUnitBuildOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building the missing structural components of a design unit for use in the :oe:cls:`OESpruce::OEMakeDesignUnitOptions` class.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEDesignUnitBuildOptions()
            OEDesignUnitBuildOptions(const OEDesignUnitBuildOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitBuildOptions() -> OEDesignUnitBuildOptions
            OEDesignUnitBuildOptions(arg2: OEDesignUnitBuildOptions) -> OEDesignUnitBuildOptions

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

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

      .. oe:api::

         OEDesignUnitBuildOptions &operator=(const OEDesignUnitBuildOptions &)

      Assignment operator.

   .. oe:method:: GetBuildLoops

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

         .. oe:api::

            bool GetBuildLoops() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildLoops() -> bool

      Returns the boolean whether or not to build loops.

   .. oe:method:: GetBuildSidechains

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

         .. oe:api::

            bool GetBuildSidechains() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildSidechains() -> bool

      Returns the boolean whether or not to build side chains.

   .. oe:method:: GetCapCTermini

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

         .. oe:api::

            bool GetCapCTermini() const

      .. oe:language:: python

         .. oe:api:: python

            GetCapCTermini() -> bool

      Returns the boolean whether or not to cap all C-termini in the system with NME.

   .. oe:method:: GetCapNTermini

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

         .. oe:api::

            bool GetCapNTermini() const

      .. oe:language:: python

         .. oe:api:: python

            GetCapNTermini() -> bool

      Returns the boolean whether or not to cap all N-termini in the system with ACE.

   .. oe:method:: GetSidechainBuilderOptions

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

         .. oe:api::

            OESidechainBuilderOptions& GetSidechainBuilderOptions()
            const OESidechainBuilderOptions& GetSidechainBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSidechainBuilderOptions() -> OESidechainBuilderOptions

      Returns a reference to the stored sidechain builder options (:ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`) class.

   .. oe:method:: GetLoopBuilderOptions

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

         .. oe:api::

            OELoopBuilderOptions& GetLoopBuilderOptions()
            const OELoopBuilderOptions& GetLoopBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetLoopBuilderOptions() -> OELoopBuilderOptions

      Returns a reference to the stored loop builder options (:ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`) class.

   .. oe:method:: GetCapBuilderOptions

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

         .. oe:api::

            OECapBuilderOptions& GetCapBuilderOptions()
            const OECapBuilderOptions& GetCapBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetCapBuilderOptions() -> OECapBuilderOptions

      Returns a reference to the stored cap builder options (:ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>`) class.


.. _OESpruce_OEDesignUnitBuildOptions_SetBuildLoops:

   .. oe:method:: SetBuildLoops

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

         .. oe:api::

            bool SetBuildLoops(bool buildLoops)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildLoops(value: bool) -> bool

      Sets the boolean of whether or not to build loops.

.. _OESpruce_OEDesignUnitBuildOptions_SetBuildSidechains:

   .. oe:method:: SetBuildSidechains

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

         .. oe:api::

            bool SetBuildSidechains(bool buildSidechains)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildSidechains(value: bool) -> bool

      Sets the boolean of whether or not to build side chains.

.. _OESpruce_OEDesignUnitBuildOptions_SetCapCTermini:

   .. oe:method:: SetCapCTermini

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

         .. oe:api::

            bool SetCapCTermini(bool capCTermini)

      .. oe:language:: python

         .. oe:api:: python

            SetCapCTermini(value: bool) -> bool

      Sets the boolean of whether or not to cap all C-termini in the system with NME.

.. _OESpruce_OEDesignUnitBuildOptions_SetCapNTermini:

   .. oe:method:: SetCapNTermini

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

         .. oe:api::

            bool SetCapNTermini(bool capNTermini)

      .. oe:language:: python

         .. oe:api:: python

            SetCapNTermini(value: bool) -> bool

      Sets the boolean of whether or not to cap all N-termini in the system with ACE.

   .. oe:method:: SetSidechainBuilderOptions

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

         .. oe:api::

            void SetSidechainBuilderOptions(const OESidechainBuilderOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetSidechainBuilderOptions(opts: OESidechainBuilderOptions) -> None

      Set the sidechain builder options class (:ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>`).

   .. oe:method:: SetCapBuilderOptions

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

         .. oe:api::

            void SetCapBuilderOptions(const OECapBuilderOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetCapBuilderOptions(opts: OECapBuilderOptions) -> None

      Set the cap builder options class (:ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>`).

   .. oe:method:: SetLoopBuilderOptions

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

         .. oe:api::

            void SetLoopBuilderOptions(const OELoopBuilderOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetLoopBuilderOptions(opts: OELoopBuilderOptions) -> None

      Set the loop builder options class (:ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>`).

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
      * :ref:`OELoopBuilderOptions <OESpruce_OELoopBuilderOptions>` class
      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class
