.. oe:namespace:: OESz

.. meta::
   :keywords: OEProteinFlexOptions, ProteinFlexOptions


.. _OESz_OEProteinFlexOptions:

.. oe:class:: OEProteinFlexOptions

   .. oe:api::

      class OEProteinFlexOptions : public OESystem::OEOptions

   This class provides an interface to setup protein flexibility for flexible
   protein optimization, as used in *OEFlexProteinLigandOptimizer*.

   The :ref:`OEProteinFlexOptions <OESz_OEProteinFlexOptions>` class defines the following public methods:
    * :oe:meth:`GetFlexRange<OESz::OEProteinFlexOptions::GetFlexRange>` and
      :oe:meth:`SetFlexRange<OESz::OEProteinFlexOptions::SetFlexRange>`
    * :oe:meth:`GetResidueID<OESz::OEProteinFlexOptions::GetResidueID>` and
      :oe:meth:`SetResidueID<OESz::OEProteinFlexOptions::SetResidueID>`


   .. oe:method:: Constructor

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

         .. oe:api::

            OEProteinFlexOptions()
            OEProteinFlexOptions(const OEProteinFlexOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinFlexOptions() -> OEProteinFlexOptions
            OEProteinFlexOptions(arg2: OEProteinFlexOptions) -> OEProteinFlexOptions

      Default and copy constructors.

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

      .. oe:api::

         OEProteinFlexOptions &operator=(const OEProteinFlexOptions &)

      Assignment operator.


   .. oe:method:: GetFlexRange

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

         .. oe:api::

            double GetFlexRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexRange() -> float

      See :oe:meth:`SetFlexRange<OESz::OEProteinFlexOptions::SetFlexRange>` method.

   .. oe:method:: GetResidueID

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

         .. oe:api::

            std::string GetResidueID() const

      .. oe:language:: python

         .. oe:api:: python

            GetResidueID() -> str

      See :oe:meth:`SetResidueID<OESz::OEProteinFlexOptions::SetResidueID>` method.

   .. oe:method:: SetFlexRange

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

         .. oe:api::

            bool SetFlexRange(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexRange(value: float) -> bool

      Sets the **flexibility range** for protein flexibility. All the complete residues
      of the protein within the specified range (distance) from the ligand are considered
      flexible. Default: 2.0.

   .. oe:method:: SetResidueID

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

         .. oe:api::

            bool SetResidueID(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetResidueID(value: str) -> bool

      Sets the **residue ID** of the residues to be treated as flexible, using regular
      expressions. If this is specified, the :oe:meth:`FlexRange<OESz::OEProteinFlexOptions::SetFlexRange>` 
      is ignored. Default: None.
