.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsBackboneAtom, IsBackboneAtom


.. _OEBio_OEIsBackboneAtom:

.. oe:class:: OEIsBackboneAtom

   .. oe:api::

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

   This class represents :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that are part of a
   macro-molecule backbone.

   .. seealso::

      * :ref:`section_predicates_reside_data_functors` section

   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::

            OEIsBackboneAtom(bool considercarbonyl = true,
                             bool considerterminaloxygen = false)

      .. oe:language:: python

         .. oe:api:: python

            OEIsBackboneAtom(o: bool = True,
                             includeTerminalOxygen: bool = False) -> OEIsBackboneAtom

      Default constructor.

      *considercarbonyl*
         Determines whether to consider the carbonyl oxygen as a backbone atom.
      *considerterminaloxygen*
         Determines whether to consider the terminal oxygen (OXT) as a backbone atom.

   .. 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

   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsBackboneAtom

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>`
      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.
