.. oe:namespace:: OEDepict


.. meta::
   :keywords: OEDisplayAtomMapIdx, DisplayAtomMapIdx


.. _OEDepict_OEDisplayAtomMapIdx:

.. oe:class:: OEDisplayAtomMapIdx

   .. oe:api::

      class OEDisplayAtomMapIdx : public OEDisplayAtomPropBase

   This class represents :ref:`OEDisplayAtomMapIdx <OEDepict_OEDisplayAtomMapIdx>` atom property label
   functor.

   .. seealso::

      * :oe:meth:`OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor` method
      * :ref:`OEDisplayAtomIdx <OEDepict_OEDisplayAtomIdx>` class
      * :ref:`OEDisplayNoAtomProp <OEDepict_OEDisplayNoAtomProp>` class
      * :oe:src:`Listing 2<SNIPPET-DEPICTMDLREACTION-MAPIDX-DepictMDLReactionMapIdx>` example in the
        :ref:`chapter_mdlreaction` chapter


   The following methods are publicly inherited from :ref:`OEDisplayAtomPropBase <OEDepict_OEDisplayAtomPropBase>`:

   ================================================================== ==================================================================
   :oe:meth:`CreateCopy<OEDepict::OEDisplayAtomPropBase::CreateCopy>` :oe:meth:`operator()<OEDepict::OEDisplayAtomPropBase::operator()>`
   ================================================================== ==================================================================

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEDisplayAtomMapIdx()

      .. oe:language:: python

         .. oe:api:: python

            OEDisplayAtomMapIdx() -> OEDisplayAtomMapIdx

      Default constructor.

   .. ################################################################
      # operator()
      ################################################################

   .. oe:method:: operator()

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

         .. oe:api::

            std::string operator()(const OEChem::OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> str

      Returns the string representation of the *reaction map index*
      property of the atom. 
      (i.e. the number returned by the :oe:meth:`OEChem::OEAtomBase::GetMapIdx` 
      method).
      The `reaction map index` is used for tracking equivalent atom
      positions in the reaction.
      If `the reaction map index` is zero, meaning that the atom isn't
      mapped in the reaction, than this function returns an empty string.


   .. ################################################################
      # CreateCopy
      ################################################################

   .. oe:method:: CreateCopy

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

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEDisplayAtomPropBase

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