.. oe:namespace:: OEChem

.. meta::
   :keywords: OEQAtomBase, QAtomBase


.. _OEChem_OEQAtomBase:

.. oe:class:: OEQAtomBase

   .. oe:api::

      class OEQAtomBase : public OEAtomBase , public OEQBase

   The :ref:`OEQAtomBase <OEChem_OEQAtomBase>` class is the abstract interface
   for representing atoms and atom expressions within **OpenEye's Toolkits**.
   For a  description of query expressions and their utility in graph
   matching refer to the :ref:`section_patternmatch_OEExprOpts` section. 
   An :ref:`OEQAtomBase <OEChem_OEQAtomBase>` object is created by calling the
   :oe:meth:`OEChem::OEMolBase::NewAtom` method on the parent molecule.


   The following methods are publicly inherited from :ref:`OEAtomBase <OEChem_OEAtomBase>`:

   ===================================================================== ===================================================================== ====================================================================
   :oe:meth:`operator=<OEChem::OEAtomBase::operator=>`                   :oe:meth:`GetRadius<OEChem::OEAtomBase::GetRadius>`                   :oe:meth:`IsSulfur<OEChem::OEAtomBase::IsSulfur>`                   
   :oe:meth:`AddBond<OEChem::OEAtomBase::AddBond>`                       :oe:meth:`GetRxnRole<OEChem::OEAtomBase::GetRxnRole>`                 :oe:meth:`OrderBonds<OEChem::OEAtomBase::OrderBonds>`               
   :oe:meth:`Clear<OEChem::OEAtomBase::Clear>`                           :oe:meth:`GetStereo<OEChem::OEAtomBase::GetStereo>`                   :oe:meth:`RemoveBond<OEChem::OEAtomBase::RemoveBond>`               
   :oe:meth:`GetAtomicNum<OEChem::OEAtomBase::GetAtomicNum>`             :oe:meth:`GetSymmetryClass<OEChem::OEAtomBase::GetSymmetryClass>`     :oe:meth:`SetAromatic<OEChem::OEAtomBase::SetAromatic>`             
   :oe:meth:`GetAtoms<OEChem::OEAtomBase::GetAtoms>`                     :oe:meth:`GetTotalHCount<OEChem::OEAtomBase::GetTotalHCount>`         :oe:meth:`SetAtomicNum<OEChem::OEAtomBase::SetAtomicNum>`           
   :oe:meth:`GetType<OEChem::OEAtomBase::GetType>`                       
   :oe:meth:`GetBond<OEChem::OEAtomBase::GetBond>`                       :oe:meth:`GetValence<OEChem::OEAtomBase::GetValence>`                 :oe:meth:`SetChiral<OEChem::OEAtomBase::SetChiral>`                 
   :oe:meth:`GetBonds<OEChem::OEAtomBase::GetBonds>`                     :oe:meth:`SetFormalCharge<OEChem::OEAtomBase::SetFormalCharge>`     
   :oe:meth:`GetDegree<OEChem::OEAtomBase::GetDegree>`                   :oe:meth:`HasStereoSpecified<OEChem::OEAtomBase::HasStereoSpecified>` :oe:meth:`SetHyb<OEChem::OEAtomBase::SetHyb>`                       
   :oe:meth:`GetExplicitDegree<OEChem::OEAtomBase::GetExplicitDegree>`   :oe:meth:`IsAromatic<OEChem::OEAtomBase::IsAromatic>`
   :oe:meth:`GetExplicitHCount<OEChem::OEAtomBase::GetExplicitHCount>`   :oe:meth:`IsCarbon<OEChem::OEAtomBase::IsCarbon>`                     :oe:meth:`SetImplicitHCount<OEChem::OEAtomBase::SetImplicitHCount>` 
   :oe:meth:`GetExplicitValence<OEChem::OEAtomBase::GetExplicitValence>` :oe:meth:`IsChiral<OEChem::OEAtomBase::IsChiral>`                     :oe:meth:`SetInRing<OEChem::OEAtomBase::SetInRing>`                 
   :oe:meth:`GetFormalCharge<OEChem::OEAtomBase::GetFormalCharge>`       :oe:meth:`IsConnected<OEChem::OEAtomBase::IsConnected>`               :oe:meth:`SetIntType<OEChem::OEAtomBase::SetIntType>`               
   :oe:meth:`GetHvyDegree<OEChem::OEAtomBase::GetHvyDegree>`             :oe:meth:`IsDataType<OEChem::OEAtomBase::IsDataType>`                 :oe:meth:`SetIsotope<OEChem::OEAtomBase::SetIsotope>`               
   :oe:meth:`GetHvyValence<OEChem::OEAtomBase::GetHvyValence>`           :oe:meth:`IsDeleted<OEChem::OEAtomBase::IsDeleted>`                   :oe:meth:`SetMapIdx<OEChem::OEAtomBase::SetMapIdx>`                 
   :oe:meth:`GetHyb<OEChem::OEAtomBase::GetHyb>`                         :oe:meth:`IsHalogen<OEChem::OEAtomBase::IsHalogen>`                   :oe:meth:`SetName<OEChem::OEAtomBase::SetName>`                     
   :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`                         :oe:meth:`IsHydrogen<OEChem::OEAtomBase::IsHydrogen>`                 :oe:meth:`SetPartialCharge<OEChem::OEAtomBase::SetPartialCharge>`   
   :oe:meth:`GetImplicitHCount<OEChem::OEAtomBase::GetImplicitHCount>`   :oe:meth:`IsInRing<OEChem::OEAtomBase::IsInRing>`                     :oe:meth:`SetRadius<OEChem::OEAtomBase::SetRadius>`                 
   :oe:meth:`GetIntType<OEChem::OEAtomBase::GetIntType>`                 :oe:meth:`IsMetal<OEChem::OEAtomBase::IsMetal>`                       :oe:meth:`SetRxnRole<OEChem::OEAtomBase::SetRxnRole>`               
   :oe:meth:`GetIsotope<OEChem::OEAtomBase::GetIsotope>`                 :oe:meth:`IsNitrogen<OEChem::OEAtomBase::IsNitrogen>`                 :oe:meth:`SetStereo<OEChem::OEAtomBase::SetStereo>`                 
   :oe:meth:`GetMapIdx<OEChem::OEAtomBase::GetMapIdx>`                   :oe:meth:`IsOxygen<OEChem::OEAtomBase::IsOxygen>`                     :oe:meth:`SetSymmetryClass<OEChem::OEAtomBase::SetSymmetryClass>`   
   :oe:meth:`GetName<OEChem::OEAtomBase::GetName>`                       :oe:meth:`IsPhosphorus<OEChem::OEAtomBase::IsPhosphorus>`             :oe:meth:`SetType<OEChem::OEAtomBase::SetType>`                     
   :oe:meth:`GetParent<OEChem::OEAtomBase::GetParent>`                   :oe:meth:`IsPolar<OEChem::OEAtomBase::IsPolar>`                       :oe:meth:`Sweep<OEChem::OEAtomBase::Sweep>`                         
   :oe:meth:`GetPartialCharge<OEChem::OEAtomBase::GetPartialCharge>`     :oe:meth:`IsPolarHydrogen<OEChem::OEAtomBase::IsPolarHydrogen>`                                                                           
   ===================================================================== ===================================================================== ====================================================================

   The following methods are publicly inherited from :ref:`OEQBase <OEChem_OEQBase>`:

   ============================================ ============================================ ===========================================
   :oe:meth:`GetExpr<OEChem::OEQBase::GetExpr>` :oe:meth:`SetExpr<OEChem::OEQBase::SetExpr>`                                            
   ============================================ ============================================ ===========================================

   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>`
   ======================================================== ========================================================= =========================================================


   .. oe:method:: GetParentAtom

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

         .. oe:api::

            OEAtomBase* GetParentAtom() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetParentAtom() -> OEAtomBase

   .. oe:method:: GetQAtoms

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

         .. oe:api::

            OESystem::OEIterBase<OEQAtomBase>* GetQAtoms() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms() -> OEQAtomIter

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

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            GetQAtoms(arg2: OEUnaryAtomPred) -> OEQAtomIter

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

   .. oe:method:: GetQBonds

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

         .. oe:api::

            OESystem::OEIterBase<OEQBondBase>* GetQBonds() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds() -> OEQBondIter

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

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            GetQBonds(arg2: OEUnaryBondPred) -> OEQBondIter

      Returns an iterator over the query bonds of the :ref:`OEQAtomBase <OEChem_OEQAtomBase>` that match
      the predicate (:ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`)

   .. 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

