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

.. oe:namespace:: OESpruce



.. _OESpruce_OECapBuilderOptions:

.. oe:class:: OECapBuilderOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OECapBuilderOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building caps in the :oe:func:`OESpruce::OECapTermini`,
   :oe:func:`OESpruce::OECapCTermini`, and :oe:func:`OESpruce::OECapNTermini` functions.

   .. oe:method:: Constructors

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

         .. oe:api::

            OECapBuilderOptions()
            OECapBuilderOptions(const OECapBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OECapBuilderOptions() -> OECapBuilderOptions
            OECapBuilderOptions(arg2: OECapBuilderOptions) -> OECapBuilderOptions

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

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

      .. oe:api::

         OECapBuilderOptions &operator=(const OECapBuilderOptions &)

      Assignment operator.

   .. _OESpruce_OECapBuilderOptions_GetDeleteClashingSolvent:


   .. oe:method:: GetDeleteClashingSolvent

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

         .. oe:api::

            bool GetDeleteClashingSolvent() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteClashingSolvent() -> bool

      Returns the boolean whether or not to delete solvent waters that clash with other atoms.

   .. _OESpruce_OECapBuilderOptions_GetAllowTruncate:


   .. oe:method:: GetAllowTruncate

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

         .. oe:api::

            bool GetAllowTruncate() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowTruncate() -> bool

      Returns the boolean whether or not it is okay to make a terminal residue the cap if building one would
      result in a clash, or if the backbone of the residue itself is incomplete

   .. _OESpruce_OECapBuilderOptions_GetForceCapping:


   .. oe:method:: GetForceCapping

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

         .. oe:api::

            bool GetForceCapping() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceCapping() -> bool

      Returns the boolean of whether or not to force caping in the event the cap would clash with something in the system

   .. _OESpruce_OECapBuilderOptions_SetDeleteClashingSolvent:


   .. oe:method:: SetDeleteClashingSolvent

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

         .. oe:api::

            bool SetDeleteClashingSolvent(bool deleteClashingSolvent)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteClashingSolvent(value: bool) -> bool

      Sets the boolean of whether or not to delete solvent waters that clash with other atoms.

   .. _OESpruce_OECapBuilderOptions_SetAllowTruncate:


   .. oe:method:: SetAllowTruncate

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

         .. oe:api::

            bool SetAllowTruncate(bool allowTruncate)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowTruncate(value: bool) -> bool

      Sets the boolean of whether or not it is okay to make a terminal residue the cap if building one would
      result in a clash, or if the backbone of the residue itself is incomplete

   .. _OESpruce_OECapBuilderOptions_SetForceCapping:


   .. oe:method:: SetForceCapping

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

         .. oe:api::

            bool SetForceCapping(bool forceCapping)

      .. oe:language:: python

         .. oe:api:: python

            SetForceCapping(value: bool) -> bool

      Sets the boolean of whether or not to force capping in the event the cap would clash with something in the system.
      This setting supersedes the settings for :oe:meth:`OESpruce::OECapBuilderOptions::GetAllowTruncate` and
      :oe:meth:`OESpruce::OECapBuilderOptions::GetDeleteClashingSolvent`.

.. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :oe:func:`OESpruce::OECapTermini` function
      * :oe:func:`OESpruce::OECapCTermini` function
      * :oe:func:`OESpruce::OECapNTermini` functions
