SearchResult Class Reference

Search result returned by Minos. More...

#include <cvb/minos/search_result.hpp>

Public Member Functions
String	Name () const
	Name of the class that has been found. More...
double	Quality () const noexcept
	Quality at which the object has been found. More...
Point2D< double >	Position () const noexcept
	Position at which the object has been found. More...
double	X () const noexcept
	X position at which the object has been found. More...
double	Y () const noexcept
	Y position at which the object has been found. More...
Point2D< double >	AdvanceVector () const noexcept
	Advance vector of the model that has been found. More...
bool	IsNothing () const noexcept
	Returns whether the search result is empty or not. More...
	operator bool () const noexcept
	Returns whether the search result is empty or not. More...

Detailed Description

Search result returned by Minos.

Member Function Documentation

AdvanceVector()

Point2D< double > AdvanceVector ( ) const

inlinenoexcept

Advance vector of the model that has been found.

Returns

Search result advance vector.

Exceptions

Does	not throw any exception.

IsNothing()

bool IsNothing ( ) const

inlinenoexcept

Returns whether the search result is empty or not.

Returns

True if the search result is empty, false otherwise.

Exceptions

Does	not throw any exception.

Name()

String Name ( ) const

inline

Name of the class that has been found.

Returns

Class name.

Exceptions

Does	not throw any exception.

operator bool()

operator bool ( ) const

inlineexplicitnoexcept

Returns whether the search result is empty or not.

Returns

True if the search result has values, false otherwise.

Exceptions

Does	not throw any exception.

Position()

Point2D< double > Position ( ) const

inlinenoexcept

Position at which the object has been found.

Returns

Search result position.

Exceptions

Does	not throw any exception.

Quality()

double Quality ( ) const

inlinenoexcept

Quality at which the object has been found.

Returns

Search result quality.

Exceptions

Does	not throw any exception.

X()

double X ( ) const

inlinenoexcept

X position at which the object has been found.

Returns

Search result x-position.

Exceptions

Does	not throw any exception.

Y()

double Y ( ) const

inlinenoexcept

Y position at which the object has been found.

Returns

Search result y-position.

Exceptions

Does	not throw any exception.