Apollo  6.0
Open source self driving car software
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
apollo::localization::msf::MapNodeIndex Class Reference

#include <base_map_node_index.h>

Collaboration diagram for apollo::localization::msf::MapNodeIndex:
Collaboration graph

Public Member Functions

 MapNodeIndex ()
 The constructor. More...
 
bool operator< (const MapNodeIndex &index) const
 Overload the less than operator. More...
 
bool operator== (const MapNodeIndex &index) const
 Overload the equal operator. More...
 
bool operator!= (const MapNodeIndex &index) const
 Overload the unequal operator. More...
 
std::string ToString () const
 

Static Public Member Functions

static MapNodeIndex GetMapNodeIndex (const BaseMapConfig &option, const Eigen::Vector3d &coordinate, unsigned int resolution_id, int zone_id)
 Construct a map node index, given a global coordinate. More...
 
static MapNodeIndex GetMapNodeIndex (const BaseMapConfig &option, const Eigen::Vector2d &coordinate, unsigned int resolution_id, int zone_id)
 
static unsigned int GetMapIndexRangeEast (const BaseMapConfig &option, unsigned int resolution_id)
 Get the index range (maximum possible index + 1) in the east direction. More...
 
static unsigned int GetMapIndexRangeNorth (const BaseMapConfig &option, unsigned int resolution_id)
 Get the index range (maximum possible index + 1) in the north direction. More...
 

Public Attributes

unsigned int resolution_id_ = 0
 The ID of the resolution. Should be less than BaseMapConfig::map_resolutions_.size(). More...
 
int zone_id_ = 50
 The zone ID. 1 - 60 and -1 - -60. The positive value is the zone at the north hemisphere. More...
 
unsigned int m_ = 0
 The map node ID at the northing direction. More...
 
unsigned int n_ = 0
 The map node ID at the easting direction. More...
 

Friends

std::ostream & operator<< (std::ostream &cout, const MapNodeIndex &index)
 

Constructor & Destructor Documentation

◆ MapNodeIndex()

apollo::localization::msf::MapNodeIndex::MapNodeIndex ( )

The constructor.

Member Function Documentation

◆ GetMapIndexRangeEast()

static unsigned int apollo::localization::msf::MapNodeIndex::GetMapIndexRangeEast ( const BaseMapConfig option,
unsigned int  resolution_id 
)
static

Get the index range (maximum possible index + 1) in the east direction.

◆ GetMapIndexRangeNorth()

static unsigned int apollo::localization::msf::MapNodeIndex::GetMapIndexRangeNorth ( const BaseMapConfig option,
unsigned int  resolution_id 
)
static

Get the index range (maximum possible index + 1) in the north direction.

◆ GetMapNodeIndex() [1/2]

static MapNodeIndex apollo::localization::msf::MapNodeIndex::GetMapNodeIndex ( const BaseMapConfig option,
const Eigen::Vector3d &  coordinate,
unsigned int  resolution_id,
int  zone_id 
)
static

Construct a map node index, given a global coordinate.

Construct a map node index, given a global coordinate, eigen version.

◆ GetMapNodeIndex() [2/2]

static MapNodeIndex apollo::localization::msf::MapNodeIndex::GetMapNodeIndex ( const BaseMapConfig option,
const Eigen::Vector2d &  coordinate,
unsigned int  resolution_id,
int  zone_id 
)
static

◆ operator!=()

bool apollo::localization::msf::MapNodeIndex::operator!= ( const MapNodeIndex index) const

Overload the unequal operator.

◆ operator<()

bool apollo::localization::msf::MapNodeIndex::operator< ( const MapNodeIndex index) const

Overload the less than operator.

◆ operator==()

bool apollo::localization::msf::MapNodeIndex::operator== ( const MapNodeIndex index) const

Overload the equal operator.

◆ ToString()

std::string apollo::localization::msf::MapNodeIndex::ToString ( ) const

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  cout,
const MapNodeIndex index 
)
friend

Member Data Documentation

◆ m_

unsigned int apollo::localization::msf::MapNodeIndex::m_ = 0

The map node ID at the northing direction.

◆ n_

unsigned int apollo::localization::msf::MapNodeIndex::n_ = 0

The map node ID at the easting direction.

◆ resolution_id_

unsigned int apollo::localization::msf::MapNodeIndex::resolution_id_ = 0

The ID of the resolution. Should be less than BaseMapConfig::map_resolutions_.size().

◆ zone_id_

int apollo::localization::msf::MapNodeIndex::zone_id_ = 50

The zone ID. 1 - 60 and -1 - -60. The positive value is the zone at the north hemisphere.


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