Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Types | Public Member Functions | Private Attributes
mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks Struct Reference

Detailed Description

The list of landmarks: the wrapper class is just for maintaining the KD-Tree representation.

Definition at line 92 of file maps/CLandmarksMap.h.

#include <mrpt/maps/CLandmarksMap.h>

Public Types

typedef internal::TSequenceLandmarks::iterator iterator
 
typedef internal::TSequenceLandmarks::const_iterator const_iterator
 

Public Member Functions

 TCustomSequenceLandmarks ()
 Default constructor.
 
iterator begin ()
 
iterator end ()
 
void clear ()
 
size_t size () const
 
const_iterator begin () const
 
const_iterator end () const
 
void push_back (const CLandmark &lm)
 The object is copied, thus the original copy passed as a parameter can be released.
 
CLandmarkget (unsigned int indx)
 
const CLandmarkget (unsigned int indx) const
 
void isToBeModified (unsigned int indx)
 
void hasBeenModified (unsigned int indx)
 
void hasBeenModifiedAll ()
 
void erase (unsigned int indx)
 
mrpt::utils::CDynamicGrid< vector_int > * getGrid ()
 
const CLandmarkgetByID (CLandmark::TLandmarkID ID) const
 Returns the landmark with a given landmrk ID, or NULL if not found.
 
const CLandmarkgetByBeaconID (unsigned int ID) const
 Returns the landmark with a given beacon ID, or NULL if not found.
 
float getLargestDistanceFromOrigin () const
 This method returns the largest distance from the origin to any of the points, such as a sphere centered at the origin with this radius cover ALL the points in the map (the results are buffered, such as, if the map is not modified, the second call will be much faster than the first one).
 

Private Attributes

internal::TSequenceLandmarks m_landmarks
 The actual list.
 
mrpt::utils::CDynamicGrid< vector_intm_grid
 A grid-map with the set of landmarks falling into each cell.
 
float m_largestDistanceFromOrigin
 Auxiliary variables used in "getLargestDistanceFromOrigin".
 
bool m_largestDistanceFromOriginIsUpdated
 Auxiliary variables used in "getLargestDistanceFromOrigin".
 

Member Typedef Documentation

◆ const_iterator

typedef internal::TSequenceLandmarks::const_iterator mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::const_iterator

Definition at line 124 of file maps/CLandmarksMap.h.

◆ iterator

typedef internal::TSequenceLandmarks::iterator mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::iterator

Definition at line 118 of file maps/CLandmarksMap.h.

Constructor & Destructor Documentation

◆ TCustomSequenceLandmarks()

mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::TCustomSequenceLandmarks ( )

Default constructor.

Member Function Documentation

◆ begin() [1/2]

iterator mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin ( )
inline

Definition at line 119 of file maps/CLandmarksMap.h.

◆ begin() [2/2]

const_iterator mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::begin ( ) const
inline

Definition at line 125 of file maps/CLandmarksMap.h.

◆ clear()

void mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::clear ( )

◆ end() [1/2]

iterator mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end ( )
inline

Definition at line 120 of file maps/CLandmarksMap.h.

◆ end() [2/2]

const_iterator mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::end ( ) const
inline

Definition at line 126 of file maps/CLandmarksMap.h.

◆ erase()

void mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::erase ( unsigned int  indx)

◆ get() [1/2]

CLandmark * mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::get ( unsigned int  indx)

◆ get() [2/2]

const CLandmark * mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::get ( unsigned int  indx) const

◆ getByBeaconID()

const CLandmark * mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::getByBeaconID ( unsigned int  ID) const

Returns the landmark with a given beacon ID, or NULL if not found.

◆ getByID()

const CLandmark * mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::getByID ( CLandmark::TLandmarkID  ID) const

Returns the landmark with a given landmrk ID, or NULL if not found.

◆ getGrid()

mrpt::utils::CDynamicGrid< vector_int > * mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::getGrid ( )
inline

Definition at line 138 of file maps/CLandmarksMap.h.

◆ getLargestDistanceFromOrigin()

float mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::getLargestDistanceFromOrigin ( ) const

This method returns the largest distance from the origin to any of the points, such as a sphere centered at the origin with this radius cover ALL the points in the map (the results are buffered, such as, if the map is not modified, the second call will be much faster than the first one).

◆ hasBeenModified()

void mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::hasBeenModified ( unsigned int  indx)

◆ hasBeenModifiedAll()

void mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::hasBeenModifiedAll ( )

◆ isToBeModified()

void mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::isToBeModified ( unsigned int  indx)

◆ push_back()

void mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::push_back ( const CLandmark lm)

The object is copied, thus the original copy passed as a parameter can be released.

◆ size()

size_t mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::size ( ) const
inline

Definition at line 122 of file maps/CLandmarksMap.h.

Member Data Documentation

◆ m_grid

mrpt::utils::CDynamicGrid<vector_int> mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::m_grid
private

A grid-map with the set of landmarks falling into each cell.

Todo:
Use the KD-tree instead?

Definition at line 101 of file maps/CLandmarksMap.h.

◆ m_landmarks

internal::TSequenceLandmarks mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::m_landmarks
private

The actual list.

Definition at line 96 of file maps/CLandmarksMap.h.

◆ m_largestDistanceFromOrigin

float mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::m_largestDistanceFromOrigin
mutableprivate

Auxiliary variables used in "getLargestDistanceFromOrigin".

See also
getLargestDistanceFromOrigin

Definition at line 106 of file maps/CLandmarksMap.h.

◆ m_largestDistanceFromOriginIsUpdated

bool mrpt::maps::CLandmarksMap::TCustomSequenceLandmarks::m_largestDistanceFromOriginIsUpdated
mutableprivate

Auxiliary variables used in "getLargestDistanceFromOrigin".

See also
getLargestDistanceFromOrigin

Definition at line 111 of file maps/CLandmarksMap.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Wed Mar 22 08:20:48 UTC 2023