CVB.Net 14.0
SearchResult Struct Reference

Search results as provided by a Search Classifier. More...

Inherits IQualified, IPosition, IScaled, and IRotated.

Public Member Functions

override bool Equals (object obj)
 Equality comparison. More...
 
override int GetHashCode ()
 Hash code generation. More...
 

Static Public Member Functions

static bool operator== (SearchResult lhs, SearchResult rhs)
 Compare two SearchResults for equality. More...
 
static bool operator!= (SearchResult lhs, SearchResult rhs)
 Compare two SearchResults for inequality. More...
 

Static Public Attributes

static readonly SearchResult None = new SearchResult() { Quality = 0.0, X = -1.0, Y = -1.0, Scale = 0.0 }
 Generic "None" result.
 

Properties

double Quality [get]
 Search Result quality or confidence.
 
double Confidence [get]
 Search Result quality or confidence (just under a different name).
 
double X [get]
 X position.
 
double Y [get]
 Y position.
 
double Scale [get]
 Scale of the result (if applicable).
 
Angle Rotation [get]
 Rotation of the result (if applicable).
 
Matrix2D Matrix [get]
 Transformation description in Matrix form.
 
- Properties inherited from IQualified
double Quality [get]
 Name of the object.
 
- Properties inherited from IPosition
double X [get]
 X coordinate of the position.
 
double Y [get]
 Y coordinate of the position.
 
- Properties inherited from IScaled
double Scale [get]
 Name of the object.
 
- Properties inherited from IRotated
Angle Rotation [get]
 Name of the object.
 

Detailed Description

Search results as provided by a Search Classifier.

Member Function Documentation

◆ Equals()

override bool Equals ( object  obj)

Equality comparison.

Parameters
objObject to compare to.
Returns
True if the objects are identical, false otherwise

◆ GetHashCode()

override int GetHashCode ( )

Hash code generation.

Returns
Hash code for the object.

◆ operator!=()

static bool operator!= ( SearchResult  lhs,
SearchResult  rhs 
)
static

Compare two SearchResults for inequality.

Parameters
lhsFirst object to be compared
rhsSecond object to be compared
Returns
True if the objects differ, false otherwise

◆ operator==()

static bool operator== ( SearchResult  lhs,
SearchResult  rhs 
)
static

Compare two SearchResults for equality.

Parameters
lhsFirst object to be compared
rhsSecond object to be compared
Returns
False if the objects differ, true otherwise