.. oe:namespace:: OEChem

.. include:: ../substitutions

..  _OEChem_OEIFlavor:

.. oe:constnamespace:: OEIFlavor

   The :oe:constns:`OEChem::OEIFlavor` namespace encodes symbolic
   constants used as bit-masks to indicate how to write various
   file formats by **OEChem TK**.

      .. note::

         A very important introduction (with examples) as to how to manipulate these
         bit-masks is given :ref:`section_molreadwrite_flavoredinputandoutput`

   The :oe:constns:`OEChem::OEIFlavor::Generic` namespace within
   :oe:constns:`OEChem::OEIFlavor` defines control bit-masks that are
   common to all of the input formats.
   Although these generic bits are common to all file formats, they
   may be specified independently for each file format.

   .. seealso::

      * :oe:meth:`OEChem::oemolistream::SetFormat` method to set the flavor of an input molecule stream
      * :oe:meth:`OEChem::oemolstreambase::GetFormat` method to retrieve the flavor of a molecule stream

   The interpretation of many of these flavor values, is identical to
   those passed to the corresponding **OEChem TK** low-level file format
   readers.

   This namespace contains the following namespaces:

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

   ..  _OEChem_OEIFlavor_CAN:

   .. oe:constnamespace:: OEIFlavor::CAN

      The :oe:constns:`OEChem::OEIFlavor::CAN` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::CAN` format file by
      the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_CAN_Default:

      .. oe:constant:: Default

         No special options are set.


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


   ..  _OEChem_OEIFlavor_CDX:

   .. oe:constnamespace:: OEIFlavor::CDX

      The :oe:constns:`OEChem::OEIFlavor::CDX` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::CDX` format file by
      the :oe:func:`OEChem::OEReadCDXFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_CDX_SuperAtom:

      .. oe:constant:: SuperAtom

         Controls whether nested CDX fragment objects, which represent
         superatom abbreviation groups, are expanded and read with their
         atoms parented to the enclosing atom. When this flag is set (the
         default), abbreviations such as ``Ph`` or ``OMe`` embedded in a
         CDX structure are interpreted as substructures.

      ..  _OEChem_OEIFlavor_CDX_Default:

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::CDX::SuperAtom` constant.

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


   ..  _OEChem_OEIFlavor_CIF:

   .. oe:constnamespace:: OEIFlavor::CIF

      The :oe:constns:`OEChem::OEIFlavor::CIF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::CIF` format file by the
      :oe:func:`OEChem::OEReadCIFFile` low-level file reader.

      This namespace contains the following constants, that mimic the XYZ reader.


      ..  _OEChem_OEIFlavor_CIF_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.


      ..  _OEChem_OEIFlavor_CIF_ImplicitH:

      .. oe:constant:: ImplicitH

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignImplicitHydrogens` function to
         assign implicit hydrogens.


      ..  _OEChem_OEIFlavor_CIF_BondOrder:

      .. oe:constant:: BondOrder

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEPerceiveBondOrders` function to
         perceive bond orders.


      ..  _OEChem_OEIFlavor_CIF_Rings:

      .. oe:constant:: Rings

      The reader stores excluded sites and sites left after filtering. The filtering of these sites is based on the flavors listed below.


      ..  _OEChem_OEIFlavor_CIF_OccFilterOneHalf:

      .. oe:constant:: OccFilterOneHalf

         If occupancy is noted in the CIF file, only the sites with occupancy larger than one half is kept.
         If occupancy is not defined in the CIF file, the occupancies are set to 1 to prevent filtering.

      ..  _OEChem_OEIFlavor_CIF_RemovePBCImages:

      .. oe:constant:: RemovePBCImages

         Each site read is checked to see if it is equal to a previously read site up to periodic wrapping in fractional coordinates.


      ..  _OEChem_OEIFlavor_CIF_NormalizeHydPos:

      .. oe:constant:: NormalizeHydPos

         Hydrogen positions and bond lengths are normalized if necessary.


      ..  _OEChem_OEIFlavor_CIF_BondHydToClosest:

      .. oe:constant:: BondHydToClosest

         Enforces that hydrogen atoms are bonded to their closest heavy atom in space.


      ..  _OEChem_OEIFlavor_CIF_RemoveQuestionMarkInLabel:

      .. oe:constant:: RemoveQuestionMarkInLabel

         Sites with a question mark after atom labels are assigned are filtered out. These extra sites are sometimes alternative positions of existing sites.

      ..  _OEChem_OEIFlavor_CIF_Default:

      .. oe:constant:: Default

         Combination of:
         :oe:const:`OEChem::OEIFlavor::CIF::FormalCrg`,
         :oe:const:`OEChem::OEIFlavor::CIF::ImplicitH`,
         :oe:const:`OEChem::OEIFlavor::CIF::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::CIF::Rings`,
         :oe:const:`OEChem::OEIFlavor::CIF::OccFilterOneHalf`,
         :oe:const:`OEChem::OEIFlavor::CIF::RemovePBCImages`,
         :oe:const:`OEChem::OEIFlavor::CIF::NormalizeHydPos`,
         :oe:const:`OEChem::OEIFlavor::CIF::BondHydToClosest`,
         :oe:const:`OEChem::OEIFlavor::CIF::RemoveQuestionMarkInLabel` flags.

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

      ..  _OEChem_OEIFlavor_CSV:

   .. oe:constnamespace:: OEIFlavor::CSV

      This namespace contains constants for modifying the behavior of
      how the :oe:const:`OEChem::OEFormat::CSV` file format is read.

      .. seealso::

         :ref:`section_moltaggeddata_CSV`

      ..  _OEChem_OEIFlavor_CSV_Header:

      .. oe:constant:: Header

         Attempt to interpret the first line of the :file:`.csv` file
         as a header line containing column names. The header line
         will be parsed into an :ref:`OECSVHeader <OEChem_OECSVHeader>` object and
         stored on the :ref:`oemolistream <OEChem_oemolistream>` object,
         retrievable by :oe:meth:`OEChem::oemolstreambase::GetCSVHeader`.

         If this flag is not set, or the first column of the first
         line does not contain a valid :term:`SMILES` string, the
         :ref:`OECSVHeader <OEChem_OECSVHeader>` will be initialized with the
         number of columns present in the first line of the file. The
         columns will then be named and parsed in the following order:
         SMILES, TITLE, OE_CSV_COLUMN_1, OE_CSV_COLUMN_2, ...,
         OE_CSV_COLUMN_N.

      ..  _OEChem_OEIFlavor_CSV_Default:

      .. oe:constant:: Default

         Set to include :oe:const:`OEChem::OEIFlavor::CSV::Header` to
         automatically parse column names into molecule SD data.

      .. oe:constant:: DEFAULT

         Synonym for :oe:const:`OEChem::OEIFlavor::CSV::Default`.


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

      ..  _OEChem_OEIFlavor_CXSMILES:

   .. oe:constnamespace:: OEIFlavor::CXSMILES

      The :oe:constns:`OEChem::OEIFlavor::CXSMILES` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_CXSMILES_Strict:

      .. oe:constant:: Strict

         Enables strict parsing mode for CXSMILES strings. The parser
         applies more rigorous sanity checking, rejecting malformed
         :term:`SMILES` strings that would be accepted by the non-strict
         parser. For example, ``C==C`` is accepted by default but rejected
         in strict mode.

      ..  _OEChem_OEIFlavor_CXSMILES_Canon:

      .. oe:constant:: Canon

         When set, the parser assumes the :term:`SMILES` string is
         well-formed and omits the usual kekulization step performed by
         :oe:func:`OEChem::OEKekulize`. This can speed up parsing of large
         databases, but bond orders may not be correctly assigned for
         aromatic molecules.

      ..  _OEChem_OEIFlavor_CXSMILES_Default:

      .. oe:constant:: DEFAULT

         No special parsing options are set. Both
         :oe:const:`OEChem::OEIFlavor::CXSMILES::Strict` and
         :oe:const:`OEChem::OEIFlavor::CXSMILES::Canon` flags are disabled.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::CXSMILES::DEFAULT` constant.


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


   ..  _OEChem_OEIFlavor_FASTA:

   .. oe:constnamespace:: OEIFlavor::FASTA

      The :oe:constns:`OEChem::OEIFlavor::FASTA` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::FASTA` format file by
      the :oe:func:`OEChem::OEReadFASTAFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_FASTA_Default:

      .. oe:constant:: Default

         No special options are selected.

      ..  _OEChem_OEIFlavor_FASTA_CustomResidues:

      .. oe:constant:: CustomResidues

         Instructs the FASTA reader to interpret values surrounded in
         square brackets, ``[foo]``, as custom residues. The structure
         of these custom residues must first be registered with the
         :oe:func:`OEChem::OEAddCustomFASTAResidue` function.

         .. warning::

            This is an experimental API that may change in the future.

      ..  _OEChem_OEIFlavor_FASTA_EmbeddedSMILES:

      .. oe:constant:: EmbeddedSMILES

         Instructs the FASTA reader to interpret values surrounded in
         square brackets, ``[CCC]``, as :term:`SMILES` strings if a
         custom residue with the same name can not be found. The
         :term:`SMILES` can optionally contain attachment points back
         to the peptide backbone. For example, ``[[R1]CSC[R15]]``
         specifies to attach to the first and fifteenth residue in the
         peptide, effectively cyclizing the peptide.

         .. warning::

            This is an experimental API that may change in the future.

      ..  _OEChem_OEIFlavor_FASTA_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::FASTA::CustomResidues` and
         :oe:const:`OEChem::OEIFlavor::FASTA::EmbeddedSMILES` flags.

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

   ..  _OEChem_OEIFlavor_Generic:


   .. oe:constnamespace:: OEIFlavor::Generic

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_Generic_OEAroModelDaylight:


      .. oe:constant:: OEAroModelDaylight

         This flag indicates that the Daylight aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_OEAroModelOpenEye:

      .. oe:constant:: OEAroModelOpenEye

         This flag indicates that the OpenEye aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.


      ..  _OEChem_OEIFlavor_Generic_OEAroModelTripos:

      .. oe:constant:: OEAroModelTripos

         This flag indicates that the Tripos aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.


      ..  _OEChem_OEIFlavor_Generic_OEAroModelMMFF:

      .. oe:constant:: OEAroModelMMFF

         This flag indicates that the MMFF aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_OEAroModelMDL:

      .. oe:constant:: OEAroModelMDL

         This flag indicates that the MDL aromaticity model is
         used to perceive aromaticity by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader.

      ..  _OEChem_OEIFlavor_Generic_AroMask:


      .. oe:constant:: AroMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelDaylight`,
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelOpenEye`,
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelTripos`,
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelMMFF` and
         :oe:const:`OEChem::OEIFlavor::Generic::OEAroModelMDL` flags.

         .. seealso::

            * :ref:`section_aromaticity_models` section
            * :oe:func:`OEChem::OEAssignAromaticFlags` function

      ..  _OEChem_OEIFlavor_Generic_Rings:


      .. oe:constant:: Rings

         This flag indicates the rings are perceived by the
         :oe:func:`OEChem::OEReadMolecule` high-level reader by calling
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

      ..  _OEChem_OEIFlavor_GenericMask:


      .. oe:constant:: GenericMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::Generic::AroMask` and
         :oe:const:`OEChem::OEIFlavor::Generic::Rings` flags.

      ..  _OEChem_OEIFlavor_Generic_SpecificMask:


      .. oe:constant:: SpecificMask

         Bit mask covering all format-specific flavor bits (bits 0-13).
         This is the complement of
         :oe:const:`OEChem::OEIFlavor::Generic::GenericMask`.

      ..  _OEChem_OEIFlavor_Generic_Default:


      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEIFlavor::Generic::Rings`
         constant. Ring perception is performed after every molecule
         read by the high-level :oe:func:`OEChem::OEReadMolecule` reader.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::Generic::DEFAULT` constant.


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

   .. oe:constnamespace: OEIFlavor::INCHI # THIS IS COMMENTED OUT
      The :oe:constns:`OEChem::OEIFlavor::INCHI` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::INCHI` format file by
      the :oe:func:`OEChem::OEParseInChI` function.
      This namespace contains the following constants:
      .. oe:constant:: Default


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


   ..  _OEChem_OEIFlavor_ISM:


   .. oe:constnamespace:: OEIFlavor::ISM

      The :oe:constns:`OEChem::OEIFlavor::ISM` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::ISM` format file by
      the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:


      ..  _OEChem_OEIFlavor_ISM_Default:

      .. oe:constant:: Default

         No special options are set.


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

   ..  _OEChem_OEIFlavor_MDL:

   .. oe:constnamespace:: OEIFlavor::MDL

      The :oe:constns:`OEChem::OEIFlavor::MDL` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MDL` format file by
      the :oe:func:`OEChem::OEReadMDLFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MDL_Default:

      .. oe:constant:: Default

         No special options are set. The
         :oe:const:`OEChem::OEIFlavor::MDL::FixBondMarks`,
         :oe:const:`OEChem::OEIFlavor::MDL::SuppressEmptyMolSkip`,
         :oe:const:`OEChem::OEIFlavor::MDL::SuppressImp2ExpENHSTE`, and
         :oe:const:`OEChem::OEIFlavor::MDL::ForceImp2ExpENHSTE` flags
         are all disabled.

      ..  _OEChem_OEIFlavor_MDL_FixBondMarks:

      .. oe:constant:: FixBondMarks

      This input flavor requests that the reader make an attempt
      to repair stereocenters that throw warnings due to issues identified
      by :oe:func:`OEChem::OEMDLStereoFromBondStereo`.  With this input flavor
      enabled, the warnings will continue to be issued to allow user inspection and verification
      of the modified bond marks.  However, once the corrected structure(s) have been rewritten
      with any format that captures bond stereomark information, a re-read of the structure(s)
      should emit fewer stereocenter correction warnings. This input flavor is not
      enabled for the default :oe:const:`OEChem::OEFormat::MDL` setting.


      ..  _OEChem_OEIFlavor_MDL_SuppressEmptyMolSkip:

      .. oe:constant:: SuppressEmptyMolSkip

      This input flavor suppresses the default action of skipping empty molecules
      in the input stream. This may be important in order to recover SDData stored on empty molecule records.

      ..  _OEChem_OEIFlavor_MDL_SuppressImp2ExpENHSTE:

      .. oe:constant:: SuppressImp2ExpENHSTE

      This input flavor suppresses any enhanced stereogroup implicit to explicit
      conversions for an input V3000 format molfile.

      ..  _OEChem_OEIFlavor_MDL_ForceImp2ExpENHSTE:

      .. oe:constant:: ForceImp2ExpENHSTE

      This input flavor performs implicit to explicit enhanced stereogroup
      conversions for an input V2000 or V3000 format molfile.

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

   .. oe:constnamespace: OEIFlavor::MF IGNORED
      This namespace contains the following constants:
      .. oe:constant:: Default


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


   ..  _OEChem_OEIFlavor_MMCIF:

   .. oe:constnamespace:: OEIFlavor::MMCIF

      The :oe:constns:`OEChem::OEIFlavor::MMCIF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MMCIF` format file by
      the :oe:func:`OEChem::OEReadCIFFile` low-level file reader.

      This namespace contains the following constants.

      ..  _OEChem_OEIFlavor_MMCIF_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_MMCIF_ImplicitH:

      .. oe:constant:: ImplicitH

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignImplicitHydrogens` function to
         assign implicit hydrogens.

      ..  _OEChem_OEIFlavor_MMCIF_BondOrder:

      .. oe:constant:: BondOrder

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEPerceiveBondOrders` function to
         perceive bond orders.

      ..  _OEChem_OEIFlavor_MMCIF_Rings:

      .. oe:constant:: Rings

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function to
         determine ring structure.

      ..  _OEChem_OEIFlavor_MMCIF_Connect:

      .. oe:constant:: Connect

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEDetermineConnectivity` function to
         perceive bond connectivity from atomic coordinates.

      ..  _OEChem_OEIFlavor_MMCIF_SecStruct:

      .. oe:constant:: SecStruct

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEBio::OEPerceiveSecondaryStructure` function to
         assign secondary structure.

      ..  _OEChem_OEIFlavor_MMCIF_ALTLOC:

      .. oe:constant:: ALTLOC

         This flavor is required when :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`
         is to be used so that all the atoms with alternate location codes
         are retained.

      ..  _OEChem_OEIFlavor_MMCIF_DEFAULT:

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEIFlavor::MMCIF::Connect`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::Rings`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::ImplicitH`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::SecStruct`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::FormalCrg`, flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::MMCIF::DEFAULT` constant.

      ..  _OEChem_OEIFlavor_MMCIF_SpruceDefault:

      .. oe:constant:: SpruceDefault

         Combination of
         :oe:const:`OEChem::OEIFlavor::MMCIF::DEFAULT`,
         :oe:const:`OEChem::OEIFlavor::MMCIF::ALTLOC`, flags.

      ..  _OEChem_OEIFlavor_MMCIF_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::MMCIF::DEFAULT` and
         :oe:const:`OEChem::OEIFlavor::MMCIF::ALTLOC` flags.

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

   ..  _OEChem_OEIFlavor_MMOD:

   .. oe:constnamespace:: OEIFlavor::MMOD

      The :oe:constns:`OEChem::OEIFlavor::MMOD` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MMOD` format file by
      the :oe:func:`OEChem::OEReadMacroModelFile` low-level file reader.

      This namespace contains the following constants:


      ..  _OEChem_OEIFlavor_MMOD_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_MMOD_Default:


      .. oe:constant:: Default

         No special options are set. Formal charge assignment via
         :oe:func:`OEChem::OEAssignFormalCharges` is disabled.


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


   ..  _OEChem_OEIFlavor_MOL2:


   .. oe:constnamespace:: OEIFlavor::MOL2

      The :oe:constns:`OEChem::OEIFlavor::MOL2` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecular file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::MOL2` format file by
      the :oe:func:`OEChem::OEReadMol2File` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MOL2_M2H:


      .. oe:constant:: M2H

         Instructs the MOL2 file reader to treat the file as containing
         explicit hydrogen atoms. When set, the reader applies additional
         formal charge and resonance form corrections appropriate for
         structures with explicit hydrogens. This corresponds to the
         behavior of the :oe:const:`OEChem::OEFormat::MOL2H` format.

      ..  _OEChem_OEIFlavor_MOL2_Forcefield:

      .. oe:constant:: Forcefield

         This specifies a commonly used variant of MOL2, wherein the chemical element
         for an atom is inferred from the atom name, but not using the second
         character if it is capitalized. For example:

         - CA specifies carbon (not calcium)
         - Ca specifies calcium
         - NA specifies nitrogen (not sodium)
         - Na specifies sodium
         - HA specifies hydrogen (not hahnium)

         Exceptions were made for atom names beginning with FE, ZN, MG, MN,
         CL, and BR: these specify chemical elements Fe, Zn, Mg, Mn, Cl, and Br,
         respectively.

      ..  _OEChem_OEIFlavor_MOL2_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::MOL2::M2H` and
         :oe:const:`OEChem::OEIFlavor::MOL2::Forcefield` flags.

      ..  _OEChem_OEIFlavor_MOL2_Default:

      .. oe:constant:: DEFAULT

         No special options are set. Neither
         :oe:const:`OEChem::OEIFlavor::MOL2::M2H` nor
         :oe:const:`OEChem::OEIFlavor::MOL2::Forcefield` is enabled.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2::DEFAULT` constant.


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

   ..  _OEChem_OEIFlavor_MOL2H:


   .. oe:constnamespace:: OEIFlavor::MOL2H

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_MOL2H_M2H:

      .. oe:constant:: M2H

         Indicates that explicit hydrogen atoms are present in the file.
         When active, the reader applies formal charge and resonance form
         corrections appropriate for structures with explicit hydrogens.

      ..  _OEChem_OEIFlavor_MOL2H_AllMask:

      .. oe:constant:: AllMask

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2H::M2H` constant;
         the only flag in this namespace.

      ..  _OEChem_OEIFlavor_MOL2H_Default:

      .. oe:constant:: DEFAULT

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2H::M2H` constant.
         Explicit hydrogen treatment is always the default for
         :oe:const:`OEChem::OEFormat::MOL2H` format.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::MOL2H::DEFAULT` constant.


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

   .. oe:constnamespace: OEIFlavor::MOPAC IGNORED
      This namespace contains the following constants:
      .. oe:constant:: Default

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


   ..  _OEChem_OEIFlavor_OEB:

   .. oe:constnamespace:: OEIFlavor::OEB

      This namespace contains the following constants:

      .. oe:constant:: Default

         No special options are set.

   ..  _OEChem_OEIFlavor_OEZ:

   .. oe:constnamespace:: OEIFlavor::OEZ

      This namespace contains the following constants:

      .. oe:constant:: Default

         No special options are set.

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

   ..  _OEChem_OEIFlavor_PDB:

   .. oe:constnamespace:: OEIFlavor::PDB

      This namespace contains the following constants:


   ..  _OEChem_OEIFlavor_PDB_TER:

      .. oe:constant:: TER

         Controls whether the PDB file reader should separate consecutive molecules
         at `TER`_ records.
         :oe:const:`OEChem::OEIFlavor::PDB::TER` is off by default.

   ..  _OEChem_OEIFlavor_PDB_END:

      .. oe:constant:: END

         Controls whether the PDB file reader should separate consecutive molecules
         at `END`_  records.
         :oe:const:`OEChem::OEIFlavor::PDB::END` is on by default.


   ..  _OEChem_OEIFlavor_PDB_ENDM:

      .. oe:constant:: ENDM

         Controls whether the PDB file reader should separate consecutive molecules
         at `ENDM`_  records.

         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` is on by default.

     ..  _OEChem_OEIFlavor_PDB_TerMask:

     .. oe:constant:: TerMask

         Combination of :oe:const:`OEChem::OEIFlavor::PDB::TER` and
         :oe:const:`OEChem::OEIFlavor::PDB::END` and
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` flags.

         .. note::

            By default, only :oe:const:`OEChem::OEIFlavor::PDB::END` and
            :oe:const:`OEChem::OEIFlavor::PDB::ENDM` are on (and
            :oe:const:`OEChem::OEIFlavor::PDB::TER` is off), meaning that
            different chains are read into the a single molecule, but
            different NMR models and concatenated PDB files are treated as
            sequential molecules.

            If :oe:const:`OEChem::OEIFlavor::PDB::END`, :oe:const:`OEChem::OEIFlavor::PDB::ENDM`
            and :oe:const:`OEChem::OEIFlavor::PDB::TER` are all turned off, all of
            the  `ATOM`_ and `HETATM`_ records in a single PDB file will be read into a
            single :ref:`OEMolBase <OEChem_OEMolBase>`.


     ..  _OEChem_OEIFlavor_PDB_ALL:

      .. oe:constant:: ALL

         It used to indicate that all of the atom records in the input
         file should be read into the :ref:`OEMolBase <OEChem_OEMolBase>`. By
         default, the :oe:func:`OEChem::OEReadPDBFile` function
         ignores/omits `ATOM`_ and `HETATM`_ records that represent
         pseudo or dummy atoms and/or alternate conformations.  Without
         :oe:const:`OEChem::OEIFlavor::PDB::ALL`, the PDB file reader ignores
         all atoms whose alternate location indicator is other than ``'
         '``, ``A`` or ``1``, all atoms with atom names beginning ``"
         Q"``, all atoms with residue name ``"DUM"``, and all atoms with
         coordinates 9999.000, 9999.000, 9999.000 (as used by XPLOR/CNS
         to represent dummy atoms).


     ..  _OEChem_OEIFlavor_PDB_ALTLOC:

      .. oe:constant:: ALTLOC

         Combination of :oe:const:`OEChem::OEIFlavor::Generic::Default`,
         :oe:const:`OEChem::OEIFlavor::PDB::Default`, and
         :oe:const:`OEChem::OEIFlavor::PDB::ALL` flags.
         This flavor is required when :ref:`OEAltLocationFactory <OEBio_OEAltLocationFactory>`
         is to be used so that all the atoms with alternate location codes
         are retained.

     ..  _OEChem_OEIFlavor_PDB_DATA:

      .. oe:constant:: DATA

         Controls whether the PDB file reader preserves the PDB file's header data
         as OEMolBase's generic data.
         This option currently preserves the following records:

         * Title section: `AUTHOR`_,  `CAVEAT`_, `COMPND`_, `EXPDTA`_, `HEADER`_, `JRNL`_,  `KEYWDS`_,
           `OBSLTE`_,  `SOURCE`_, `SPRSDE`_,   `REMARK`_, `REVDAT`_,  `TITLE`_
         * Primary structure section: `DBREF`_, `MODRES`_, `SEQRES`_, `SEQADV`_
         * Heterogen section:   `FORMUL`_, `HET`_, `HETNAM`_, `HETSYM`_
         * Secondary structure section:  `HELIX`_, `SHEET`_, `TURN`_
         * Connectivity annotation section:  `SSBOND`_
         * Miscellaneous features section:  `SITE`_
         * Crystallographic and coordinate transformation section: `CRYST1`_, `MTRIX1`_, `MTRIX2`_,
           `MTRIX3`_, `ORIGX1`_, `ORIGX2`_, `ORIGX3`_, `SCALE1`_, `SCALE2`_, `SCALE3`_

         .. note::

            Modifying or reordering the molecule may invalidate the atom
            serial numbers used in some of the PDB records.

     ..  _OEChem_OEIFlavor_PDB_CHARGE:

      .. oe:constant:: CHARGE

         It is used to indicate that the contents of the b-factor column
         in the input PDB file contains a partial charge, and should be
         stored in the 'partial charge' property of an atom, instead of
         the 'b-factor' property.  This value can then be retrieved using
         the :oe:meth:`OEChem::OEAtomBase::GetPartialCharge` method.

     ..  _OEChem_OEIFlavor_PDB_RADIUS:

      .. oe:constant:: RADIUS

         It is used to indicate that the contents of the occupancy column in
         the input PDB file contains a radius, and should be stored in
         the 'radius' property of an atom instead of the 'occupancy'
         property.  This value can then be retrieved using the
         :oe:meth:`OEChem::OEAtomBase::GetRadius` method.

     ..  _OEChem_OEIFlavor_PDB_DELPHI:

      .. oe:constant:: DELPHI

         Combinations of :oe:const:`OEChem::OEIFlavor::PDB::CHARGE` and
         :oe:const:`OEChem::OEIFlavor::PDB::RADIUS` flags.

     ..  _OEChem_OEIFlavor_PDB_FORMALCHARGE:

      .. oe:constant:: FORMALCHARGE

         Controls whether the PDB reader should read the formal charge
         of the atom from column 79 and 80. Note, this flavor is not
         turned on default because the subsequent perception steps
         would not take this formal charge into account when filling
         valences with bonds and hydrogens.

     ..  _OEChem_OEIFlavor_PDB_SecStruct:

      .. oe:constant:: SecStruct

         This controls whether protein secondary structure is perceived after
         a file is read in.  It is on by default.  If this flavor is off, secondary
         structure information specified in the input PDB file (through SHEET and
         HELIX records) is retained.

     ..  _OEChem_OEIFlavor_PDB_BasicMask:

      .. oe:constant:: BasicMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::TER`,
         :oe:const:`OEChem::OEIFlavor::PDB::END`,
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM`,
         :oe:const:`OEChem::OEIFlavor::PDB::ALL`,
         :oe:const:`OEChem::OEIFlavor::PDB::DATA`,
         :oe:const:`OEChem::OEIFlavor::PDB::CHARGE`,
         :oe:const:`OEChem::OEIFlavor::PDB::RADIUS` and
         :oe:const:`OEChem::OEIFlavor::PDB::FORMALCHARGE` flags.
         These are the flags honored by the low-level
         :oe:func:`OEChem::OEReadPDBFile` reader.

     ..  _OEChem_OEIFlavor_PDB_FormalCrg:

      .. oe:constant:: FormalCrg

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_ImplicitH:


      .. oe:constant:: ImplicitH

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_BondOrder:


      .. oe:constant:: BondOrder

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_Rings:


      .. oe:constant:: Rings

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_Connect:


      .. oe:constant:: Connect

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_ExtraMask:

      .. oe:constant:: ExtraMask

         .. note::

            This flag is only relevant in the high-level file reader
            (:oe:func:`OEChem::OEReadMolecule`) and not in :oe:func:`OEChem::OEReadPDBFile`.

     ..  _OEChem_OEIFlavor_PDB_AllMask:

      .. oe:constant:: AllMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::BasicMask` and
         :oe:const:`OEChem::OEIFlavor::PDB::ExtraMask` flags.

     ..  _OEChem_OEIFlavor_PDB_Default:

      .. oe:constant:: DEFAULT

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::Connect`,
         :oe:const:`OEChem::OEIFlavor::PDB::Rings`,
         :oe:const:`OEChem::OEIFlavor::PDB::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::PDB::ImplicitH`,
         :oe:const:`OEChem::OEIFlavor::PDB::FormalCrg`,
         :oe:const:`OEChem::OEIFlavor::PDB::ENDM` and
         :oe:const:`OEChem::OEIFlavor::PDB::END` 
         :oe:const:`OEChem::OEIFlavor::PDB::DATA`, flags.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::PDB::DEFAULT` constant.

     ..  _OEChem_OEIFlavor_PDB_SpruceDefault:

      .. oe:constant:: SpruceDefault

         Combination of
         :oe:const:`OEChem::OEIFlavor::PDB::DEFAULT`,
         :oe:const:`OEChem::OEIFlavor::PDB::ALTLOC`, flags.
 
   .. ################################################################
      #
      ################################################################


   ..  _OEChem_OEIFlavor_RDF:


   .. oe:constnamespace:: OEIFlavor::RDF

      The :oe:constns:`OEChem::OEIFlavor::RDF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::RDF` format file by
      the :oe:func:`OEChem::OEReadMDLFile` low-level file reader.

      ..  _OEChem_OEIFlavor_RDF_Default:

      .. oe:constant:: Default

         No special options are set. The
         :oe:const:`OEChem::OEIFlavor::RDF::FixBondMarks`,
         :oe:const:`OEChem::OEIFlavor::RDF::SuppressEmptyMolSkip`,
         :oe:const:`OEChem::OEIFlavor::RDF::SuppressImp2ExpENHSTE`, and
         :oe:const:`OEChem::OEIFlavor::RDF::ForceImp2ExpENHSTE` flags
         are all disabled.

      ..  _OEChem_OEIFlavor_RDF_FixBondMarks:

      .. oe:constant:: FixBondMarks

      This input flavor requests that the reader make an attempt
      to repair stereocenters that throw warnings due to issues identified
      by :oe:func:`OEChem::OEMDLStereoFromBondStereo`.  With this input flavor
      enabled, the warnings will continue to be issued to allow user inspection and verification
      of the modified bond marks.  However, once the corrected structure(s) have been rewritten
      with any format that captures bond stereomark information, a re-read of the structure(s)
      should emit fewer stereocenter correction warnings. This input flavor is not
      enabled for the default :oe:const:`OEChem::OEFormat::RDF` setting.


      ..  _OEChem_OEIFlavor_RDF_SuppressEmptyMolSkip:

      .. oe:constant:: SuppressEmptyMolSkip

      This input flavor suppresses the default action of skipping empty molecules
      in the input stream. This may be important in order to recover SDData stored on empty molecule records.

      ..  _OEChem_OEIFlavor_RDF_SuppressImp2ExpENHSTE:

      .. oe:constant:: SuppressImp2ExpENHSTE

      This input flavor suppresses any enhanced stereogroup implicit to explicit
      conversions for an input V3000 format RDFile.

      ..  _OEChem_OEIFlavor_RDF_ForceImp2ExpENHSTE:

      .. oe:constant:: ForceImp2ExpENHSTE

      This input flavor performs implicit to explicit enhanced stereogroup
      conversions for an input RDFile.

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

   ..  _OEChem_OEIFlavor_SDF:

   .. oe:constnamespace:: OEIFlavor::SDF

      The :oe:constns:`OEChem::OEIFlavor::SDF` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::SDF` format file by
      the :oe:func:`OEChem::OEReadMDLFile` low-level file reader.

      This namespace contains the following constants:


      ..  _OEChem_OEIFlavor_SDF_Default:

      .. oe:constant:: Default

         No special options are set. The
         :oe:const:`OEChem::OEIFlavor::SDF::FixBondMarks`,
         :oe:const:`OEChem::OEIFlavor::SDF::SuppressEmptyMolSkip`,
         :oe:const:`OEChem::OEIFlavor::SDF::SuppressImp2ExpENHSTE`, and
         :oe:const:`OEChem::OEIFlavor::SDF::ForceImp2ExpENHSTE` flags
         are all disabled.


      ..  _OEChem_OEIFlavor_SDF_FixBondMarks:

      .. oe:constant:: FixBondMarks

      This input flavor requests that the reader make an attempt
      to repair stereocenters that throw warnings due to issues identified
      by :oe:func:`OEChem::OEMDLStereoFromBondStereo`.  With this input flavor
      enabled, the warnings will continue to be issued to allow user inspection and verification
      of the modified bond marks.  However, once the corrected structure(s) have been rewritten
      with any format that captures bond stereomark information, a re-read of the structure(s)
      should emit fewer stereocenter correction warnings. This input flavor is not
      enabled for the default :oe:const:`OEChem::OEFormat::SDF` setting.

      ..  _OEChem_OEIFlavor_SDF_SuppressEmptyMolSkip:

      .. oe:constant:: SuppressEmptyMolSkip

      This input flavor suppresses the default action of skipping empty molecules
      in the input stream. This may be important in order to recover SDData stored on empty molecule records.

      ..  _OEChem_OEIFlavor_SDF_SuppressImp2ExpENHSTE:

      .. oe:constant:: SuppressImp2ExpENHSTE

      This input flavor suppresses any enhanced stereogroup implicit to explicit
      conversions for an input V3000 format SDFile.


      ..  _OEChem_OEIFlavor_SDF_ForceImp2ExpENHSTE:

      .. oe:constant:: ForceImp2ExpENHSTE

      This input flavor performs implicit to explicit enhanced stereogroup
      conversions for an input V2000 or V3000 format SDFile.

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

   ..  _OEChem_OEIFlavor_SKC:

   .. oe:constnamespace:: OEIFlavor::SKC

      The :oe:constns:`OEChem::OEIFlavor::SKC` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::SKC` format file by
      the :oe:func:`OEChem::OEReadSketchFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_SKC_Default:

      .. oe:constant:: Default

         No special options are set.


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

   .. oe:constnamespace: OEIFlavor::SLN  IGNORED
      This namespace contains the following constants:
      .. oe:constant:: Default


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


   ..  _OEChem_OEIFlavor_SMI:

   .. oe:constnamespace:: OEIFlavor::SMI

      The :oe:constns:`OEChem::OEIFlavor::SMI` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_SMI_Strict:

      .. oe:constant:: Strict

         Enables strict parsing mode when processing :term:`SMILES`
         strings. The parser applies more rigorous sanity checking,
         rejecting malformed strings that the non-strict parser would
         accept. For example, ``C==C`` is accepted by default but
         rejected in strict mode.


      ..  _OEChem_OEIFlavor_SMI_Canon:

      .. oe:constant:: Canon

         When set, the parser assumes the :term:`SMILES` string is
         well-formed and omits the usual kekulization step performed by
         :oe:func:`OEChem::OEKekulize`. This can speed up parsing of
         large databases, but bond orders may not be correctly assigned
         for aromatic molecules.

      ..  _OEChem_OEIFlavor_SMI_Default:

      .. oe:constant:: DEFAULT

         No special options are set. Both
         :oe:const:`OEChem::OEIFlavor::SMI::Strict` and
         :oe:const:`OEChem::OEIFlavor::SMI::Canon` flags are disabled.

      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::SMI::DEFAULT` constant.


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


   ..  _OEChem_OEIFlavor_USM:


   .. oe:constnamespace:: OEIFlavor::USM

      The :oe:constns:`OEChem::OEIFlavor::USM` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the :oe:func:`OEChem::OEParseSmiles` function.

      This namespace contains constants.


      ..  _OEChem_OEIFlavor_USM_Default:

      .. oe:constant:: Default

         No special options are set.


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

   ..  _OEChem_OEIFlavor_XYZ:


   .. oe:constnamespace:: OEIFlavor::XYZ

      The :oe:constns:`OEChem::OEIFlavor::XYZ` namespace encodes symbolic
      constants used as bit-masks that control the processing
      performed by the high-level molecule file reader
      :oe:func:`OEChem::OEReadMolecule` after reading
      :oe:const:`OEChem::OEFormat::XYZ` format file by
      the :oe:func:`OEChem::OEReadXYZFile` low-level file reader.

      This namespace contains the following constants:

      ..  _OEChem_OEIFlavor_XYZ_FormalCrg:

      .. oe:constant:: FormalCrg

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignFormalCharges` function to
         assign formal charges.

      ..  _OEChem_OEIFlavor_XYZ_ImplicitH:


      .. oe:constant:: ImplicitH

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEAssignImplicitHydrogens` function to
         assign implicit hydrogens.

      ..  _OEChem_OEIFlavor_XYZ_BondOrder:

      .. oe:constant:: BondOrder

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEPerceiveBondOrders` function to
         perceive bond orders.

      ..  _OEChem_OEIFlavor_XYZ_Rings:


      .. oe:constant:: Rings

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function to
         determine ring structure.

      ..  _OEChem_OEIFlavor_XYZ_Connect:


      .. oe:constant:: Connect

         This flag indicates that high-level molecular file reader calls
         the :oe:func:`OEChem::OEDetermineConnectivity` function to
         perceive bond connectivity from atomic coordinates. Since
         :oe:const:`OEChem::OEFormat::XYZ` files contain only atomic
         positions without explicit bond information, this flag is
         required to establish bonding.

      ..  _OEChem_OEIFlavor_XYZ_ExtraMask:


      .. oe:constant:: ExtraMask

         Combination of
         :oe:const:`OEChem::OEIFlavor::XYZ::Connect`,
         :oe:const:`OEChem::OEIFlavor::XYZ::Rings`,
         :oe:const:`OEChem::OEIFlavor::XYZ::BondOrder`,
         :oe:const:`OEChem::OEIFlavor::XYZ::ImplicitH` and
         :oe:const:`OEChem::OEIFlavor::XYZ::FormalCrg` flags.

      ..  _OEChem_OEIFlavor_XYZ_Default:


      .. oe:constant:: Default

         Same as the :oe:const:`OEChem::OEIFlavor::XYZ::ExtraMask` constant.
