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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OERingFragOptions, RingFragOptions


.. _OEConfGen_OERingFragOptions:

.. oe:class:: OERingFragOptions

   .. oe:api::

      class OERingFragOptions : public OEFragOptions

   This class provides an interface to set up options required for generating
   coordinates for ring fragments.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class
   
   The following methods are publicly inherited from :ref:`OEFragOptions <OEConfGen_OEFragOptions>`:
    * :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>`

   The :ref:`OERingFragOptions <OEConfGen_OERingFragOptions>` class defines the following public methods:
    * :oe:meth:`GetStartFactor<OEConfGen::OERingFragOptions::GetStartFactor>` and
      :oe:meth:`SetStartFactor<OEConfGen::OERingFragOptions::SetStartFactor>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OERingFragOptions()
            OERingFragOptions(const OERingFragOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OERingFragOptions() -> OERingFragOptions
            OERingFragOptions(arg2: OERingFragOptions) -> OERingFragOptions

      Default and copy constructors.

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

      .. oe:api::

         OERingFragOptions &operator=(const OERingFragOptions &)

      Assignment operator.

   .. _OEConfGen_OERingFragOptions_GetStartFactor:

   .. oe:method:: GetStartFactor

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

         .. oe:api::

            unsigned GetStartFactor() const

      .. oe:language:: python

         .. oe:api:: python

            GetStartFactor() -> int

      See the :oe:meth:`SetStartFactor<OEConfGen::OERingFragOptions::SetStartFactor>` method.

   .. _OEConfGen_OERingFragOptions_SetStartFactor:

   .. oe:method:: SetStartFactor

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

         .. oe:api::

            bool SetStartFactor(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetStartFactor(value: int) -> bool

      Sets a **multiplicative factor** that determines how many starts 
      are to be used for generating ring fragment coordinates.
      Default: 2
