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

.. oe:namespace:: OESpruce

..  _OESpruce_OECapTermini:

.. oe:function:: OECapTermini

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OECapTermini(OEChem::OEMolBase& mol,
                           const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& exclude = OEChem::OEIsFalseAtom(),
                           const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   .. oe:language:: python

      .. oe:api:: python

         OECapTermini(mol: Union[OEGraphMol,OEMol,OEQMol],
                      exclude: OEUnaryAtomPred = OEIsFalseAtom(),
                      arg3: OECapBuilderOptions = OECapBuilderOptions()) -> bool

   This function caps all the N- and C-termini in a protein with acetyl (:oe:const:`OEChem::OEResidueIndex::ACE`) and
   N-methyl (:oe:const:`OEChem::OEResidueIndex::NME`) groups, respectively.

   A predicate can be passed to exclude certain termini from being capped, such as the true biological terminal residues
   since these should be charged to match the biophysical experiments.

   The function takes an options class, where behavior can be controlled if building the cap results in a clash, and
   depending on the type of class what actions can be taken, e.g. a solvent molecule blocking the protein backbone
   is not very realistic and the solvent molecule is likely placed to account for density that should have belonged
   to the residue not resolved in the crystal structure.

   .. note::

      Explicit hydrogens are not added to the structure during the build processes.

   .. oe:api: IGNORE

      bool OECapTermini(OEBio::OEDesignUnit &du,
                        const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &exclude=OEChem::OEIsFalseAtom(),
                        const OESpruce::OECapBuilderOptions& = OESpruce::OECapBuilderOptions())

   The input ``mol`` must have 3D coordinates assigned.

   .. seealso::

      * :ref:`OECapBuilderOptions <OESpruce_OECapBuilderOptions>` class
      * :oe:func:`OESpruce::OECapCTermini` function
      * :oe:func:`OESpruce::OECapNTermini` function
      * :ref:`OEIsNTerminalAtom <OEBio_OEIsNTerminalAtom>` predicate
      * :ref:`OEIsCTerminalAtom <OEBio_OEIsCTerminalAtom>` predicate
