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

.. oe:namespace:: OEChem

.. meta::
   :keywords: OEAtomBase
   :keywords: AtomBase

.. _OEChem_OEAtomBase:

.. oe:class:: OEAtomBase

   .. oe:api::

      class OEAtomBase : public OESystem::OEBase

   The :ref:`OEAtomBase <OEChem_OEAtomBase>` class is the abstract interface for
   representing atoms within **OpenEye's Toolkits**. An :ref:`OEAtomBase <OEChem_OEAtomBase>`
   object is created by calling the :oe:cls:`OEChem::OEMolBase::NewAtom` method
   on the parent molecule.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================


   The following classes derive from this class:
    * :ref:`OEQAtomBase <OEChem_OEQAtomBase>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEAtomBase& operator=(const OEAtomBase& a)


   .. _OEChem_OEAtomBase_AddBond:

      Assignment operator.


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

      .. oe:api::

         bool AddBond(const OEBondBase *)=0

   .. _OEChem_OEAtomBase_Clear:


   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None


   .. _OEChem_OEAtomBase_GetAtomicNum:


   .. oe:method:: GetAtomicNum

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

         .. oe:api::

            unsigned int GetAtomicNum() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicNum() -> int

      Returns the 'atomic number' property of the atom.  
      A value of zero is returned for wildcard atoms, such as MDL super atoms.  
      An atomic number is specified as the argument to :oe:meth:`OEChem::OEMolBase::NewAtom` 
      and may be changed using :oe:meth:`OEChem::OEAtomBase::SetAtomicNum`.  
      The set of valid values for this property are defined by the 
      :oe:constns:`OEChem::OEElemNo` namespace.


   .. _OEChem_OEAtomBase_GetAtoms:


   .. oe:method:: GetAtoms

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

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms() -> OEAtomIter

      Returns an iterator over the neighboring atoms of this atom.
      The returned iterator traverses
      only the explicit atoms that are bonded to the
      :ref:`OEAtomBase <OEChem_OEAtomBase>`. The number of neighbors in the
      iterator is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

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

         .. oe:api::

            OESystem::OEIterBase<OEAtomBase>* GetAtoms(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetAtoms(arg2: OEUnaryAtomPred) -> OEAtomIter

      Returns an iterator over the neighboring atoms of the :ref:`OEAtomBase <OEChem_OEAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)


   .. _OEChem_OEAtomBase_GetAxial:


   .. oe:method:: GetAxial

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

         .. oe:api::

            bool GetAxial(const OEBondBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetAxial(arg2: OEBondBase) -> bool

      .. warning::

         |DEPRECATED-API|


   .. _OEChem_OEAtomBase_GetBond:


   .. oe:method:: GetBond

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

         .. oe:api::

            OEBondBase* GetBond(const OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            GetBond(arg2: OEAtomBase) -> OEBondBase

      Returns a :ref:`OEBondBase <OEChem_OEBondBase>` pointer that connecting
      the :ref:`OEAtomBase <OEChem_OEAtomBase>` to the atom specified in the
      method argument. If the :ref:`OEAtomBase <OEChem_OEAtomBase>` is not
      connected to the specified atom, a NULL pointer
      (:oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`)0 is returned.

   .. _OEChem_OEAtomBase_GetBonds:


   .. oe:method:: GetBonds

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

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds() -> OEBondIter

      Returns an iterator over the bonds connected to the atom.
      The returned iterator traverses only the explicit bonds that are
      attached to the :ref:`OEAtomBase <OEChem_OEAtomBase>`. The number of bonds
      in the iterator is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree`.

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

         .. oe:api::

            OESystem::OEIterBase<OEBondBase>* GetBonds(const OESystem::OEUnaryPredicate<OEChem::OEBondBase> &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBonds(arg2: OEUnaryBondPred) -> OEBondIter

      Returns an iterator over the bonds of the :ref:`OEAtomBase <OEChem_OEAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)

   .. _OEChem_OEAtomBase_GetDegree:


   .. oe:method:: GetDegree

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

         .. oe:api::

            unsigned int GetDegree() const

      .. oe:language:: python

         .. oe:api:: python

            GetDegree() -> int

      Returns the total number of neighbor atoms bonded to an atom, or
      equivalently the total number of bonds connected to an
      atom. This value includes bonds to implicit hydrogen atoms. This
      value is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitDegree()<OEChem::OEAtomBase::GetExplicitDegree>` +
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount()<OEChem::OEAtomBase::GetImplicitHCount>`, 
      and is also identical to 
      :oe:meth:`OEChem::OEAtomBase::GetHvyDegree()<OEChem::OEAtomBase::GetHvyDegree>` +
      :oe:meth:`OEChem::OEAtomBase::GetTotalHCount()<OEChem::OEAtomBase::GetTotalHCount>`.


   .. _OEChem_OEAtomBase_GetExplicitDegree:


   .. oe:method:: GetExplicitDegree

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

         .. oe:api::

            unsigned int GetExplicitDegree() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitDegree() -> int

      Returns the number of explicit neighbor atoms bonded to an
      atom. This value does not include bonds to implicit hydrogen
      atoms.

   .. _OEChem_OEAtomBase_GetExplicitHCount:


   .. oe:method:: GetExplicitHCount

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

         .. oe:api::

            unsigned int GetExplicitHCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitHCount() -> int

      Returns the number of explicit hydrogen neighbors bonded to an
      atom.

   .. _OEChem_OEAtomBase_GetExplicitValence:

   .. oe:method:: GetExplicitValence

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

         .. oe:api::

            unsigned int GetExplicitValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetExplicitValence() -> int

      Returns the sum of the bond orders of explicit bonds connected
      to an atom.

   .. _OEChem_OEAtomBase_GetFormalCharge:


   .. oe:method:: GetFormalCharge

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

         .. oe:api::

            int GetFormalCharge() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetFormalCharge() -> int

      Returns the 'formal charge' property of  an atom. The default value is
      zero. The 'formal charge' property may be set using the
      :ref:`SetFormalCharge <OEChem_OEAtomBase_SetFormalCharge>` method. Formal
      charges may also be set on a molecule using the
      :ref:`OEAssignFormalCharges <OEChem_OEAssignFormalCharges>` function that infers
      reasonable formal charges using the atomic number, and implicit
      hydrogen count for each atom.

   .. _OEChem_OEAtomBase_GetHvyDegree:

   .. oe:method:: GetHvyDegree

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

         .. oe:api::

            unsigned int GetHvyDegree() const

      .. oe:language:: python

         .. oe:api:: python

            GetHvyDegree() -> int

      Returns the number of non-hydrogen neighbors of an atom.

   .. _OEChem_OEAtomBase_GetHvyValence:


   .. oe:method:: GetHvyValence

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

         .. oe:api::

            unsigned int GetHvyValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetHvyValence() -> int

      Returns the sum of bond orders of bonds to non-hydrogen atoms.

   .. _OEChem_OEAtomBase_GetHyb:

   .. oe:method:: GetHyb

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

         .. oe:api::

            unsigned int GetHyb() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetHyb() -> int

      Returns the 'hybridization' property of an atom.  
      The set of valid  values for this property are defined in the
      :oe:constns:`OEChem::OEHybridization` namespace.  
      The default value is zero, (:oe:const:`OEChem::OEHybridization::Unknown`).  
      The 'hybridization' property can be set with the
      :oe:meth:`OEChem::OEAtomBase::SetHyb` method.

   .. _OEChem_OEAtomBase_GetIdx:


   .. oe:method:: GetIdx

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

         .. oe:api::

            unsigned int GetIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the atom index of an atom. This value is assigned
      when an atom is created. The atom index is unique for
      the atoms of a given molecule, and is stable (not reused) for
      the lifetime of that :ref:`OEMolBase <OEChem_OEMolBase>`. These values
      may not be assigned sequentially, and may contain gaps. Atom
      indices are guaranteed to be less than
      :oe:meth:`OEChem::OEMolBase::GetMaxAtomIdx`. Atom indices are
      typically only used for efficiently storing data in arrays (or
      vectors) externally to the :ref:`OEMolBase <OEChem_OEMolBase>`. They
      arrays can be conveniently indexed via
      :oe:meth:`OEChem::OEAtomBase::GetIdx`. For iterating across the
      atoms of a molecule, use :oe:meth:`OEChem::OEMolBase::GetAtoms`
      and for keeping track of a particular atom use an 
      :oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`.

      .. seealso::
 
         * :ref:`chapter_atombondindices` chapter

   .. _OEChem_OEAtomBase_GetImplicitHCount:


   .. oe:method:: GetImplicitHCount

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

         .. oe:api::

            unsigned int GetImplicitHCount() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetImplicitHCount() -> int

      Returns the 'implicit hydrogen count' property of an atom. The
      default value is zero. The 'implicit hydrogen count' property
      may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetImplicitHCount` method. Implicit
      hydrogen counts may also be set on a molecule using the
      :oe:func:`OEChem::OEAssignImplicitHydrogens` function. The 'implicit
      hydrogen count' property of an atom is a stored, not a computed,
      property. To calculate a reasonable implicit hydrogen count for
      an atom from connectivity, use the 
      :oe:func:`OEChem::OEDefaultImplicitHCount` function.

      To convert explicit hydrogens to implicit hydrogens, use the
      :oe:func:`OEChem::OESuppressHydrogens` function, and to
      convert implicit hydrogens to explicit hydrogens, use the
      :oe:func:`OEChem::OEAddExplicitHydrogens` function.

   .. _OEChem_OEAtomBase_GetIntType:

   .. oe:method:: GetIntType

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

         .. oe:api::

            int GetIntType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIntType() -> int

      Returns the 'integer atom type' of an atom. The default value is
      zero. The 'integer atom type' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetIntType` method.

   .. _OEChem_OEAtomBase_GetIsotope:


   .. oe:method:: GetIsotope

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

         .. oe:api::

            unsigned int GetIsotope() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetIsotope() -> int

      Returns the 'isotopic mass' property of an atom.  
      The default value is zero, meaning that the atom isn't a specific single isotope, but a
      composition of isotopes in their naturally occurring abundances.   
      A non-zero value indicates that the atom is a specific isotope.  
      The 'isotopic mass' property may be set using the :oe:meth:`OEChem::OEAtomBase::SetIsotope`
      method.

   .. _OEChem_OEAtomBase_GetMapIdx:


   .. oe:method:: GetMapIdx

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

         .. oe:api::

            unsigned int GetMapIdx() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetMapIdx() -> int

      Returns the 'reaction map index' of property of an atom. This integer value
      is used for tracking equivalent atom positions in a reaction
      molecule/transform. The default value is zero, meaning that the
      atom isn't mapped in the reaction.
      This property is also used to store 'R-group' indices, for example when
      parsing the :term:`SMILES` string ``CCC[R1]``.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBase::SetMapIdx` method
         * :ref:`OEIsRGroup <OEChem_OEIsRGroup>`  predicate

   .. _OEChem_OEAtomBase_GetName:


   .. oe:method:: GetName

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

         .. oe:api::

            const char* GetName() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetName() -> str

      Returns the 'atom name' property of an atom. This property is
      typically used when reading or writing molecular file
      formats. For example in PDB files, the atom name `` CA `` is
      used to denote that the atom is a peptide alpha carbon. The
      default value is the empty string. The 'atom name' property may
      be set using the :oe:meth:`OEChem::OEAtomBase::SetName` method.

   .. _OEChem_OEAtomBase_GetParent:


   .. oe:method:: GetParent

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

         .. oe:api::

            OEMolBase* GetParent() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParent() -> OEGraphMol

      Returns the parent molecule (:ref:`OEMolBase <OEChem_OEMolBase>`) of an
      atom. All :oe:cls:`OEChem::OEAtomBases<OEChem::OEAtomBase>` are
      created as a component of an :ref:`OEMolBase <OEChem_OEMolBase>`, this
      method can be used to determine the molecule of which an atom is
      part. The 'parent molecule' property of an atom cannot be
      assigned, as its determined at the point the atom is created.

   .. _OEChem_OEAtomBase_GetPartialCharge:


   .. oe:method:: GetPartialCharge

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

         .. oe:api::

            double GetPartialCharge() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetPartialCharge() -> float

      Returns the 'partial charge' property of an atom. The default value is
      ``0.0``. The 'partial charge' property on an atom may be set
      using the :oe:meth:`OEChem::OEAtomBase::SetPartialCharge`
      method. The 'partial charge' property is a stored, not a
      calculated, property. The 
      :oe:func:`OEChem::OEClearPartialCharges` function resets the partial
      charges on a molecule to zero, and the
      :oe:func:`OEChem::OEFormalPartialCharges` function sets the partial charge
      on each atom equal to its formal charge.

   .. _OEChem_OEAtomBase_GetRadius:


   .. oe:method:: GetRadius

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

         .. oe:api::

            double GetRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadius() -> float

      Returns the 'radius' property of an atom.  
      The default value is 0.0.  
      The 'radius' property on an atom may be set using the 
      :oe:meth:`OEChem::OEAtomBase::SetRadius` method.  
      The 'radius' property is typically used to hold a Van der Waal's or ionic 
      radius for a given atom when passing an :ref:`OEMolBase <OEChem_OEMolBase>` to an algorithm
      requiring some form of radii, such as a surface area calculation.

   .. _OEChem_OEAtomBase_GetRxnRole:


   .. oe:method:: GetRxnRole

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

         .. oe:api::

            unsigned int GetRxnRole() const

      .. oe:language:: python

         .. oe:api:: python

            GetRxnRole() -> int

      Returns the 'reaction role' property of an atom in a reaction
      molecule/transform. The set of valid  values for this
      property are defined in the namespace
      :oe:constns:`OEChem::OERxnRole`. The default value is zero,
      :oe:const:`OEChem::OERxnRole::None`, which means that the atom
      does have a role, *i.e.* is part of a normal molecule. Other
      values include :oe:const:`OEChem::OERxnRole::Reactant`,
      :oe:const:`OEChem::OERxnRole::Agent` and
      :oe:const:`OEChem::OERxnRole::Product` which correspond to
      reactant, agent and product atoms, respectively, in a reaction or
      transform. The 'reaction role' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetRxnRole` method.

   .. _OEChem_OEAtomBase_GetStereo:


   .. oe:method:: GetStereo

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

         .. oe:api::

            unsigned int GetStereo(const std::vector<OEAtomBase *>& neighs,
                                   unsigned int stereoclass) const

      .. oe:language:: python

         .. oe:api:: python

            GetStereo(arg2: OEAtomVector, arg3: int) -> int

      Returns the stereochemistry annotation of the atom.

      *neighs*
         A vector of neighboring atoms and a specific stereochemistry
         class and returns whether that stereochemistry is specified at
         this atom, and if so, what that specified value is.

      *stereoclass*
         **OEChem TK** currently only supports the tetrahedral atom stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEAtomStereo::Tetra`.

      This method returns the value :oe:const:`OEChem::OEAtomStereo::Undefined`
      if the stereo chemistry for the given stereochemistry class is unspecified, if
      the stereo chemistry class is invalid or if the vector of
      neighboring atoms is invalid.

      For a specified tetrahedral stereo center, it returns either
      :oe:const:`OEChem::OEAtomStereo::Left` or
      :oe:const:`OEChem::OEAtomStereo::Right`.

      The stereochemistry annotation of an atom may be set
      using the :oe:meth:`OEChem::OEAtomBase::SetStereo` method.

      .. seealso::

         * :term:`stereo atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::IsChiral` 
         * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` 


   .. _OEChem_OEAtomBase_GetSymmetryClass:


   .. oe:method:: GetSymmetryClass

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

         .. oe:api::

            unsigned int GetSymmetryClass() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetSymmetryClass() -> int

      Returns the 'symmetry class' property of an atom. The default value is
      zero, indicating that symmetry classes haven't been
      assigned. The 'symmetry class' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetSymmetryClass` method. Symmetry
      classes of a molecule are usually set by calling the
      :oe:func:`OEChem::OEPerceiveSymmetry` function.


   .. _OEChem_OEAtomBase_GetTotalHCount:


   .. oe:method:: GetTotalHCount

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

         .. oe:api::

            unsigned int GetTotalHCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalHCount() -> int

      Returns the total number of hydrogen atoms attached to an
      atom. This value includes the implicit hydrogen atoms. This
      value is identical to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitHCount()<OEChem::OEAtomBase::GetExplicitHCount>` +
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount()<OEChem::OEAtomBase::GetImplicitHCount>`.


   .. _OEChem_OEAtomBase_GetType:


   .. oe:method:: GetType

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

         .. oe:api::

            const char* GetType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> str

      Returns the 'atom type name' property  of an atom. This value is
      typically used when reading and writing molecular formats. For
      example, in Sybyl :file:`mol2` file, the atom type name ``N.pl3`` means
      that the atom should be treated as a three-valent planar
      nitrogen. The default value is the empty string. The 'atom type
      name' property may be set using the
      :oe:meth:`OEChem::OEAtomBase::SetType` method.


   .. _OEChem_OEAtomBase_GetValence:


   .. oe:method:: GetValence

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

         .. oe:api::

            unsigned int GetValence() const

      .. oe:language:: python

         .. oe:api:: python

            GetValence() -> int

      Returns the sum of all bond orders to an atom. This value
      includes bonds to implicit hydrogen atoms. This value is equal to
      :oe:meth:`OEChem::OEAtomBase::GetExplicitValence()<OEChem::OEAtomBase::GetExplicitValence>`  +
      :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount()<OEChem::OEAtomBase::GetImplicitHCount>`.


   .. _OEChem_OEAtomBase_HasAlphaBetaUnsat:


   .. oe:method:: HasAlphaBetaUnsat

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

         .. oe:api::

            bool HasAlphaBetaUnsat(bool includePandS = true) const

      .. oe:language:: python

         .. oe:api:: python

            HasAlphaBetaUnsat(includePandS: bool = True) -> bool

      .. warning::

         This is a deprecated method. Use :ref:`OEHasAlphaBetaUnsat <OEChem_OEHasAlphaBetaUnsat>` predicate
         instead.

   .. _OEChem_OEAtomBase_HasStereoSpecified:


   .. oe:method:: HasStereoSpecified

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

         .. oe:api::

            bool HasStereoSpecified(unsigned int v = OEAtomStereo::All) const

      .. oe:language:: python

         .. oe:api:: python

            HasStereoSpecified(v: int) -> bool

      Determines whether the given atom has specified
      stereochemistry. The optional argument specifies the class of
      stereochemistry to check for. The default value,
      :oe:const:`OEChem::OEAtomStereo::All`, checks whether any class
      of stereochemistry is specified for the current atom.

      If an atom has
      unspecified stereochemistry, and this method returns
      ``false``, the molecule is assumed to represent either a racemic
      mixture or an undetermined isomer of this compound. If this
      method returns ``true``, this atom has an explicit stereochemistry
      which may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetStereo` method.

      This method initially returns ``false`` for a newly created
      atom. The stereochemistry of an atom may be set by calling the
      :oe:meth:`OEChem::OEAtomBase::SetStereo` method with the
      appropriate stereochemistry class and any value other than
      :oe:const:`OEChem::OEAtomStereo::Undefined`. The atom
      stereochemistry may subsequently be cleared by calling the same
      method, with the appropriate stereochemistry class, but
      specifying the value :oe:const:`OEChem::OEAtomStereo::Undefined`.

      .. seealso::

         * :term:`stereo atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::IsChiral` 
         * :oe:meth:`OEChem::OEAtomBase::GetStereo` 


   .. _OEChem_OEAtomBase_IsAromatic:


   .. oe:method:: IsAromatic

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

         .. oe:api::

            bool IsAromatic() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsAromatic() -> bool

      Returns the 'aromatic' property of an atom. The default value is
      ``false``. The 'aromatic' property of an atom can be set using
      the :oe:meth:`OEChem::OEAtomBase::SetAromatic` method. The
      'aromatic' property of atoms and bonds in a molecule are
      typically set by calling either the 
      :oe:func:`OEChem::OEAssignAromaticFlags` function and cleared by the
      :oe:func:`OEChem::OEClearAromaticFlags` function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter

   .. _OEChem_OEAtomBase_IsCarbon:


   .. oe:method:: IsCarbon

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

         .. oe:api::

            bool IsCarbon() const

      .. oe:language:: python

         .. oe:api:: python

            IsCarbon() -> bool

      Determines whether an atom is a carbon atom. This method tests
      whether the atom's atomic number is `6`, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::C`.

   .. _OEChem_OEAtomBase_IsChiral:


   .. oe:method:: IsChiral

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

         .. oe:api::

            bool IsChiral() const

      .. oe:language:: python

         .. oe:api:: python

            IsChiral() -> bool

      Determines whether the current atom is a stereogenic center. If
      this method returns ``true``, the atom is a :term:`chiral atom`
      and the different left-handed and right-handed configurations
      about this atom represent two distinct isomers. If this method
      returns ``false``, this atom is not a chiral stereocenter.

      .. note::

         This :term:`chiral atom` property is independent of the
         :term:`stereo atom` property that records whether a particular
         left-handed or right-handed configuration is specified at a
         particular atom.

      .. seealso::

         * :term:`chiral atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` 
         * :oe:meth:`OEChem::OEAtomBase::GetStereo` 

   .. _OEChem_OEAtomBase_IsConnected:

   .. oe:method:: IsConnected

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

         .. oe:api::

            bool IsConnected(const OEAtomBase *) const

      .. oe:language:: python

         .. oe:api:: python

            IsConnected(arg2: OEAtomBase) -> bool

      Determines whether the atom is bonded to the given atom. To
      obtain the actual bond linking the atom to its neighbor use the
      :oe:meth:`OEChem::OEAtomBase::GetBond` method. This method is
      equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetBond()<OEChem::OEAtomBase::GetBond>`
      != (:oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`)0.

   .. _OEChem_OEAtomBase_IsDataType:


   .. oe:method:: IsDataType

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

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

   .. _OEChem_OEAtomBase_IsDeleted:

   .. oe:method:: IsDeleted

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

         .. oe:api::

            bool IsDeleted() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted() -> bool

   .. _OEChem_OEAtomBase_IsHalogen:

   .. oe:method:: IsHalogen

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

         .. oe:api::

            bool IsHalogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsHalogen() -> bool

      Determines whether an atom is a halogen atom. This method tests
      whether the atom is Fluorine, Chlorine, Bromine, Iodine or
      Astatine (atomic number :oe:const:`OEChem::OEElemNo::F`, :oe:const:`OEChem::OEElemNo::Cl`, 
      :oe:const:`OEChem::OEElemNo::Br`, :oe:const:`OEChem::OEElemNo::I` or 
      :oe:const:`OEChem::OEElemNo::As`).

   .. _OEChem_OEAtomBase_IsHydrogen:

   .. oe:method:: IsHydrogen

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

         .. oe:api::

            bool IsHydrogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsHydrogen() -> bool

      Determines whether an atom is a hydrogen atom. This method
      tests whether the atom's atomic number is ``1``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::H`.

   .. _OEChem_OEAtomBase_IsInRing:

   .. oe:method:: IsInRing

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

         .. oe:api::

            bool IsInRing() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsInRing() -> bool

      Returns the 'in ring' property of an atom. The default value is
      ``false``. The 'in ring' property of an atom may be set using
      the :oe:meth:`OEChem::OEAtomBase::SetInRing` method. The 'in
      ring' properties of atoms and bonds are typically set by calling
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

      To determine whether an atom is a member of a specific
      ring/cycle size, use the :oe:func:`OEChem::OEAtomIsInRingSize` function.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. _OEChem_OEAtomBase_IsMetal:

   .. oe:method:: IsMetal

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

         .. oe:api::

            bool IsMetal() const

      .. oe:language:: python

         .. oe:api:: python

            IsMetal() -> bool


      Determines whether an atom is a metal atom. 
      This tests whether the atom number is not :oe:const:`OEChem::OEElemNo::H`, 
      :oe:const:`OEChem::OEElemNo::He`, :oe:const:`OEChem::OEElemNo::B`, 
      :oe:const:`OEChem::OEElemNo::C`, :oe:const:`OEChem::OEElemNo::N`, 
      :oe:const:`OEChem::OEElemNo::O`, :oe:const:`OEChem::OEElemNo::F`, 
      :oe:const:`OEChem::OEElemNo::Ne`, :oe:const:`OEChem::OEElemNo::Si`,
      :oe:const:`OEChem::OEElemNo::P`, :oe:const:`OEChem::OEElemNo::S`, 
      :oe:const:`OEChem::OEElemNo::Cl`, :oe:const:`OEChem::OEElemNo::Ar`, 
      :oe:const:`OEChem::OEElemNo::As`, :oe:const:`OEChem::OEElemNo::Se`, 
      :oe:const:`OEChem::OEElemNo::Br`, :oe:const:`OEChem::OEElemNo::Kr`, 
      :oe:const:`OEChem::OEElemNo::Te`, :oe:const:`OEChem::OEElemNo::I`, 
      :oe:const:`OEChem::OEElemNo::Xe`, :oe:const:`OEChem::OEElemNo::At` or 
      :oe:const:`OEChem::OEElemNo::Rn`.

   .. _OEChem_OEAtomBase_IsNitrogen:

   .. oe:method:: IsNitrogen

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

         .. oe:api::

            bool IsNitrogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsNitrogen() -> bool

      Determines whether an atom is a nitrogen atom. This method
      tests whether the atom's atomic number is ``7``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::N`.

   .. _OEChem_OEAtomBase_IsOxygen:

   .. oe:method:: IsOxygen

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

         .. oe:api::

            bool IsOxygen() const

      .. oe:language:: python

         .. oe:api:: python

            IsOxygen() -> bool

      Determines whether an atom is an oxygen atom. This method
      tests whether the atom's atomic number is ``8``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::O`.

   .. _OEChem_OEAtomBase_IsPhosphorus:

   .. oe:method:: IsPhosphorus

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

         .. oe:api::

            bool IsPhosphorus() const

      .. oe:language:: python

         .. oe:api:: python

            IsPhosphorus() -> bool

      Determines whether an atom is a phosphorus atom. This method
      tests whether the atom's atomic number is ``15``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::P`.

   .. _OEChem_OEAtomBase_IsPolar:

   .. oe:method:: IsPolar

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

         .. oe:api::

            bool IsPolar() const

      .. oe:language:: python

         .. oe:api:: python

            IsPolar() -> bool

      Determines whether an atom is neither a carbon
      (:oe:const:`OEChem::OEElemNo::C`) nor hydrogen
      (:oe:const:`OEChem::OEElemNo::H`).

   .. _OEChem_OEAtomBase_IsPolarHydrogen:


   .. oe:method:: IsPolarHydrogen

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

         .. oe:api::

            bool IsPolarHydrogen() const

      .. oe:language:: python

         .. oe:api:: python

            IsPolarHydrogen() -> bool

      Determines whether an atom is a hydrogen attached to a polar
      atom. If the atom's atomic number is not one, *i.e.*
      :oe:meth:`OEChem::OEAtomBase::IsHydrogen()<OEChem::OEAtomBase::IsHydrogen>`
      == ``false``, then this method returns ``false`` too. Otherwise,
      this method returns ``true`` if any of its neighbors return
      ``true`` for :oe:meth:`OEChem::OEAtomBase::IsPolar`.


   .. _OEChem_OEAtomBase_IsSulfur:

   .. oe:method:: IsSulfur

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

         .. oe:api::

            bool IsSulfur() const

      .. oe:language:: python

         .. oe:api:: python

            IsSulfur() -> bool

      Determines whether an atom is a  sulfur (sulphur) atom. This method
      tests whether the atom's atomic number is ``16``, and is equivalent to
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum()<OEChem::OEAtomBase::GetAtomicNum>`
      == :oe:const:`OEChem::OEElemNo::S`.


   .. _OEChem_OEAtomBase_OrderBonds:

   .. oe:method:: OrderBonds

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

         .. oe:api::

            bool OrderBonds(const std::vector<OEBondBase *> &)=0

      .. oe:language:: python

         .. oe:api:: python

            OrderBonds(arg2: OEBondVector) -> bool

   .. _OEChem_OEAtomBase_RemoveBond:

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

      .. oe:api::

         bool RemoveBond(OEBondBase *)=0


   .. _OEChem_OEAtomBase_SetAromatic:

   .. oe:method:: SetAromatic

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

         .. oe:api::

            bool SetAromatic(bool)=0

      .. oe:language:: python

         .. oe:api:: python

            SetAromatic(arg2: bool) -> bool

      Sets the 'aromatic' property of an atom. This value is ``false``
      by default. The 'aromatic' property of an atom may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::IsAromatic` method. This
      method is normally only used by the
      :oe:func:`OEChem::OEClearAromaticFlags` function and the
      :oe:func:`OEChem::OEAssignAromaticFlags` function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter

   .. _OEChem_OEAtomBase_SetAtomicNum:

   .. oe:method:: SetAtomicNum

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

         .. oe:api::

            bool SetAtomicNum(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetAtomicNum(arg2: int) -> bool

      Sets the 'atomic number' property of an atom.  
      The set of valid values for this property is specified by the 
      :oe:constns:`OEChem::OEElemNo`.  
      The default value is specified when an atom is created with 
      :oe:meth:`OEChem::OEMolBase::NewAtom` method.  
      The 'atomic number' property of an atom can be retrieved using the 
      :oe:meth:`OEChem::OEAtomBase::GetAtomicNum` method.

   .. _OEChem_OEAtomBase_SetAxial:

   .. oe:method:: SetAxial

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

         .. oe:api::

            bool SetAxial(const OEBondBase *, bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAxial(arg2: OEBondBase, arg3: bool) -> bool

      .. warning::

         This is a deprecated method.


   .. _OEChem_OEAtomBase_SetChiral:

   .. oe:method:: SetChiral

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

         .. oe:api::

            bool SetChiral(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetChiral(arg2: bool) -> bool

      .. seealso::

         * :term:`chiral atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::SetStereo` 



   .. _OEChem_OEAtomBase_SetFormalCharge:

   .. oe:method:: SetFormalCharge

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

         .. oe:api::

            bool SetFormalCharge(int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetFormalCharge(arg2: int) -> bool

      Sets the 'formal charge' property of an atom. The default value is
      zero. The 'formal charge' property may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetFormalCharge` method.


   .. _OEChem_OEAtomBase_SetHyb:

   .. oe:method:: SetHyb

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

         .. oe:api::

            bool SetHyb(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetHyb(arg2: int) -> bool

      Sets the 'hybridization' property of an atom.  
      The set of valid values for this property is specified by the 
      :oe:constns:`OEChem::OEHybridization` namespace.
      The default value is zero (:oe:const:`OEChem::OEHybridization::Unknown`).  
      The 'hybridization' property may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetHyb` method. 

      .. seealso::
   
         * :oe:func:`OEChem::OEGetHybridization`
         * :oe:func:`OEChem::OEAssignHybridization`



   .. _OEChem_OEAtomBase_SetImplicitHCount:

   .. oe:method:: SetImplicitHCount

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

         .. oe:api::

            bool SetImplicitHCount(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetImplicitHCount(arg2: int) -> bool


      Sets the 'implicit hydrogen count' property of an atom. The default value
      is zero. The 'implicit hydrogen count' property may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::GetImplicitHCount`
      method.

   .. _OEChem_OEAtomBase_SetInRing:


   .. oe:method:: SetInRing

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

         .. oe:api::

            bool SetInRing(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetInRing(arg2: bool) -> bool

      Sets the 'in ring' property of an atom. This property is usually
      set by the
      :oe:func:`OEChem::OEFindRingAtomsAndBonds` function. The default value is
      ``false``. The 'in ring' property of an atom may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::IsInRing` method.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. _OEChem_OEAtomBase_SetIntType:
  
   .. oe:method:: SetIntType

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

         .. oe:api::

            bool SetIntType(int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetIntType(arg2: int) -> bool

      Sets the 'integer atom type' property of an atom. The default
      value is zero. The 'integer atom type' property may be retrieved
      using the :oe:meth:`OEChem::OEAtomBase::GetIntType` method. Note that
      IntType is considered volatile and can be overwritten by different algorithms 
      and also is not retained during I/O.

   .. _OEChem_OEAtomBase_SetIsotope:

   .. oe:method:: SetIsotope

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

         .. oe:api::

            bool SetIsotope(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetIsotope(arg2: int) -> bool

      Sets the 'isotopic mass' property of an atom (*i.e.* number of protons and neutrons). 
      The default value is zero, meaning that the atom isn't a specific single 
      isotope, but a composition of isotopes in their naturally occurring abundances.  
      A non-zero value indicates that the atom is a specific isotope.  
      The 'isotopic mass' property can be  retrieved using the 
      :oe:meth:`OEChem::OEAtomBase::GetIsotope` method.

   .. _OEChem_OEAtomBase_SetMapIdx:

   .. oe:method:: SetMapIdx

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

         .. oe:api::

            bool SetMapIdx(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetMapIdx(arg2: int) -> bool

      Sets the 'reaction map index' property of an atom. This integer value is
      used for tracking equivalent atom positions in a reaction
      molecule/transform. The default value is zero, meaning that the
      atom isn't mapped in the reaction.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method

   .. _OEChem_OEAtomBase_SetName:

   .. oe:method:: SetName

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

         .. oe:api::

            bool SetName(const char *)=0
            bool SetName(const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetName(arg2: str) -> bool

      Sets the 'atom name' property of an atom. This property is
      typically used when reading or writing molecular file
      formats. For example in PDB files, the atom name `` CA `` is
      used to denote that the atom is a peptide alpha carbon. The
      default value is the empty string. The 'atom name' property may
      be retrieved using the :oe:meth:`OEChem::OEAtomBase::GetName`
      method.


   .. _OEChem_OEAtomBase_SetPartialCharge:

   .. oe:method:: SetPartialCharge

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

         .. oe:api::

            bool SetPartialCharge(float)=0
            bool SetPartialCharge(double)=0

      .. oe:language:: python

         .. oe:api:: python

            SetPartialCharge(arg2: float) -> bool

      Sets the 'partial charge' property of an atom. The default value
      is ``0.0``. The 'partial charge' property may be retrieved using
      the :oe:meth:`OEChem::OEAtomBase::GetPartialCharge` method.


   .. _OEChem_OEAtomBase_SetRadius:

   .. oe:method:: SetRadius

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

         .. oe:api::

            bool SetRadius(double)

      .. oe:language:: python

         .. oe:api:: python

            SetRadius(arg2: float) -> bool

      Sets the 'radius' property of an atom.  
      The assigned radius may be retrieved using the  
      :oe:meth:`OEChem::OEAtomBase::GetRadius` method.  
      The 'radius' property is typically used to hold a Van der Waal's 
      or ionic radius for a given atom when passing an :ref:`OEMolBase <OEChem_OEMolBase>`
      to an algorithm requiring some form of radii, such as a surface area 
      calculation.

      .. seealso::

         * :oe:func:`OEChem::OEAssignCovalentRadii`
         * :oe:func:`OEChem::OEAssignDelphiRadii`
         * :oe:func:`OEChem::OEAssignBondiVdWRadii`
         * :oe:func:`OEChem::OEAssignPaulingVdWRadii`
         * :oe:func:`OEChem::OEAssignHonigIonicCavityRadii`
         * :oe:func:`OEChem::OEAssignZap9Radii`

   .. _OEChem_OEAtomBase_SetRxnRole:


   .. oe:method:: SetRxnRole

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

         .. oe:api::

            bool SetRxnRole(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetRxnRole(arg2: int) -> bool

      Sets the 'reaction role' property of an atom in a reaction
      molecule/transform. The set of valid values for this
      property is defined by the :oe:constns:`OEChem::OERxnRole`
      namespace. The default value is zero,
      :oe:const:`OEChem::OERxnRole::None`, which means that the atom
      does have a role, *i.e.* is part of a normal molecule. Other
      values include :oe:const:`OEChem::OERxnRole::Reactant`,
      :oe:const:`OEChem::OERxnRole::Agent` and
      :oe:const:`OEChem::OERxnRole::Product` which correspond to
      reactant, agent and product atoms, respectively, in a reaction
      or transform. The 'reaction role' property may be retrieved using
      the :oe:meth:`OEChem::OEAtomBase::SetRxnRole` method.


   .. _OEChem_OEAtomBase_SetStereo:

   .. oe:method:: SetStereo

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

         .. oe:api::

            bool SetStereo(const std::vector<OEAtomBase *> & neighs,
                           unsigned int stereoclass, unsigned int stereovalue)

      .. oe:language:: python

         .. oe:api:: python

            SetStereo(arg2: OEAtomVector, arg3: int, arg4: int) -> bool

      Sets the stereochemistry annotation of the atom.

      *neighs*
         A vector of neighboring atoms that defines the stereochemistry.

      *stereoclass*
         **OEChem TK** currently only supports the tetrahedral atom stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEAtomStereo::Tetra`.

      *stereovalue*
         This value can be either :oe:const:`OEChem::OEAtomStereo::Left` or
         :oe:const:`OEChem::OEAtomStereo::Right` when specifying a tetrahedral
         atom stereo center, or :oe:const:`OEChem::OEAtomStereo::Undefined` when
         unspecifying *i.e.* deleting an atom stereo center.

      This method returns ``true`` if the atom
      stereo was correctly set, and ``false`` if the stereochemistry
      class is invalid, the stereochemistry value is invalid for the
      stereochemistry class, or the vector of neighboring atoms is
      invalid. The stereo information of an atom may be retrieved using
      the :oe:meth:`OEChem::OEAtomBase::GetStereo`.

      If set successfully, to a value other than
      :oe:const:`OEChem::OEAtomStereo::Undefined`, future calls to
      :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` with the given
      stereochemistry class (or :oe:const:`OEChem::OEAtomStereo::All`)
      will return ``true``. If successfully set to the value
      :oe:const:`OEChem::OEAtomStereo::Undefined`, future calls to
      :oe:meth:`OEChem::OEAtomBase::HasStereoSpecified` will return
      ``false``.

      .. seealso::
 
         * :term:`stereo atom`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEAtomBase::SetChiral`


   .. _OEChem_OEAtomBase_SetSymmetryClass:

   .. oe:method:: SetSymmetryClass

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

         .. oe:api::

            bool SetSymmetryClass(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetSymmetryClass(arg2: int) -> bool

      Sets the symmetry class of an atom. This routine is normally
      only called by the 
      :oe:func:`OEChem::OEPerceiveSymmetry` function. The default value is zero,
      indicating that the symmetry class hasn't be perceived. The
      symmetry class of an atom may be retrieved by using the
      :oe:meth:`OEChem::OEAtomBase::GetSymmetryClass` function.


   .. _OEChem_OEAtomBase_SetType:

   .. oe:method:: SetType

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

         .. oe:api::

            bool SetType(const char *)=0
            bool SetType(const std::string &)=0

      .. oe:language:: python

         .. oe:api:: python

            SetType(arg2: str) -> bool

      Sets the 'atom type name'  property of an atom. This value
      is typically used when reading and writing molecular
      formats. For example, in Sybyl :file:`mol2` file, the atom type name
      ``N.pl3`` means that the atom should be treated as a
      three-valent planar nitrogen. The default value is the empty
      string. The 'atom type name' property may be retrieved using the
      :oe:meth:`OEChem::OEAtomBase::GetType` method.


   .. _OEChem_OEAtomBase_Sweep:

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

      .. oe:api::

         bool Sweep()=0

