OEEonHitlistBuilder

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEEonHitlistBuilder

The OEEonHitlistBuilder class defines the following public methods:

• GetAddCount

• GetHitCount

• GetHits

• AddScore

• AddScores

• Build

Constructors

OEEonHitlistBuilder();
OEEonHitlistBuilder(const OEEonHitlistOptions& hitlistOptions);

Destructor

~OEEonHitlistBuilder()

GetAddCount

unsigned GetAddCount() const;

This method returns number of added entries to the hit list.

GetHitCount

unsigned GetHitCount() const;

This method returns the number of hits stored currently in the hit list object.

GetHits

std::vector<OEEonHit> GetHits() const;
bool GetHits(std::vector<OEEonHit>& vecHits) const;

This method returns the sorted hits.

AddScores

bool AddScores(const std::vector<OEEon::OEEonHit>& hits);

This method adds a vector of hits to the hit list object.

AddScore

bool AddScore(const OEEonOverlayScore& score, const OEChem::OEMCMolBase& mol);

This method adds an Eon hit to the hit list object.

Build

bool Build();

This method builds internal variables to build a hit list once all scores have been added.