.. oe:namespace:: OEBio


.. meta::
   :keywords: OEReceptorCustomConstraints, ReceptorCustomConstraints


.. _OEBio_OEReceptorCustomConstraints:

.. oe:class:: OEReceptorCustomConstraints

   .. oe:api::

      class OEReceptorCustomConstraints

   :ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>` holds a set of custom docking
   constraint features.  Each custom constraint is defined by an
   :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` contained by this class.

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

         .. oe:api::

            OEReceptorCustomConstraints()
            OEReceptorCustomConstraints(const OEReceptorCustomConstraints& )

      .. oe:language:: python

         .. oe:api:: python

            OEReceptorCustomConstraints() -> OEReceptorCustomConstraints
            OEReceptorCustomConstraints(arg2: OEReceptorCustomConstraints) -> OEReceptorCustomConstraints

      Default and copy constructors.

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

         OEReceptorCustomConstraints& operator=(const OEReceptorCustomConstraints&)

      Assignment operator.

   ..   _OEBio_GetConstraintFeatures:

   .. oe:method:: GetConstraintFeatures

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

         .. oe:api::

            OESystem::OEIterBase<OEReceptorConstraintFeature>* GetConstraintFeatures(bool enabledOnly = true)
            OESystem::OEIterBase<const OEReceptorConstraintFeature>* GetConstraintFeatures(bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            GetConstraintFeatures(const: bool) -> Iterable[OEReceptorConstraintFeature]

      Returns an iterator over all features contained by this class, 
      or all enabled features if *enabledOnly* is true 
      (see :oe:meth:`OEBio::OEReceptorConstraintFeature::GetEnabled` method).

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

         .. oe:api::

            OEReceptorConstraintFeature* AddNewFeature()

      .. oe:language:: python

         .. oe:api:: python

            AddNewFeature() -> OEReceptorConstraintFeature

      Adds a new :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` object to this class and returns a pointer
      to the newly created :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`.  The returned
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` object is owned by this class, and will be destroyed
      by the destructor of this class.

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

         .. oe:api::

            bool DeleteFeature(const OEReceptorConstraintFeature* feature)

      .. oe:language:: python

         .. oe:api:: python

            DeleteFeature(arg2: OEReceptorConstraintFeature) -> bool

      Deletes an :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` owned by this class.  Note that after
      this method is called *feature* will no longer point to a valid 
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` object.

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

         .. oe:api::

            unsigned int NumFeatures(bool enabledOnly = true) const

      .. oe:language:: python

         .. oe:api:: python

            NumFeatures(enabledOnly: bool = True) -> int

      Returns the number of :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` objects contained by this
      class.  

      If *enabledOnly* is true then only :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` objects
      for which the method :oe:meth:`OEBio::OEReceptorConstraintFeature::GetEnabled` returns true will
      be counted.
    
   .. oe:method:: Clear
         
      .. oe:language:: c++ java csharp

         .. oe:api::

            bool Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> bool

      Returns this object to its default constructed state, deleting any 
      :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>` objects it may currently be holding.

         

