.. oe:namespace:: OEBio



.. _OEBio_OEPlaceHydrogensMoverNote:

.. oe:class:: OEPlaceHydrogensMoverNote

   .. oe:api::


      class OEPlaceHydrogensMoverNote

   The *read-only* container `OEPlaceHydrogensMoverNote` holds information about
   a single functional group processed by :oe:func:`OEBio::OEPlaceHydrogens`.

   These mover notes are organized into clusters in
   :oe:cls:`OEPlaceHydrogensDetails<OEBio::OEPlaceHydrogensDetails>` objects.

   .. seealso::

      * :ref:`section_place_hydrogens` section
      * :oe:func:`OEBio::OEPlaceHydrogens` function
      * :ref:`OEPlaceHydrogensDetails <OEBio_OEPlaceHydrogensDetails>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEPlaceHydrogensMoverNote()
            OEPlaceHydrogensMoverNote(const OEPlaceHydrogensMoverNote& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPlaceHydrogensMoverNote() -> OEPlaceHydrogensMoverNote
            OEPlaceHydrogensMoverNote(rhs: OEPlaceHydrogensMoverNote) -> OEPlaceHydrogensMoverNote

      Default and copy constructor.

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

      .. oe:api::

         OEPlaceHydrogensMoverNote &operator=(const OEPlaceHydrogensMoverNote &rhs)

      Assignment operator.

   .. oe:method:: Describe

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

         .. oe:api::

            std::string Describe() const

      .. oe:language:: python

         .. oe:api:: python

            Describe() -> str

      Returns a description of the identity, state, and score of this mover.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensDetails::Describe` method

   .. oe:method:: GetAngle

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

         .. oe:api::

            double GetAngle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAngle() -> float

      Returns the angle this mover was oriented in (if rotatable).

   .. oe:method:: GetFlippedBestClusterScore

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

         .. oe:api::

            double GetFlippedBestClusterScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlippedBestClusterScore() -> float

      Returns the best score for this cluster when this mover was flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: GetLabel

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

         .. oe:api::

            std::string GetLabel() const

      .. oe:language:: python

         .. oe:api:: python

            GetLabel() -> str

      Returns a string describing this mover.

   .. oe:method:: GetMoverClass

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

         .. oe:api::

            unsigned GetMoverClass() const

      .. oe:language:: python

         .. oe:api:: python

            GetMoverClass() -> int

      Returns the :oe:constns:`class<OEBio::OEPlaceHydrogensMoverClass>`
      of this mover.

      .. seealso::

         * :oe:constns:`OEBio::OEPlaceHydrogensMoverClass` namespace
         * :oe:func:`OEBio::OEGetPlaceHydrogensMoverClassName`


   .. oe:method:: GetOriginalBestClusterScore

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

         .. oe:api::

            double GetOriginalBestClusterScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetOriginalBestClusterScore() -> float

      Returns the best score for this cluster when this mover was *not* flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method


   .. oe:method:: GetReferenceCoords

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

         .. oe:api::

            bool GetReferenceCoords(double* xyz) const

      .. oe:language:: python

         .. oe:api:: python

            GetReferenceCoords(xyz: OEDoubleArray) -> bool

      Returns 3-D coordinates of an atom representing the location of this mover.

   .. oe:method:: GetScore

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

         .. oe:api::

            double GetScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetScore() -> float

      Returns the score for this mover.

   .. oe:method:: GetStateIdx

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

         .. oe:api::

            unsigned GetStateIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetStateIdx() -> int

      Returns the index of the conformational state of this mover.

   .. oe:method:: GetStateName

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

         .. oe:api::

            std::string GetStateName() const

      .. oe:language:: python

         .. oe:api:: python

            GetStateName() -> str

      Returns the name of the state of this mover.

   .. oe:method:: HasBadClash

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

         .. oe:api::

            bool HasBadClash() const

      .. oe:language:: python

         .. oe:api:: python

            HasBadClash() -> bool

      Returns ``true`` if this mover in a state that makes a bad clash.

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method

   .. oe:method:: HasFlippedBadClusterClash

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

         .. oe:api::

            bool HasFlippedBadClusterClash() const

      .. oe:language:: python

         .. oe:api:: python

            HasFlippedBadClusterClash() -> bool

      Returns ``true`` if this cluster has a bad clash when this mover is flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method
         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method


   .. oe:method:: HasOriginalBadClusterClash

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

         .. oe:api::

            bool HasOriginalBadClusterClash() const

      .. oe:language:: python

         .. oe:api:: python

            HasOriginalBadClusterClash() -> bool

      Returns ``true`` if this cluster has a bad clash when this mover is *not* flipped
      (if flippable).

      .. seealso::

         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetBadClashOverlapDistance` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::GetBadClashOverlapDistance` method
         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: IsFlippable

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

         .. oe:api::

            bool IsFlippable() const

      .. oe:language:: python

         .. oe:api:: python

            IsFlippable() -> bool

      Returns ``true`` if this this mover is flippable.

      .. seealso::

         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method

   .. oe:method:: IsFlipped

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

         .. oe:api::

            bool IsFlipped() const

      .. oe:language:: python

         .. oe:api:: python

            IsFlipped() -> bool

      Returns ``true`` if this mover has been flipped. If restrained, it may
      be flipped even though it is not flippable.

      .. seealso::

         * :oe:meth:`IsFlippable<OEBio::OEPlaceHydrogensMoverNote::IsFlippable>` method
         * :oe:meth:`IsRestrained<OEBio::OEPlaceHydrogensMoverNote::IsRestrained>` method
         * :oe:meth:`GetFlippedBestClusterScore<OEBio::OEPlaceHydrogensMoverNote::GetFlippedBestClusterScore>` method
         * :oe:meth:`GetOriginalBestClusterScore<OEBio::OEPlaceHydrogensMoverNote::GetOriginalBestClusterScore>` method
         * :oe:meth:`HasFlippedBadClusterClash<OEBio::OEPlaceHydrogensMoverNote::HasFlippedBadClusterClash>` method
         * :oe:meth:`HasOriginalBadClusterClash<OEBio::OEPlaceHydrogensMoverNote::HasOriginalBadClusterClash>` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetFlipPredicate` method

   .. oe:method:: IsIonized

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

         .. oe:api::

            bool IsIonized() const

      .. oe:language:: python

         .. oe:api:: python

            IsIonized() -> bool

      Returns ``true`` if this mover is in an ionized state.

   .. oe:method:: IsIonizable

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

         .. oe:api::

            bool IsIonizable() const

      .. oe:language:: python

         .. oe:api:: python

            IsIonizable() -> bool

      Returns ``true`` if this mover is ionized in one of its allowed states.

   .. oe:method:: IsRestrained

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

         .. oe:api::

            bool IsRestrained() const

      .. oe:language:: python

         .. oe:api:: python

            IsRestrained() -> bool

      Returns ``true`` if this mover is restrained as to the allowed states.
      For example, if it is restrained to be flipped.

      .. seealso::

         * :oe:meth:`IsFlipped<OEBio::OEPlaceHydrogensMoverNote::IsFlipped>` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetFlipPredicate` method
         * :oe:meth:`OEBio::OEPlaceHydrogensOptions::SetNoFlipPredicate` method
