GpuLaserDataIterator< F > Class Template Reference

const Bidirectional iterator for laser data More...

#include <GpuLaserDataIterator.hh>

Public Member Functions

 ~GpuLaserDataIterator ()
 Destructor.
 
bool operator!= (const GpuLaserDataIterator &_rvalue) const
 Operator !=.
 
const GpuLaserData operator* () const
 Dereference operator *iter.
 
GpuLaserDataIterator< F > & operator++ ()
 Advance iterator to next reading (prefix: ++it)
 
GpuLaserDataIterator< Foperator++ (int _dummy)
 Advance this iterator (postfix: it++)
 
GpuLaserDataIterator< F > & operator-- ()
 Move itereator to previous (prefix: –it)
 
GpuLaserDataIterator< Foperator-- (int _dummy)
 Move itereator to previous (postfix: it–)
 
const std::unique_ptr< const GpuLaserDataoperator-> () const
 Dereference operator iter->
 
bool operator== (const GpuLaserDataIterator &_rvalue) const
 Operator ==.
 

Public Attributes

friend F
 

Protected Member Functions

 GpuLaserDataIterator (const unsigned int _index, const float *_data, const unsigned int _skip, const unsigned int _rangeOffset, const unsigned int _intensityOffset, const unsigned int _horizontalResolution)
 contstruct an iterator to a specified index
 

Detailed Description

template<typename F>
class gazebo::rendering::GpuLaserDataIterator< F >

const Bidirectional iterator for laser data

This class contains the information needed to access Laser Data It implements a Bidirectional Input iterator http://www.cplusplus.com/reference/iterator/BidirectionalIterator/ The compiler should optimize out calls to this class

Constructor & Destructor Documentation

◆ ~GpuLaserDataIterator()

template<typename F >
~GpuLaserDataIterator ( )

Destructor.

◆ GpuLaserDataIterator()

template<typename F >
GpuLaserDataIterator ( const unsigned int _index,
const float * _data,
const unsigned int _skip,
const unsigned int _rangeOffset,
const unsigned int _intensityOffset,
const unsigned int _horizontalResolution )
protected

contstruct an iterator to a specified index

Member Function Documentation

◆ operator!=()

template<typename F >
bool operator!= ( const GpuLaserDataIterator< F > & _rvalue) const

Operator !=.

Parameters
[in]_rvalueThe iterator on the right of the !=
Returns
true iff the iterators point to different readings

◆ operator*()

template<typename F >
const GpuLaserData operator* ( ) const

Dereference operator *iter.

Returns
A struct of laser data

◆ operator++() [1/2]

template<typename F >
GpuLaserDataIterator< F > & operator++ ( )

Advance iterator to next reading (prefix: ++it)

Returns
reference to this pointer after advancing

◆ operator++() [2/2]

template<typename F >
GpuLaserDataIterator< F > operator++ ( int _dummy)

Advance this iterator (postfix: it++)

Parameters
[in]_dummydoes nothing, required for postfix overload
Returns
a copy of this iterator prior to advancing

◆ operator--() [1/2]

template<typename F >
GpuLaserDataIterator< F > & operator-- ( )

Move itereator to previous (prefix: –it)

Returns
reference to this pointer after moving

◆ operator--() [2/2]

template<typename F >
GpuLaserDataIterator< F > operator-- ( int _dummy)

Move itereator to previous (postfix: it–)

Parameters
[in]_dummydoes nothing, required for postfix overload
Returns
a copy of this iterator prior to moving

◆ operator->()

template<typename F >
const std::unique_ptr< const GpuLaserData > operator-> ( ) const

Dereference operator iter->

Returns
a shared pointer object at the iterator's index

◆ operator==()

template<typename F >
bool operator== ( const GpuLaserDataIterator< F > & _rvalue) const

Operator ==.

Parameters
[in]_rvalueThe iterator on the right of the ==
Returns
true iff the iterators point to the same reading

Member Data Documentation

◆ F

template<typename F >
friend F

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