.. oe:namespace:: OEChem



.. meta::
   :keywords: OEMol


.. _OEChem_OEMol:

.. oe:class:: OEMol

   .. oe:api::

      class OEMol

   The :ref:`OEMol <OEChem_OEMol>` class is a specific implementation of
   multi-conformer molecules.

   The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>`:

   =========================================================== =========================================================== ============================================================
   :oe:meth:`operator=<OEChem::OEMolBase::operator=>`          :oe:meth:`GetDimension<OEChem::OEMolBase::GetDimension>`    :oe:meth:`NumBonds<OEChem::OEMolBase::NumBonds>`            
   :oe:meth:`operator bool<OEChem::OEMolBase::operator bool>`  :oe:meth:`GetEnergy<OEChem::OEMolBase::GetEnergy>`          :oe:meth:`NumGroups<OEChem::OEMolBase::NumGroups>`          
   :oe:meth:`Clear<OEChem::OEMolBase::Clear>`                  :oe:meth:`GetGroup<OEChem::OEMolBase::GetGroup>`            :oe:meth:`OrderAtoms<OEChem::OEMolBase::OrderAtoms>`        
   :oe:meth:`ClearCoords<OEChem::OEMolBase::ClearCoords>`      :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>`          :oe:meth:`OrderBonds<OEChem::OEMolBase::OrderBonds>`        
   :oe:meth:`Compress<OEChem::OEMolBase::Compress>`            :oe:meth:`GetMaxAtomIdx<OEChem::OEMolBase::GetMaxAtomIdx>`  :oe:meth:`ResetPerceived<OEChem::OEMolBase::ResetPerceived>`
   :oe:meth:`Count<OEChem::OEMolBase::Count>`                  :oe:meth:`GetMaxBondIdx<OEChem::OEMolBase::GetMaxBondIdx>`  :oe:meth:`SetCoords<OEChem::OEMolBase::SetCoords>`          
   :oe:meth:`CreateCopy<OEChem::OEMolBase::CreateCopy>`        :oe:meth:`GetTitle<OEChem::OEMolBase::GetTitle>`            :oe:meth:`SetDimension<OEChem::OEMolBase::SetDimension>`    
   :oe:meth:`DeleteAtom<OEChem::OEMolBase::DeleteAtom>`        :oe:meth:`HasPerceived<OEChem::OEMolBase::HasPerceived>`    :oe:meth:`SetEnergy<OEChem::OEMolBase::SetEnergy>`          
   :oe:meth:`DeleteBond<OEChem::OEMolBase::DeleteBond>`        :oe:meth:`IsDataType<OEChem::OEMolBase::IsDataType>`        :oe:meth:`SetPerceived<OEChem::OEMolBase::SetPerceived>`    
   :oe:meth:`DeleteGroup<OEChem::OEMolBase::DeleteGroup>`      :oe:meth:`IsDeleted<OEChem::OEMolBase::IsDeleted>`          :oe:meth:`SetRxn<OEChem::OEMolBase::SetRxn>`                
   :oe:meth:`GetAtom<OEChem::OEMolBase::GetAtom>`              :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`                  :oe:meth:`SetTitle<OEChem::OEMolBase::SetTitle>`            
   :oe:meth:`GetAtoms<OEChem::OEMolBase::GetAtoms>`            :oe:meth:`NewAtom<OEChem::OEMolBase::NewAtom>`              :oe:meth:`Sweep<OEChem::OEMolBase::Sweep>`                  
   :oe:meth:`GetBond<OEChem::OEMolBase::GetBond>`              :oe:meth:`NewBond<OEChem::OEMolBase::NewBond>`              :oe:meth:`UnCompress<OEChem::OEMolBase::UnCompress>`        
   :oe:meth:`GetBonds<OEChem::OEMolBase::GetBonds>`            :oe:meth:`NewGroup<OEChem::OEMolBase::NewGroup>`            
   :oe:meth:`GetCoords<OEChem::OEMolBase::GetCoords>`          :oe:meth:`NumAtoms<OEChem::OEMolBase::NumAtoms>`            
   =========================================================== =========================================================== ============================================================

   .. oe:language:: java

      The following methods are publicly inherited from :ref:`OEMolBase <OEChem_OEMolBase>` only in Java:

      ====================================================== ====================================================== =========================================================
      :oe:meth:`GetAtomList<OEChem::OEMolBase::GetAtomList>` :oe:meth:`GetBondList<OEChem::OEMolBase::GetBondList>` :oe:meth:`GetGroupList<OEChem::OEMolBase::GetGroupList>` 
      ====================================================== ====================================================== =========================================================


   The following methods are publicly inherited from :ref:`OEMCMolBase <OEChem_OEMCMolBase>`:

   ============================================================= ============================================================ ============================================================
   :oe:meth:`DeleteConf<OEChem::OEMCMolBase::DeleteConf>`        :oe:meth:`GetMCMolTitle<OEChem::OEMCMolBase::GetMCMolTitle>` :oe:meth:`PushActive<OEChem::OEMCMolBase::PushActive>`      
   :oe:meth:`DeleteConfs<OEChem::OEMCMolBase::DeleteConfs>`      :oe:meth:`IsDeleted<OEChem::OEMCMolBase::IsDeleted>`         :oe:meth:`SetActive<OEChem::OEMCMolBase::SetActive>`        
   :oe:meth:`GetActive<OEChem::OEMCMolBase::GetActive>`          :oe:meth:`NewConf<OEChem::OEMCMolBase::NewConf>`             :oe:meth:`SweepConfs<OEChem::OEMCMolBase::SweepConfs>`      
   :oe:meth:`GetConf<OEChem::OEMCMolBase::GetConf>`              :oe:meth:`NumConfs<OEChem::OEMCMolBase::NumConfs>`                                                                       
   :oe:meth:`GetConfs<OEChem::OEMCMolBase::GetConfs>`            :oe:meth:`OrderConfs<OEChem::OEMCMolBase::OrderConfs>`                                                                   
   :oe:meth:`GetMaxConfIdx<OEChem::OEMCMolBase::GetMaxConfIdx>`  :oe:meth:`PopActive<OEChem::OEMCMolBase::PopActive>`                                                                     
   ============================================================= ============================================================ ============================================================


   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:: Constructors

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

         .. oe:api::

            OEMol(const OEMol &)
            OEMol(const OEMCMolBase &)
            OEMol(const OEMol &, unsigned int type)
            OEMol(unsigned int type = OEMolType::OEDefault)
            OEMol(const OEMCMolBase &, unsigned int type)
            OEMol(const OEQMol &, unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OEMolBase &, unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OEQMolBase &,
                  unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OEGraphMol &,
                  unsigned int type = OEMCMolType::OEDefault)
            OEMol(const OESystem::OEBase &,
                  unsigned int type = OEMCMolType::OEDefault)

      .. oe:language:: python

         .. oe:api:: python

            OEMol(t: int = OEMolType.OEDefault) -> OEMol
            OEMol(mol: OEMol) -> OEMol
            OEMol(mol: OEMol, t: int) -> OEMol
            OEMol(b: OEBase, t: int = OEMolType.OEDefault) -> OEMol
            OEMol(m: OEQMol, t: int = OEMolType.OEDefault) -> OEMol
            OEMol(m: OEMol) -> OEMol
            OEMol(m: OEMol, t: int) -> OEMol
            OEMol(mol: OEGraphMol, t: int) -> OEMol

      Default and copy constructors.

      *type*
         The type of the molecule from the
         :oe:constns:`OEChem::OEMCMolType` namespace.

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

      .. oe:api::

         OEMol &operator=(const OEMol &)
         OEMol &operator=(const OEQMol &)
         OEMol &operator=(const OEMolBase &)
         OEMol &operator=(const OEGraphMol &)
         OEMol &operator=(const OEQMolBase &)
         OEMol &operator=(const OEMCMolBase &)

      Assignment operators.

      Assignment operator.


   .. oe:method:: operator OEMCMolBase &
      :language: c++

      .. oe:api::

         operator const OEMCMolBase &() const
         operator OEMCMolBase &()

   .. oe:method:: ClearBase

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

         .. oe:api::

            void ClearBase()

      .. oe:language:: python

         .. oe:api:: python

            ClearBase() -> None

   .. oe:method:: ClearMCMol

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

         .. oe:api::

            void ClearMCMol()

      .. oe:language:: python

         .. oe:api:: python

            ClearMCMol() -> None

   .. oe:method:: ClearMolBase

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

         .. oe:api::

            void ClearMolBase()

      .. oe:language:: python

         .. oe:api:: python

            ClearMolBase() -> None

   .. oe:method:: MCMol

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

         .. oe:api::

            const OEMCMolBase& MCMol() const
            OEMCMolBase& MCMol()

      .. oe:language:: python

         .. oe:api:: python

            MCMol() -> OEMol

   .. oe:method:: SCMol

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

         .. oe:api::

            const OEMolBase& SCMol() const
            OEMolBase& SCMol()

      .. oe:language:: python

         .. oe:api:: python

            SCMol() -> OEGraphMol

   .. oe:language:: java

      .. oe:method:: GetConfList

         .. oe:api:: java

            java.util.List<OEConfBase> GetConfList()

         Returns a List object containing all of the conformers in the order they were
         created.  Note that removing atoms from the list does not remove them from
         the molecule.
