.. oe:namespace:: OEBio


.. meta::
   :keywords: OEReceptorProteinConstraint, ReceptorProteinConstraint


.. _OEBio_OEReceptorProteinConstraint:

.. oe:class:: OEReceptorProteinConstraint

   .. oe:api::

      class OEReceptorProteinConstraint

   This class holds information about a single receptor protein constraint.

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

      .. oe:api::

         OEReceptorProteinConstraint & operator=(const OEReceptorProteinConstraint &)

      Assignment operator.


   .. oe:method:: GetAtom

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

         .. oe:api::

            OEChem::OEAtomBase* GetAtom(const OEChem::OEMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom(mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEAtomBase

      Return the protein atom of the receptor the constraint is associated with.
      The input molecule refers to the corresponding target protein.

   .. oe:method:: GetType

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

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

      Type for the constraint (see :oe:constns:`OEBio::OEProteinConstraintType`).

   .. oe:method:: GetEnabled

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

         .. oe:api::

            bool GetEnabled() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnabled() -> bool

      Returns true if the constraint is enabled and false otherwise.

   .. 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 of the constraint.

   .. oe:method:: SetAtom

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

         .. oe:api::

            void SetAtom(OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            SetAtom(atom: OEAtomBase) -> None

      Sets the atom of the receptor the constraint will be associated with.

   .. oe:method:: SetType

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

         .. oe:api::

            void SetType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetType(type: int) -> bool

      Sets the constraint type (see :oe:constns:`OEBio::OEProteinConstraintType`).

   .. oe:method:: SetName

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

         .. oe:api::

            void SetEnabled(bool enabled)

      .. oe:language:: python

         .. oe:api:: python

            SetName(name: str) -> bool

      Sets the name of the constraint.

   .. oe:method:: SetEnabled

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

         .. oe:api::

            void SetName(std::string name)

      .. oe:language:: python

         .. oe:api:: python

            SetEnabled(enabled: bool) -> bool

      Sets the enabled flag of the constraint.

