.. oe:namespace:: OEBio


.. oe:constnamespace:: OEMolComplexFilterCategory

   This namespace contains constants used as parameters to
   :oe:func:`OEBio::OEMolComplexRoleFactory`,
   :oe:func:`OEBio::OEGetMolComplexFilterCategoryName`,
   :oe:func:`OEBio::OEMolComplexFilterFactory`, and
   :oe:meth:`OEBio::OESplitMolComplexOptions::ResetFilters`.
   These constants refer to functional roles that may be associated
   with a component by :oe:func:`OEBio::OESplitMolComplex` or
   :oe:func:`OEBio::OEGetMolComplexComponents` and are
   used to construct filters (see :ref:`OEMolComplexFilter <OEBio_OEMolComplexFilter>`)
   that select a desired subset of components. The class
   :ref:`OESplitMolComplexOptions <OEBio_OESplitMolComplexOptions>` manages several of
   these filters; others can be generated as required.


   .. oe:constant:: Anything

      Match anything.


   .. oe:constant:: ChainA

      Match any component in chain 'A'.

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexChainRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.


   .. oe:constant:: Cofactor

      Match any component identified as a cofactor.


   .. oe:constant:: CofactorAndLigand

      Match any component in a special category for items
      that are either a cofactor or a ligand if no ligand is otherwise found.


   .. oe:constant:: CounterIon

      Match any counter-ion (either a first-row metal or an halogen).


   .. oe:constant:: Covalent

      Match any component identified as a covalent ligand.


   .. oe:constant:: DNA_RNA

      Match any DNA or RNA molecule.


   .. oe:constant:: Ligand

      Match any ligand.


   .. oe:constant:: Lipid

      Match any lipids.


   .. oe:constant:: Metal

      Match any metal.


   .. oe:constant:: Misc

      Component has been identified as miscellaneous.
      These are otherwise unclassified compounds that
      are not to be considered ligands
      (for example buffers and excipients).


   .. oe:constant:: Model1

      Match any component in model number 1
      (the default if model information is not explicitly specified).

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexModelRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.


   .. oe:constant:: Nothing

      Match nothing.


   .. oe:constant:: Nucleotide

      Match any nucleotide.


   .. oe:constant:: Peptide

      Match any poly-peptide.


   .. oe:constant:: ProtComplex

      Match any component identified as being part of the protein complex (protein + cofactor).


   .. oe:constant:: Protein

      Match any protein chain.


   .. oe:constant:: Saccharide

      Match any component identified as a sugar.


   .. oe:constant:: Site1

      Match any component identified as being part of binding site 1.


      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexSiteRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.

   .. oe:constant:: Solution

      Match any component identified as being part of the solution (water + counter-ion).


   .. oe:constant:: SurfaceWaters1

      Match any surface waters identified as being part of binding site 1.

      Filters for other chains may be build by combining
      :oe:func:`OEBio::OEMolComplexSurfaceWatersRoleFactory`
      with :oe:func:`OEBio::OERoleMolComplexFilterFactory`.


   .. oe:constant:: Underdefined

      Match any component containing a dummy atom (:oe:const:`OEChem::OEElemNo::Du`).


   .. oe:constant:: Unknown

      Match any component that would have been identified as a ligand but has a
      residue name that differs from that explicitly specified.


   .. oe:constant:: Water

      Match any water molecule.

