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

.. oe:namespace:: OEBio

..  _OEBio_OEDesignUnitComponents:

.. oe:constnamespace:: OEDesignUnitComponents

   .. attention::

      |TWOLANGUAGE|

   This namespace contains constants representing the various
   molecular types that can be stored within an :ref:`OEDesignUnit <OEBio_OEDesignUnit>`, see :ref:`Storage Components<bio_du_components_storage>`.

   The namespace also lists some combined constants for convenient use in various general applications, 
   for example `TargetComplex`, see :ref:`Combined Components<bio_du_components_combined>`

   .. note:: When using these in command-line applications, the two word names in storage components below 
      need to have an underscore (`_`) between the words, e.g. `OtherNucleics` should
      be `other_nucleics`. When relevant these are noted below.


   .. _bio_du_components_combined:

Combined constants
==================

   .. oe:constant:: All

      All components.

   .. _OEBio_TargetComplex:

   .. oe:constant:: TargetComplex

      This is bit mask that combines the following, and is often used in modeling application
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Solvent`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::CounterIons`,
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherLigands`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherCofactors`

   .. _OEBio_TargetComplexNoSolvent:

   .. oe:constant:: TargetComplexNoSolvent

      This is bit mask that combines the following, and is often used in modeling application
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherLigands`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherCofactors`

   .. oe:constant:: Default

      This is bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Ligand`,
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Solvent`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::CounterIons`, and
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`.


   .. oe:constant:: ListComponents

      This is a bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Cofactors`,
      :oe:const:`OEBio::OEDesignUnitComponents::Excipients`,
      :oe:const:`OEBio::OEDesignUnitComponents::Sugars`,
      :oe:const:`OEBio::OEDesignUnitComponents::Polymers`,
      :oe:const:`OEBio::OEDesignUnitComponents::PostTranslational`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherLigands`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherCofactors`.

   .. oe:constant:: MacroMolComponents

      This is bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::OtherProteins`, and
      :oe:const:`OEBio::OEDesignUnitComponents::OtherNucleics`

   .. oe:constant:: MolComponents

      This is bit mask that combines
      :oe:const:`OEBio::OEDesignUnitComponents::Protein`,
      :oe:const:`OEBio::OEDesignUnitComponents::Nucleic`,
      :oe:const:`OEBio::OEDesignUnitComponents::Ligand`,
      :oe:const:`OEBio::OEDesignUnitComponents::Solvent`,
      :oe:const:`OEBio::OEDesignUnitComponents::Metals`,
      :oe:const:`OEBio::OEDesignUnitComponents::CounterIons`,
      :oe:const:`OEBio::OEDesignUnitComponents::Lipids`,
      :oe:const:`OEBio::OEDesignUnitComponents::PackingResidues`, and
      :oe:const:`OEBio::OEDesignUnitComponents::Undefined`

   .. _bio_du_components_storage:

Storage constants
==================

   .. oe:constant:: Cofactors

      Cofactors (*i.e.* any heterogen molecule) within a short distance to the active site.

   .. oe:constant:: CounterIons

      All counter ions.

      In command line use, please use `counter_ions`

   .. oe:constant:: Excipients

      All excipient molecules.

   .. oe:constant:: Ligand

      The ligand.

   .. oe:constant:: Lipids

      All lipid molecules.

   .. oe:constant:: Metals

      All system metals that are not cofactors.

   .. oe:constant:: Nucleic

      All nucleic acid molecules.

   .. oe:constant:: OtherCofactors

      Any non-primary cofactors.

      In command line use, please use `other_cofactors`

   .. oe:constant:: OtherLigands

      Any non-primary ligands (*i.e.* ligands not in the active site).

      In command line use, please use `other_ligands`

   .. oe:constant:: OtherNucleics

      Any non-primary nucleic acids.

      In command line use, please use `other_nucleics`

   .. oe:constant:: OtherProteins

      Any non-primary proteins.

      In command line use, please use `other_proteins`

   .. oe:constant:: PackingResidues

      All packing residue molecules.

      In command line use, please use `packing_residues`

   .. oe:constant:: Polymers

      All polymers, excluding typical biological polymers like DNA and proteins.

   .. oe:constant:: PostTranslational

      All components resulting from post-translation modifications (PTMs) that
      are not sugars or lipids.

      In command line use, please use `post_translational`

   .. oe:constant:: Protein

      The primary protein molecule.

   .. oe:constant:: Solvent

      All solvent molecules.

   .. oe:constant:: Sugars

      All sugar molecules.

   .. oe:constant:: Undefined

      Molecules that cannot be categorized by :oe:func:`OEBio::OEGetDesignUnitComponentID` are Undefined,
      an example would be residues specifically marked with residue name **UNK**.

   .. oe:constant:: Unknown

      Molecules cannot be stored using this constant. The constant exists to indicate invalid use of IDs
      or string versions of the namespace.