.. oe:namespace:: OEBio


.. _OEBio_OEInteractionHintTypeBase:

.. oe:class:: OEInteractionHintTypeBase

   .. oe:api::

      class OEInteractionHintTypeBase


   The :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` is an abstract class that
   enables to type interactions
   (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`) stored in a
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following classes derive from this class:
    * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
    * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
    * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
    * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
    * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
    * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
    * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
    * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
    * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`

   .. oe:method:: Constructors

      .. oe:api::

         OEInteractionHintTypeBase(const std::string& name)

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

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

      .. oe:api::

         OEInteractionHintTypeBase(const OEInteractionHintTypeBase& rhs)

      Copy constructor.


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

      .. oe:api::

         OEInteractionHintTypeBase& operator=(const OEInteractionHintTypeBase& rhs)

      Assignment operator.


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

      .. oe:api::

         bool operator!=(const OEInteractionHintTypeBase &) const


      Determines whether two interaction types, derived from the
      :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` class, are different.


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

      .. oe:api::

         bool operator==(const OEInteractionHintTypeBase &) const


      Determines whether two interaction types, derived from the
      :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>` class, are identical.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

      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 interaction type.


   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHint &) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHint) -> bool

      Returns whether the given interaction is considered valid for
      the given interaction type.

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool


      This is a virtual method that has to be implemented in the concrete
      derived classes to evaluate whether the two given fragments form a valid
      interaction for the given concrete interaction type.

