.. oe:namespace:: OEBio


.. _OEBio_OEInteractionHintComponentTypeBase:

.. oe:class:: OEInteractionHintComponentTypeBase

   .. oe:api::

      class OEInteractionHintComponentTypeBase

   The :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>` is an abstract class that
   enables to type molecule and fragments stored in a
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following classes derive from this class:
    * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
    * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`


   .. oe:method:: Constructors

      .. oe:api::

         OEInteractionHintComponentTypeBase(const std::string& name)

      Creates an component type with the given name (identifier).

      *name*
        A unique string representing a specific component type.

      .. oe:api::

         OEInteractionHintComponentTypeBase(const OEInteractionHintComponentTypeBase& rhs)

      Copy constructor.


   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEInteractionHintComponentTypeBase& operator=(const OEInteractionHintComponentTypeBase& rhs)


      Assignment operator.


   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEInteractionHintComponentTypeBase &) const

      Determines whether two component types, derived from the
      :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>` class, are identical.


   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEInteractionHintComponentTypeBase &) const

      Determines whether two component types, derived from the
      :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>` class, are different.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintComponentTypeBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintComponentTypeBase

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


   .. oe:method:: GetName

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

         .. oe:api::

            std::string GetName() const

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the name (identifier) of the connection type.


   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEChem::OEMolBase &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      This is a virtual method that has to be implemented in the concrete
      derived classes to evaluate whether the given molecule is valid for
      for the given concrete component type.

