.. oe:namespace:: OEMedChem

.. oe:constnamespace:: OEMCSFragDatabaseSetup

   This namespace encodes symbolic constants used as bit-masks to
   indicate which MCS fragmentation indexing parameters are being
   created when invoking the
   :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function.

   .. seealso::

      * :ref:`OEMCSFragDatabaseOptions <OEMedChem_OEMCSFragDatabaseOptions>` class

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::AllFrags`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::BondFragLimit`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::FragCutsRange`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::FragMinMaxRange`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::FragmentationCuts`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::HeavyAtomLimit`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::IndexHydrogenSites`
      * :oe:const:`OEMedChem::OEMCSFragDatabaseSetup::RingCuts`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: AllFrags

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      all fragment indexing.

      ::

         Contents of parameter -allfrags
             Aliases : -all
             Type : bool
             Allow list : false
             Default : false
             Simple : true
             Required : false
             Brief : Index all fragment sizes, ignore fragment heavy atom percentage

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::HasIndexableFragmentHeavyAtomRange` method
         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::ClearIndexableFragmentRange` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BondFragLimit

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      maximum number of fragmentation bonds allowed.

      ::

         Contents of parameter -bondfraglimit
             Aliases : -blim
             Type : int
             Allow list : false
             Default : 20
             Simple : true
             Required : false
             Brief : Bond fragmentation limit

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetFragmentationLimit` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragCutsRange

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the minimum and maximum fragmentation bond cuts allowed.

      ::

         Contents of parameter -minfragcuts
             Aliases : -mincuts
             Type : int
             Allow list : false
             Default : 1
             Simple : true
             Required : false
             Legal ranges :
                 1 to 100
             Brief : Minimum number of fragmentation cuts allowed

         Contents of parameter -maxfragcuts
             Aliases : -maxcuts
             Type : int
             Allow list : false
             Default : 3
             Simple : true
             Required : false
             Legal ranges :
                 1 to 100
             Brief : Maximum number of fragmentation cuts allowed

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetFragLimits` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragMinMaxRange

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the min and max allowed fragment sizes to be indexed.

      ::

         Contents of parameter -fragGe
             Aliases : -ge
             Type : float
             Allow list : false
             Default : 85.0
             Simple : true
             Required : false
             Legal ranges :
                 0.0 to 100.0
             Brief : fragments greater than or equal to this heavy atom percentage

         Contents of parameter -fragLe
             Aliases : -le
             Type : float
             Allow list : false
             Default : 100.0
             Simple : true
             Required : false
             Legal ranges :
                 0.0 to 100.0
             Brief : fragments less than or equal to this heavy atom percentage

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetIndexableFragmentRange` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentationCuts

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the fragmentation bond cut combinations to be performed.

      ::

         Contents of parameter -fragcuts
             Aliases : -cuts
             Type : string
             Allow list : true
             Default : All
             Simple : true
             Required : false
             Legal values : Single Double Triple All
             Brief : Fragmentation bond combinations
             Detail

      .. seealso::

         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`
         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::SingleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::DoubleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::TripleCuts` constant
         * :oe:const:`OEMedChem::OEMatchedPairOptions::AllCuts` constant

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HeavyAtomLimit

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the limit for the maximum number of heavy atoms allowed for an indexed molecule.

      ::

         Contents of parameter -atomlimit
             Aliases : -alim
             Type : int
             Allow list : false
             Default : 100
             Simple : true
             Required : false
             Brief : Heavy atom limit

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetMaxAtomFilter` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IndexHydrogenSites

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      whether matched pairs that differ simply by hydrogen
      substitution is allowed.

      ::

         Contents of parameter -indexhydsites
             Aliases : -indexh
             Type : bool
             Allow list : false
             Default : true
             Simple : true
             Required : false
             Brief : Index hydrogen sites

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetOptions` method
         * :oe:const:`OEMedChem::OEMatchedPairOptions::IndexHSites` constant
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RingCuts

      Passing this constant to the
      :oe:func:`OEMedChem::OEConfigureMCSFragDatabaseOptions` function results
      in generating the following default interface to configure
      the maximum number of ring cuts allowed.

      ::

         Contents of parameter -ringcuts
             Aliases : -ring
             Type : int
             Allow list : false
             Default : 0
             Simple : true
             Required : false
             Brief : Maximum number of ring fragmentation cuts allowed (0: disabled)

      .. seealso::

         * :oe:meth:`OEMedChem::OEMCSFragDatabaseOptions::SetRingFragLimit` method
         * :oe:func:`OEMedChem::OESetupMCSFragDatabaseOptions`

