.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEGrapheme


.. _OEGrapheme_OEResidueSVGMarkupBase:

.. oe:class:: OEResidueSVGMarkupBase

   .. oe:api::

      class OEResidueSVGMarkupBase

   :ref:`OEResidueSVGMarkupBase <OEGrapheme_OEResidueSVGMarkupBase>` is an abstract base class.
   Concrete class derived from this base class defines the markup of
   the residues in :file:`.svg` images generated
   when calling the :ref:`OERenderActiveSite <OEGrapheme_OERenderActiveSite>` function.
   Drawing elements representing residues in :file:`.svg` image are grouped together
   in the following format in which the ``<group id>`` and ``<class name>``
   strings can be defined in the derived concrete classes.

   ::

      <g id='<group id>' class='<class name>'>
      ..
      list of drawing elements
      ..
      </g>


   The following classes derive from this class:

    * :ref:`OEResidueSVGNoMarkup <OEGrapheme_OEResidueSVGNoMarkup>`
    * :ref:`OEResidueSVGStandardMarkup <OEGrapheme_OEResidueSVGStandardMarkup>`

   .. seealso::

      * :oe:meth:`OEGrapheme::OE2DActiveSiteDisplayOptions::SetResidueSVGMarkupFunctor` method
      * :ref:`chapter_svg` chapter in **OEDepict TK** manual


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

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEResidueSVGMarkupBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEResidueSVGMarkupBase

      Virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.


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

   .. oe:method:: GetClassName

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

         .. oe:api::

            std::string GetClassName(const OEChem::OEResidue &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetClassName(arg0: OEResidue) -> str

      Returns the ``<class name>`` associated with a specific residue group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.


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

   .. oe:method:: GetGroupId

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

         .. oe:api::

            std::string GetGroupId(const OEChem::OEResidue &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetGroupId(arg0: OEResidue) -> str

      Returns the ``<group id>`` associated with a specific residue group
      in the :file:`.svg` image.
      This is a virtual method that has to be implemented in the concrete
      derived classes.
