.. oe:namespace:: OESiteHopper



.. _OESiteHopper_OESiteHopperSearch:

.. oe:class:: OESiteHopperSearch

   .. oe:api::


      class OESiteHopperSearch : public OESiteHopperSearchBase

   Class to perform a search of an OESiteHopperDatabase.

   The following methods are publicly inherited from :ref:`OESiteHopperSearchBase <OESiteHopper_OESiteHopperSearchBase>`:
   
   =============== ==========  =============
   operator bool   operator=   Search
   =============== ==========  =============

   .. oe:method:: Constructors

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

         .. oe:api::

            explicit OESiteHopperSearch(OESiteHopperDatabase& shdb)

      .. oe:language:: python

         .. oe:api:: python

            OESiteHopperSearch(shdb: OESiteHopperDatabase) -> OESiteHopperSearch

      Construct a search object to perform searches of the passed in OESiteHopperDatabase.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Used to verify that the database is opened correctly and the object is ready for a search.

   .. oe:method:: Search

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

         .. oe:api::

            OESystem::OEIterBase<OESiteHopper::OESiteHopperScore>* Search(const OEBio::OEDesignUnit& query,
                                                                          const OESiteHopperSearchOptions& options = OESiteHopperSearchOptions(),
                                                                          OESystem::OETracerBase& tracer = OESystem::NullTracer)

      .. oe:language:: python

         .. oe:api:: python

            Search(query: OEDesignUnit,
                   options: OESiteHopperSearchOptions = OESiteHopperSearchOptions(),
                   tracer: OETracerBase = NullTracer) -> Iterable[OESiteHopperScore]

      Perform a search using a query OEDesignUnit. 

      If you want to see a progress bar during the process, use an `OEConsoleProgressTracer`
      instead of the default `OENoTracer`.
