.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFragOptions, FragOptions


.. _OEConfGen_OEFragOptions:

.. oe:class:: OEFragOptions

   .. oe:api::

      class OEFragOptions

   This class provides an interface to setup options required for generating 
   fragment coordinates for a specific type of fragment.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   The :ref:`OEFragOptions <OEConfGen_OEFragOptions>` class defines the following public methods:
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEFragOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>`
    * :oe:meth:`GetFragGen<OEConfGen::OEFragOptions::GetFragGen>` and
      :oe:meth:`SetFragGen<OEConfGen::OEFragOptions::SetFragGen>`
    * :oe:meth:`GetFragKeep<OEConfGen::OEFragOptions::GetFragKeep>` and
      :oe:meth:`SetFragKeep<OEConfGen::OEFragOptions::SetFragKeep>`
    * :oe:meth:`GetRMS<OEConfGen::OEFragOptions::GetRMS>` and
      :oe:meth:`SetRMS<OEConfGen::OEFragOptions::SetRMS>`
    * :oe:meth:`GetTimeLimit<OEConfGen::OEFragOptions::GetTimeLimit>` and
      :oe:meth:`SetTimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFragOptions()
            OEFragOptions(const OEFragOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFragOptions() -> OEFragOptions
            OEFragOptions(arg2: OEFragOptions) -> OEFragOptions

      Default and copy constructors.

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

      .. oe:api::

         OEFragOptions &operator=(const OEFragOptions &)

      Assignment operator.

   .. _OEConfGen_OEFragOptions_GetEnergyWindow:


   .. oe:method:: GetEnergyWindow

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

         .. oe:api::

            double GetEnergyWindow() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OEFragOptions::SetEnergyWindow>` method.

   .. _OEConfGen_OEFragOptions_GetFragGen:


   .. oe:method:: GetFragGen

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

         .. oe:api::

            unsigned int GetFragGen() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragGen() -> int

      See the :oe:meth:`SetFragGen<OEConfGen::OEFragOptions::SetFragGen>` method.

   .. _OEConfGen_OEFragOptions_GetFragKeep:


   .. oe:method:: GetFragKeep

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

         .. oe:api::

            unsigned int GetFragKeep() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragKeep() -> int

      See the :oe:meth:`SetFragKeep<OEConfGen::OEFragOptions::SetFragKeep>` method.

   .. _OEConfGen_OEFragOptions_GetRMS:


   .. oe:method:: GetRMS

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

         .. oe:api::

            double GetRMS() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMS() -> float

      See the :oe:meth:`SetRMS<OEConfGen::OEFragOptions::SetRMS>` method.

   .. _OEConfGen_OEFragOptions_GetTimeLimit:


   .. oe:method:: GetTimeLimit

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

         .. oe:api::

            double GetTimeLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetTimeLimit() -> float

      See the :oe:meth:`SetTimeLimit<OEConfGen::OEFragOptions::SetTimeLimit>` method.

   .. _OEConfGen_OEFragOptions_SetEnergyWindow:


   .. oe:method:: SetEnergyWindow

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

         .. oe:api::

            bool SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      Sets the **maximum allowable energy difference** between the
      lowest and the highest energy fragment conformers, in units of kcal/mol. 
      Default: 8.0 kcal/mol

   .. _OEConfGen_OEFragOptions_SetFragGen:

   .. oe:method:: SetFragGen

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

         .. oe:api::

            bool SetFragGen(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetFragGen(value: int) -> bool

      Sets the **maximum number of fragment conformers** to generate in
      obtaining the ensemble of fragment conformers. 
      Default: 40

   .. _OEConfGen_OEFragOptions_SetFragKeep:


   .. oe:method:: SetFragKeep

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

         .. oe:api::

            bool SetFragKeep(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetFragKeep(value: int) -> bool

      Sets the **maximum number of fragments** to keep from the
      generated ensemble. Default: 1

   .. _OEConfGen_OEFragOptions_SetRMS:


   .. oe:method:: SetRMS

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

         .. oe:api::

            bool SetRMS(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetRMS(value: float) -> bool

      Sets the **RMS distance** (Root Mean Square Cartesian distance) 
      below which two conformers are treated as duplicates.
      Default: 0.1

  .. _OEConfGen_OEFragOptions_SetTimeLimit:


   .. oe:method:: SetTimeLimit

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

         .. oe:api::

            bool SetTimeLimit(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetTimeLimit(value: float) -> bool

      Sets the **maximum allowable time** for generating conformers
      of a fragment, in units of seconds. Default: 300.0 s
