Autoware.Auto
autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output Class Reference

Wrapper around an iterator and a distance (from some query point) More...

#include <spatial_hash.hpp>

Public Member Functions

 Output (const IT iterator, const float32_t distance)
 Constructor. More...
 
const PointT & get_point () const
 Get stored point. More...
 
IT get_iterator () const
 Get underlying iterator. More...
 
 operator const PointT & () const
 Convert to underlying point. More...
 
 operator IT () const
 Convert to underlying iterator. More...
 
float32_t get_distance () const
 Get distance to reference point. More...
 

Detailed Description

template<typename PointT, typename ConfigT>
class autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output

Wrapper around an iterator and a distance (from some query point)

Constructor & Destructor Documentation

◆ Output()

template<typename PointT , typename ConfigT >
autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output::Output ( const IT  iterator,
const float32_t  distance 
)
inline

Constructor.

Parameters
[in]iteratorAn iterator pointing to some point
[in]distanceThe euclidean distance (2d or 3d) to a reference point

Member Function Documentation

◆ get_distance()

template<typename PointT , typename ConfigT >
float32_t autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output::get_distance ( ) const
inline

Get distance to reference point.

Returns
The distance

◆ get_iterator()

template<typename PointT , typename ConfigT >
IT autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output::get_iterator ( ) const
inline

Get underlying iterator.

Returns
A copy of the underlying iterator

◆ get_point()

template<typename PointT , typename ConfigT >
const PointT& autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output::get_point ( ) const
inline

Get stored point.

Returns
A const reference to the stored point

◆ operator const PointT &()

template<typename PointT , typename ConfigT >
autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output::operator const PointT & ( ) const
inline

Convert to underlying point.

Returns
A reference to the underlying point

◆ operator IT()

template<typename PointT , typename ConfigT >
autoware::common::geometry::spatial_hash::SpatialHashBase< PointT, ConfigT >::Output::operator IT ( ) const
inline

Convert to underlying iterator.

Returns
A copy of the iterator

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