.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsMonomerGroup

.. _OEChem_OEIsMonomerGroup:

.. oe:class:: OEIsMonomerGroup

   .. oe:api::

      class  OEIsMonomerGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEIsMonomerGroup <OEChem_OEIsMonomerGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that store monomer information.

   .. seealso::

      * :oe:constns:`OEChem::OEGroupType` for built-in group types.
      * :oe:cls:`OEChem::OEHasMonomerGroup` for a functor that identifies groups that match a monomer group by code set and code.

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

            OEIsMonomerGroup()

      .. oe:language:: python

         .. oe:api:: python

            __init__() -> OEIsMonomerGroup

      Default constructor.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()
      :language: c++

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

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the number returned by the
      :oe:meth:`OEChem::OEGroupBase::GetGroupType` method is  :oe:const:`OEChem::OEGroupType::Monomer`.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

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