OESiteHopperSearch

class OESiteHopperSearch : public OESiteHopperSearchBase

Class to perform a search of an OESiteHopperDatabase.

The following methods are publicly inherited from OESiteHopperSearchBase:

operator bool

operator=

Search

Constructors

OESiteHopperSearch(shdb: OESiteHopperDatabase) -> OESiteHopperSearch

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

operator bool

IsValid() -> bool

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

Search

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.