.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsHetAtom, IsHet


.. _OEBio_OEIsHetAtom:

.. oe:class:: OEIsHetAtom

   .. oe:api::

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

   This class represents :ref:`OEIsHetAtom <OEBio_OEIsHetAtom>` functor
   that identifies the atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) that have the
   ‘hetero atom’ property in a residue.

   .. seealso::

      * :oe:meth:`OEChem::OEResidue::IsHetAtom` method

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

            OEIsHetAtom()

      .. oe:language:: python

         .. oe:api:: python

            OEIsHetAtom() -> OEIsHetAtom

      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 the ‘hetero atom’ property in a
      residue; otherwise, it returns ``false``.

   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsHetAtom

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