.. oe:namespace:: OESiteHopper



.. _OESiteHopper_OESiteHopperScore:

.. oe:class:: OESiteHopperScore

   .. oe:api::


      class OESiteHopperScore : public OESiteHopperResults

   This class is use to hold the score and results from a SiteHopper search.

   The following methods are publicly inherited from :ref:`OESiteHopperResults <OESiteHopper_OESiteHopperResults>`:
   
   ========================================================================================== ========================================================================================== ========================================================================================== 
   :oe:meth:`operator=<OESiteHopper::OESiteHopperResults::operator=>`                         :oe:meth:`GetRank<OESiteHopper::OESiteHopperResults::GetRank>`                             :oe:meth:`SetColorTanimoto<OESiteHopper::OESiteHopperResults::SetColorTanimoto>`
   :oe:meth:`GetColorScale<OESiteHopper::OESiteHopperResults::GetColorScale>`                 :oe:meth:`GetSequenceSimilarity<OESiteHopper::OESiteHopperResults::GetSequenceSimilarity>` :oe:meth:`SetRank<OESiteHopper::OESiteHopperResults::SetRank>`
   :oe:meth:`GetColorTanimoto<OESiteHopper::OESiteHopperResults::GetColorTanimoto>`           :oe:meth:`GetShapeTanimoto<OESiteHopper::OESiteHopperResults::GetShapeTanimoto>`           :oe:meth:`SetSequenceSimilarity<OESiteHopper::OESiteHopperResults::SetSequenceSimilarity>`
   :oe:meth:`GetPatchScore<OESiteHopper::OESiteHopperResults::GetPatchScore>`                 :oe:meth:`SetColorScale<OESiteHopper::OESiteHopperResults::SetColorScale>`                 :oe:meth:`SetShapeTanimoto<OESiteHopper::OESiteHopperResults::SetShapeTanimoto>`
   ========================================================================================== ========================================================================================== ========================================================================================== 
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESiteHopperScore()
            OESiteHopperScore(OESiteHopperScore &&)
            OESiteHopperScore(const OESiteHopperScore& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperScore() -> OESiteHopperScore
            OESiteHopperScore(rhs: OESiteHopperScore) -> OESiteHopperScore

      Default constructors.


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

      .. oe:api::

         OESiteHopperScore &operator=(OESiteHopperScore &&rhs)
         OESiteHopperScore &operator=(const OESiteHopperScore &rhs)

      Assignment operator.


   .. oe:method:: GetDesignUnit

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

         .. oe:api::

            OEBio::OEDesignUnit GetDesignUnit() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesignUnit() -> OEDesignUnit

      Get output OEDesignUnit for this result. The transfrom from the overlay
      will already be applied.

   .. oe:method:: GetID

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

         .. oe:api::

            unsigned int GetID() const

      .. oe:language:: python

         .. oe:api:: python

            GetID() -> int

      Get database index for this result.

   .. oe:method:: GetTitle

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

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Get title from OEDesignUnit.

   .. oe:method:: GetTransform

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

         .. oe:api::

            const OEChem::OETrans& GetTransform() const

      .. oe:language:: python

         .. oe:api:: python

            GetTransform() -> OETrans

      Get the transform from the overlay. This allows applying the same transform to
      other objects to move them into the output frame of reference.

      .. note::

         When asking for the OEDesignUnit from this class, DO NOT apply this 
         transform as the OEDesignUnit will already be transformed.

   .. oe:method:: SetDesignUnit

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

         .. oe:api::

            void SetDesignUnit(const OEBio::OEDesignUnit& du)

      .. oe:language:: python

         .. oe:api:: python

            SetDesignUnit(du: OEDesignUnit) -> None

      Internal use: Set the OEDesignUnit.

   .. oe:method:: SetID

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

         .. oe:api::

            void SetID(const unsigned int id)

      .. oe:language:: python

         .. oe:api:: python

            SetID(id: int) -> None

      Internal use: Set the database index.

   .. oe:method:: SetTitle

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

         .. oe:api::

            void SetTitle(const std::string& title)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(title: str) -> None

      Internal use: Set the title.

   .. oe:method:: SetTransform

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

         .. oe:api::

            void SetTransform(const OEChem::OETrans& trans)

      .. oe:language:: python

         .. oe:api:: python

            SetTransform(trans: OETrans) -> None

      Internal use: Set the transform.
