Detailed Description
The PIdentifyResult class represents a result returned by searching a PWatchlist.
Definition at line 29 of file PIdentifyResult.h.
#include <PIdentifyResult.h>
Constructor & Destructor Documentation
◆ PIdentifyResult() [1/3]
| PIdentifyResult::PIdentifyResult | ( | ) |
Constructs an empty result.
◆ PIdentifyResult() [2/3]
| PIdentifyResult::PIdentifyResult | ( | const PGuid & | identityId, |
| const PString & | name, | ||
| papillon::int32 | rank, | ||
| double | score | ||
| ) |
Constructs from the identity that has been identified.
Its friendly name, the rank and the score.
◆ PIdentifyResult() [3/3]
| PIdentifyResult::PIdentifyResult | ( | const PIdentifyResult & | other | ) |
Constructs a shared copy of other.
- See also
- Clone()
◆ ~PIdentifyResult()
|
virtual |
Destroys this object.
Member Function Documentation
◆ Clone()
| PIdentifyResult PIdentifyResult::Clone | ( | ) | const |
Returns a deep copy of this object.
◆ GetIdentityId()
| const PGuid& PIdentifyResult::GetIdentityId | ( | ) | const |
Returns the object id.
◆ GetName()
| PString PIdentifyResult::GetName | ( | ) | const |
Returns the friendly name of the watchlist identity id.
◆ GetRank()
| papillon::int32 PIdentifyResult::GetRank | ( | ) | const |
Returns the rank of the object in the watchlist or -1 if this result is empty.
◆ GetScore()
| double PIdentifyResult::GetScore | ( | ) | const |
Returns score of this result.
◆ IsEmpty()
| bool PIdentifyResult::IsEmpty | ( | ) | const |
Returns true is this result is empty, false otherwise.
◆ operator!=()
| bool PIdentifyResult::operator!= | ( | const PIdentifyResult & | other | ) | const |
Returns true if this PIdentifyResult is different from 'other'; otherwise returns false.
◆ operator=()
| PIdentifyResult& PIdentifyResult::operator= | ( | const PIdentifyResult & | other | ) |
Performs a shared copy of other to this object.
- See also
- Clone()
◆ operator==()
| bool PIdentifyResult::operator== | ( | const PIdentifyResult & | other | ) | const |
Returns true if this PIdentifyResult is equal to 'other'; otherwise returns false.
◆ Reset()
| void PIdentifyResult::Reset | ( | ) |
Sets this result to empty.
◆ SetName()
| void PIdentifyResult::SetName | ( | const PString & | name | ) |
Sets the friendly name.