.. include:: ../substitutions

.. oe:namespace:: OEBio

.. meta::
   :keywords: OEIsStandardProteinResidue

.. oe:function:: OEIsStandardProteinResidue

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

      .. oe:api::

         bool OEIsStandardProteinResidue(const OEHierResidue& res)
         bool OEIsStandardProteinResidue(const OEChem::OEResidue& res)
         bool OEIsStandardProteinResidue(unsigned int resIdx)
         bool OEIsStandardProteinResidue(const OEChem::OEAtomBase& atom)
         bool OEIsStandardProteinResidue(const OESystem::OEIter<OEHierResidue>& hit)

   .. oe:language:: python

      .. oe:api:: python

         OEIsStandardProteinResidue(res: OEResidue) -> bool
         OEIsStandardProteinResidue(resIdx: int) -> bool
         OEIsStandardProteinResidue(atom: OEAtomBase) -> bool
         OEIsStandardProteinResidue(hit: OEHierResidueIter) -> bool

   Returns whether the residue referred to is one of:
   ALA, ARG, ASN, ASP, CYS, GLN, GLU, GLY,
   HIS, ILE, LEU, LYS, MET, PHE, PRO, SER, THR, TRP, TYR, VAL, ASX,
   GLX, CYX, CYH, HID, HIE or HIP. Residue indices are provided by
   :oe:func:`OEChem::OEGetResidueIndex`.


   .. seealso::

      * :ref:`OEIsStandardAminoAcid <OEBio_OEIsStandardAminoAcid>` class for use as a predicate
