PIdentifyResults Class Reference

Detailed Description

The PIdentifyResults class represents a collection of identification results (see PIdentifyResult).

PIdentifyResults are returned by a search on a PWatchlist.

Definition at line 28 of file PIdentifyResults.h.

#include <PIdentifyResults.h>

Constructor & Destructor Documentation

◆ PIdentifyResults() [1/2]

PIdentifyResults::PIdentifyResults ( )

Constructs an empty collection of results.

Default threshold is set to -DBL_MAX.

◆ PIdentifyResults() [2/2]

PIdentifyResults::PIdentifyResults ( const PIdentifyResults other)

Constructs a shared copy of other.

See also
Clone()

◆ ~PIdentifyResults()

virtual PIdentifyResults::~PIdentifyResults ( )
virtual

Destroys this object.

Member Function Documentation

◆ Add()

void PIdentifyResults::Add ( const PIdentifyResult r)

Adds the specified result to this collection.

◆ Clear()

void PIdentifyResults::Clear ( )

Removes all the results stored in this collection.

◆ Clone()

PIdentifyResults PIdentifyResults::Clone ( ) const

Returns a deep copy of this object.

Both the container and its elements are cloned.

◆ Get()

PIdentifyResult PIdentifyResults::Get ( papillon::int32  n) const

Returns the nth result of this collection, or an empty result if n is not the valid range.

◆ GetNumberOfMatches()

papillon::int32 PIdentifyResults::GetNumberOfMatches ( ) const

Returns the number of results with a score greater or equal to the threshold of this object.

◆ GetResults()

PIdentifyResults PIdentifyResults::GetResults ( ) const

Returns a subset of this collection containing only the results with a score greater or equal to the specified threshold.

◆ GetThreshold()

double PIdentifyResults::GetThreshold ( ) const

Returns the threshold used to filter results.

◆ IsEmpty()

bool PIdentifyResults::IsEmpty ( ) const

Returns true if this collection is empty, false otherwise.

◆ operator=()

PIdentifyResults& PIdentifyResults::operator= ( const PIdentifyResults other)

Performs a shared copy of other to this object.

See also
Clone()

◆ Remove()

PResult PIdentifyResults::Remove ( papillon::int32  n)

Removes the specified result from this collection.

Returns PResult::C_OK if success, another result otherwise. Warning: the collection size is reduced by 1 and the i-th element is the next element

◆ SetThreshold()

void PIdentifyResults::SetThreshold ( double  threshold)

Sets the threshold used to filter results.

◆ Size()

papillon::int32 PIdentifyResults::Size ( ) const

Returns the number of results in this collection.