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

.. oe:namespace:: OESpruce


.. _OESpruce_OEIsModeledAtom:

.. oe:class:: OEIsModeledAtom

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEIsModeledAtom : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This predicate is used to identify atoms that have been built using
   **Spruce TK** either by capping terminal residues, building out
   partial residues, or by mutating a residue. Otherwise it returns ``false``.

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================ ===========================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================ ===========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsModeledAtom()

      .. oe:language:: python

         .. oe:api:: python

            OEIsModeledAtom() -> OEIsModeledAtom

      Default constructor.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``  if the atom has been built using
      **Spruce TK** either by capping terminal residues, building out
      partial residues, or by mutating a residue.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEAtomBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsModeledAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsModeledAtom <OESpruce_OEIsModeledAtom>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.

   .. seealso::

      * :oe:func:`OESpruce::OECapTermini` function
      * :oe:func:`OESpruce::OECapCTermini` function
      * :oe:func:`OESpruce::OECapNTermini` function
      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :oe:func:`OESpruce::OEMutateResidue` function
