.. oe:namespace:: OEChem


.. meta::
   :keywords: OEHasFormalCharge, HasFormalCharge


.. _OEChem_OEHasFormalCharge:

.. oe:class:: OEHasFormalCharge

   .. oe:api::

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

   This class represents :ref:`OEHasFormalCharge <OEChem_OEHasFormalCharge>` functor
   that identifies atoms (:ref:`OEAtomBase <OEChem_OEAtomBase>`) with a specific formal charge.

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

            OEHasFormalCharge(int c)

      .. oe:language:: python

         .. oe:api:: python

            OEHasFormalCharge(c: int) -> OEHasFormalCharge

      Constructs the functor with the given formal charge.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the charge returned by the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method for the given :ref:`OEAtomBase <OEChem_OEAtomBase>`
      object is equivalent to the charge with which the functor is constructed.

   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHasFormalCharge

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