.. oe:namespace:: OEChem

.. meta::
   :keywords: OEBondBase, BondBase

..  _OEBondBase:


.. _OEChem_OEBondBase:

.. oe:class:: OEBondBase

   .. oe:api::

      class OEBondBase : public OESystem::OEBase

   The :ref:`OEBondBase <OEChem_OEBondBase>` class is the abstract interface for
   representing bonds within **OpenEye's Toolkits**. An :ref:`OEBondBase <OEChem_OEBondBase>`
   object is created by calling the
   :oe:meth:`OEChem::OEMolBase::NewBond` 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:`OEQBondBase <OEChem_OEQBondBase>`
   

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

      .. oe:api::

         OEBondBase& operator=(const OEBondBase& b)

      Assignment operator.


   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()=0

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

   .. oe:method:: GetBgn

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

         .. oe:api::

            OEAtomBase* GetBgn() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetBgn() -> OEAtomBase

      Returns the 'begin' (or 'source') atom of a bond. The begin atom
      of a bond is defined either when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`, or possibly by a call to
      the :oe:meth:`OEChem::OEBondBase::SetBgn` method. If the begin
      atom was specified as the NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, when the
      bond was created, this method may return a NULL pointer.

      .. seealso::

         * :oe:meth:`OEChem::OEBondBase::GetEnd` method

   .. oe:method:: GetBgnIdx

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

         .. oe:api::

            unsigned int GetBgnIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetBgnIdx() -> int

      Returns the atom index of the 'begin' (or 'source') atom of a
      bond. This method is equivalent to
      :oe:meth:`OEChem::OEBondBase::GetBgn()<OEChem::OEBondBase::GetBgn>`->
      :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`.

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

   .. oe:method:: GetEnd

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

         .. oe:api::

            OEAtomBase* GetEnd() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetEnd() -> OEAtomBase

      Returns the 'end' (or 'destination') atom of a bond. The end atom
      of a bond is defined either when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`, or possibly by a call to
      the :oe:meth:`OEChem::OEBondBase::SetEnd` method. If the begin
      atom was specified as the NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, when the
      bond was created, this method may return a NULL pointer.

   .. oe:method:: GetEndIdx

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

         .. oe:api::

            unsigned int GetEndIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetEndIdx() -> int

      Returns the atom index of the 'end' (or 'destination') atom of a
      bond. This method is equivalent to
      :oe:meth:`OEChem::OEBondBase::GetEnd()<OEChem::OEBondBase::GetEnd>`->
      :oe:meth:`GetIdx<OEChem::OEAtomBase::GetIdx>`.

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

   .. 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 bond index of a bond. This value is assigned
      when a bond is created. The bond index is unique for
      the bonds 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. Bond
      indices are guaranteed to be less than
      :oe:meth:`OEChem::OEMolBase::GetMaxBondIdx`. Bond indices are
      typically only used for efficiently storing data in arrays (or
      vectors) externally to the :ref:`OEMolBase <OEChem_OEMolBase>`. The
      arrays can be conveniently indexed via
      :oe:meth:`OEChem::OEBondBase::GetIdx`. For iterating across the
      bonds of a molecule, use :oe:meth:`OEChem::OEMolBase::GetBonds`
      and for keeping track of a particular bond use its
      :oe:cls:`OEChem::OEBondBase*<OEChem::OEBondBase>`.

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

   .. 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 bond type' property of a bond. The default value is
      zero. The 'integer bond type' property may be set using the
      :oe:meth:`OEChem::OEBondBase::SetIntType` method.

   .. oe:method:: GetNbr

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

         .. oe:api::

            OEAtomBase* GetNbr(const OEAtomBase * nbr) const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetNbr(arg2: OEAtomBase) -> OEAtomBase

      Returns the atom across the bond from the specified atom. If the
      'nbr' argument represents the begin atom of the bond, *i.e.*
      :oe:meth:`OEChem::OEBondBase::GetBgn`, this method returns the
      end atom, *i.e.* :oe:meth:`OEChem::OEBondBase::GetEnd`, and if
      the 'nbr' argument is the end atom, this method returns the
      begin atom (:oe:meth:`OEChem::OEBondBase::GetBgn`). If passed an
      atom other than the begin or end atoms, this method returns a
      NULL pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0. This
      method is often used for traversing the atoms of a molecule.

   .. oe:method:: GetOrder

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

         .. oe:api::

            unsigned int GetOrder() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetOrder() -> int

      Returns the 'bond order' property of a bond. The 'bond order' property is
      one, for single bonds, two for double bonds, three for triple
      bonds and four for quadruple bonds. The default value is
      specified when a bond is created using
      :oe:meth:`OEChem::OEMolBase::NewBond`. The 'bond order' property of
      a bond may be set using the
      :oe:meth:`OEChem::OEBondBase::SetOrder` method.

   .. 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 of a bond. All
      :oe:cls:`OEChem::OEBondBases<OEChem::OEBondBase>` are created as
      a component of an :ref:`OEMolBase <OEChem_OEMolBase>`, this method can be
      used to determine the molecule of which a bond is part. The
      'parent molecule' property of a bond cannot be assigned, as its
      determined at the point the bond is created.

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

      *neighs*
        A vector of adjacent atoms of the bond.

      *stereoclass*
         **OEChem TK** currently only supports the cis/trans bond stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEBondStereo::CisTrans`.

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

      For a specified cis/trans stereo center, it returns either
      :oe:const:`OEChem::OEBondStereo::Cis` or
      :oe:const:`OEChem::OEBondStereo::Trans`.

      The stereochemistry annotation of a bond may be set
      using the :oe:meth:`OEChem::OEBondBase::SetStereo` method.

      .. seealso::

         * :term:`stereo bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::IsChiral` method
         * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method


   .. 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 'bond type name' property of a bond. This value is
      typically used when reading and writing molecular formats. For
      example, in Sybyl :file:`mol2` file, the bond type name ``am``
      means that the bond should be treated as an amide bond. The
      default value is the empty string. The 'bond type name' property
      may be set using the :oe:meth:`OEChem::OEBondBase::SetType` method.

   .. oe:method:: HasStereoSpecified

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            HasStereoSpecified(v: int) -> bool


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

      If a bond 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 bond has an explicit stereochemistry which may be
      retrieved using the :oe:meth:`OEChem::OEBondBase::GetStereo`
      method.

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

      .. seealso::
 
         * :term:`stereo bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::IsChiral` method
         * :oe:meth:`OEChem::OEBondBase::GetStereo` method

   .. 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 a bond. The default value is
      ``false``. The 'aromatic' property of a bond can be set using the
      :oe:meth:`OEChem::OEBondBase::SetAromatic` method. The 'aromatic'
      property of bonds and atoms in a molecule are typically set by
      calling either the :oe:func:`OEChem::OEAssignAromaticFlags`
      function, or the :oe:func:`OEChem::OEClearAromaticFlags`
      function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter 

   .. 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 bond is a stereogenic center. If
      this method returns ``true``, the bond is a :term:`chiral bond` and
      the cis and trans forms of this bond represent two distinct
      isomers. If this method returns ``false``, this bond is not a
      chiral stereocenter.

      .. note::

         This :term:`chiral bond` property is independent of the
         :term:`stereo bond` property that records whether a particular
         cis or trans configuration is specified at a
         particular bond.

      .. seealso::
 
         * :term:`chiral bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::GetStereo` method
         * :oe:meth:`OEChem::OEBondBase::HasStereoSpecified` method

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

   .. oe:method:: IsDeleted

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

         .. oe:api::

            bool IsDeleted() const = 0

      .. oe:language:: python

         .. oe:api:: python

            IsDeleted() -> bool

   .. 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 a bond. The default value is
      ``false``. The 'in ring' property of a bond may be set using
      the :oe:meth:`OEChem::OEBondBase::SetInRing` method. The 'in
      ring' properties of bonds and atoms are typically set by calling
      the :oe:func:`OEChem::OEFindRingAtomsAndBonds` function.

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

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. oe:method:: IsRotor

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

         .. oe:api::

            bool IsRotor() const

      .. oe:language:: python

         .. oe:api:: python

            IsRotor() -> bool

      Determines whether a bond is freely :term:`rotatable<rotatable bond>` 

      .. note::

         Since the  'rotatable' property is depends on the 'in ring' property.
         The  :oe:func:`OEChem::OEFindRingAtomsAndBonds` function must be called
         before accessing the :term:`rotatable bond` property via 
         :oe:meth:`OEChem::OEBondBase::IsRotor`. 

      .. seealso:: 

         * :term:`rotatable bond`
         * :oe:func:`OEMolProp::OEGetRotatableBondCount` function

   .. 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 a bond. This value is ``false``
      by default. The 'aromatic' property of a bond may be retrieved
      using the :oe:meth:`OEChem::OEBondBase::IsAromatic` method. This
      method is normally only used by the
      :oe:func:`OEChem::OEClearAromaticFlags` function and
      :oe:func:`OEChem::OEAssignAromaticFlags` function.

      .. seealso::

         * :ref:`chapter_aromaticity` chapter

   .. oe:method:: SetBgn

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

         .. oe:api::

            bool SetBgn(OEAtomBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            SetBgn(arg2: OEAtomBase) -> bool

      Defines the 'begin' (or 'source') atom of a bond. Normally, the
      begin atom of a bond is defined when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`. However, it is
      occasionally useful to defer this decision, by passing the NULL
      pointer,
      (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, as
      the begin atom to :oe:meth:`OEChem::OEMolBase::NewBond`. The
      begin atom should then later be specified by calling this
      method, :oe:meth:`OEChem::OEBondBase::SetBgn`, to resolve the
      begin atom before the molecule is used. Note that it is not
      possible to set/change the begin atom of a bond, once it has
      been defined. To achieve the same behavior call the
      :oe:meth:`OEChem::OEMolBase::DeleteBond` method, followed by
      :oe:meth:`OEChem::OEMolBase::NewBond`, to first destroy the
      original and replace it with a new bond.

   .. 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 bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::SetStereo`

   .. oe:method:: SetEnd

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

         .. oe:api::

            bool SetEnd(OEAtomBase *)=0

      .. oe:language:: python

         .. oe:api:: python

            SetEnd(arg2: OEAtomBase) -> bool

      Defines the 'end' (or 'destination') atom of a bond. Normally,
      the end atom of a bond is defined when the bond is created with
      :oe:meth:`OEChem::OEMolBase::NewBond`. However, it is
      occasionally useful to defer this decision, by passing the NULL
      pointer, (:oe:cls:`OEChem::OEAtomBase*<OEChem::OEAtomBase>`)0, as
      the end atom to
      :oe:meth:`OEChem::OEMolBase::NewBond`. The end atom should then
      later be specified by calling this method,
      :oe:meth:`OEChem::OEBondBase::SetEnd`, to resolve the end atom
      before the molecule is used. Note that it is not possible to
      set/change the end atom of a bond, once it has been defined. To
      achieve the same behavior call the
      :oe:meth:`OEChem::OEMolBase::DeleteBond` method, followed by
      :oe:meth:`OEChem::OEMolBase::NewBond`, to first destroy the
      original and replace it with a new bond.

   .. oe:method: SetIdx IGNORED-METHOD

      .. oe:api::

         bool SetIdx(unsigned int)=0

   .. 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 a bond. This property is usually
      set by the :oe:func:`OEChem::OEFindRingAtomsAndBonds`
      function. The default value is ``false``. The 'in ring' property
      of a bond can be retrieved using the
      :oe:meth:`OEChem::OEBondBase::IsInRing` method.

      .. seealso:: 

         * :ref:`chapter_ring` chapter

   .. 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 bond type' property of a bond. The default value is
      zero. The 'integer bond type' property may be retrieved using the
      :oe:meth:`OEChem::OEBondBase::GetIntType` method.

   .. oe:method:: SetOrder

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

         .. oe:api::

            bool SetOrder(unsigned int)=0

      .. oe:language:: python

         .. oe:api:: python

            SetOrder(arg2: int) -> bool

      Sets the 'bond order' property of a bond. The 'bond order' property is
      one, for single bonds, two for double bonds, three for triple
      bonds and four for quadruple bonds. The default value is
      specified when a bond is created using
      :oe:meth:`OEChem::OEMolBase::NewBond`. The 'bond order' property of
      a bond may be retrieved using the
      :oe:meth:`OEChem::OEBondBase::GetOrder` method.

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

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

      *stereoclass*
         **OEChem TK** currently only supports the cis/trans bond stereochemistry class.
         The only valid *stereoclass* value is :oe:const:`OEChem::OEBondStereo::CisTrans`.

      *stereovalue*
         This value can be either :oe:const:`OEChem::OEBondStereo::Cis` or
         :oe:const:`OEChem::OEBondStereo::Trans` when specifying a cis/trans
         bond stereo center, or :oe:const:`OEChem::OEBondStereo::Undefined` when
         un-specifying *i.e.* deleting a bond stereo center.

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

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

      .. seealso::
 
         * :term:`stereo bond`
         * :ref:`chapter_stereochemistry` chapter
         * :oe:meth:`OEChem::OEBondBase::SetChiral`

   .. 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 'bond type name' property of a bond. This value is
      typically used when reading and writing molecular formats. For
      example, in Sybyl :file:`mol2` file, the bond type name ``am``
      means that the bond should be treated as an amide bond. The
      default value is the empty string. The 'bond type name' property
      may be retrieved using the :oe:meth:`OEChem::OEBondBase::GetType`
      method.

   .. oe:method:: SwapEnds

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

         .. oe:api::

            bool SwapEnds()=0

      .. oe:language:: python

         .. oe:api:: python

            SwapEnds() -> bool

      Swaps the begin and end atoms of a bond. The lists of bonds
      contained in each of the two atoms are not altered. After
      calling the :oe:meth:`OEChem::OEBondBase::SwapEnds` method, the atoms
      returned by the :oe:meth:`OEChem::OEBondBase::GetBgn` and
      :oe:meth:`OEChem::OEBondBase::GetEnd` methods will be
      interchanged.

   .. oe:method:: Sweep

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

         .. oe:api::

            bool Sweep()=0

      .. oe:language:: python

         .. oe:api:: python

            Sweep() -> bool

