Class for storing the information of a possible bounding box candidate during a minimum distance search. More...

#include <CBBoxTargetClass.hpp>

Public Member Functions
	CBBoxTargetClass ()=default
	Constructor of the class. Nothing to be done.

	CBBoxTargetClass (const unsigned long val_BBoxID, const su2double val_posDist2, const su2double val_guarDist2)
	Constructor of the class, which initializes the member variables.

bool	operator< (const CBBoxTargetClass &other) const
	Less than operator. Needed for the sorting of the candidates.

Public Attributes
unsigned long	boundingBoxID
	Corresponding bounding box ID.

su2double	possibleMinDist2
	Possible minimimum distance squared to the given coordinate.

su2double	guaranteedMinDist2
	Guaranteed minimum distance squared to the given coordinate.

Detailed Description

Class for storing the information of a possible bounding box candidate during a minimum distance search.

Author: E. van der Weide

Version: 8.5.0 "Harrier"

Constructor & Destructor Documentation

◆ CBBoxTargetClass() [1/2]

CBBoxTargetClass::CBBoxTargetClass ( )

default

Constructor of the class. Nothing to be done.

◆ CBBoxTargetClass() [2/2]

CBBoxTargetClass::CBBoxTargetClass	(	const unsigned long	val_BBoxID,
		const su2double	val_posDist2,
		const su2double	val_guarDist2
	)

inline

Constructor of the class, which initializes the member variables.

Parameters

[in]	val_BBoxID	- ID of the bounding box to be stored.
[in]	val_posDist2	- Possible minimum distance squared to the target for this bounding box.
[in]	val_guarDist2	- Guaranteed minimum distance squared to the target for this bounding box.

Member Function Documentation

◆ operator<()

bool CBBoxTargetClass::operator< ( const CBBoxTargetClass & other ) const

inline

Less than operator. Needed for the sorting of the candidates.

Parameters

[in] other Object to which the current object must be compared.

Member Data Documentation

◆ boundingBoxID

unsigned long CBBoxTargetClass::boundingBoxID

Corresponding bounding box ID.

◆ guaranteedMinDist2

su2double CBBoxTargetClass::guaranteedMinDist2

Guaranteed minimum distance squared to the given coordinate.

◆ possibleMinDist2

su2double CBBoxTargetClass::possibleMinDist2

Possible minimimum distance squared to the given coordinate.

The documentation for this class was generated from the following file:

Common/include/adt/CBBoxTargetClass.hpp

Public Member Functions

Public Attributes