.. oe:namespace:: OEBio


.. _OEBio_OELigandInteractionHintComponent:

.. oe:class:: OELigandInteractionHintComponent

   .. oe:api::

      class OELigandInteractionHintComponent : public OEInteractionHintComponentTypeBase

   Built-in component type that classifies molecules as being 'ligand' when
   stored in a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

   The following methods are publicly inherited from :ref:`OEInteractionHintComponentTypeBase <OEBio_OEInteractionHintComponentTypeBase>`:

   ============================================================================ ============================================================================ ============================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintComponentTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintComponentTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintComponentTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintComponentTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintComponentTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintComponentTypeBase::IsValid>`
   ============================================================================ ============================================================================ ============================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OELigandInteractionHintComponent()

      .. oe:language:: python

         .. oe:api:: python

            OELigandInteractionHintComponent() -> OELigandInteractionHintComponent

      Default constructor.

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

         .. oe:api::

            OELigandInteractionHintComponent(const OELigandInteractionHintComponent& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELigandInteractionHintComponent(arg2: OELigandInteractionHintComponent) -> OELigandInteractionHintComponent

      Copy constructor.

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

      .. oe:api::

         OELigandInteractionHintComponent &operator=(const OELigandInteractionHintComponent &rhs)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintComponentTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintComponentTypeBase

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


   .. oe:method:: GetMaxHeavyAtom

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

         .. oe:api::

            unsigned int GetMaxHeavyAtom() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxHeavyAtom() -> int

      Returns the maximum number of heavy atoms that a molecule
      allowed to have in order to be able to be considered as a 'ligand' in
      a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.


   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEChem::OEMolBase &) const

      .. oe:language:: python

         .. oe:api:: python

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

      Returns whether a molecule can be inserted to a
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object with a
      :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>` type *i.e.*
      it returns true if the molecule has 3D coordinates and its number
      of heavy atoms in the range of [1, 200].

      .. seealso::

         * :oe:meth:`OEBio::OELigandInteractionHintComponent::SetMaxHeavyAtom` method
         * :oe:meth:`OEBio::OELigandInteractionHintComponent::GetMaxHeavyAtom` method


   .. oe:method:: SetMaxHeavyAtom

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

         .. oe:api::

            void SetMaxHeavyAtom(unsigned int maxhvy)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxHeavyAtom(maxhvy: int) -> None

      Sets the maximum number of heavy atoms that a molecule
      allowed to have in order to be able to be considered as a 'ligand' in
      a :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.
