Public Member Functions | Public Attributes | List of all members
nav_grid::GenericIndex< NumericType > Class Template Reference

A simple pair of x/y coordinates. More...

#include <index.h>

Public Member Functions

 GenericIndex (const NumericType &x=0, const NumericType &y=0)
 
bool operator!= (const GenericIndex &other) const
 
bool operator< (const GenericIndex &other) const
 less than operator so object can be used in sets More...
 
bool operator<= (const GenericIndex &other) const
 
bool operator== (const GenericIndex &other) const
 comparison operator that requires equal x and y More...
 
bool operator> (const GenericIndex &other) const
 
bool operator>= (const GenericIndex &other) const
 
std::string toString () const
 String representation of this object. More...
 

Public Attributes

NumericType x
 
NumericType y
 

Detailed Description

template<typename NumericType>
class nav_grid::GenericIndex< NumericType >

A simple pair of x/y coordinates.

Definition at line 47 of file index.h.

Constructor & Destructor Documentation

◆ GenericIndex()

template<typename NumericType >
nav_grid::GenericIndex< NumericType >::GenericIndex ( const NumericType &  x = 0,
const NumericType &  y = 0 
)
inlineexplicit

Definition at line 50 of file index.h.

Member Function Documentation

◆ operator!=()

template<typename NumericType >
bool nav_grid::GenericIndex< NumericType >::operator!= ( const GenericIndex< NumericType > &  other) const
inline

Definition at line 60 of file index.h.

◆ operator<()

template<typename NumericType >
bool nav_grid::GenericIndex< NumericType >::operator< ( const GenericIndex< NumericType > &  other) const
inline

less than operator so object can be used in sets

Definition at line 68 of file index.h.

◆ operator<=()

template<typename NumericType >
bool nav_grid::GenericIndex< NumericType >::operator<= ( const GenericIndex< NumericType > &  other) const
inline

Definition at line 75 of file index.h.

◆ operator==()

template<typename NumericType >
bool nav_grid::GenericIndex< NumericType >::operator== ( const GenericIndex< NumericType > &  other) const
inline

comparison operator that requires equal x and y

Definition at line 55 of file index.h.

◆ operator>()

template<typename NumericType >
bool nav_grid::GenericIndex< NumericType >::operator> ( const GenericIndex< NumericType > &  other) const
inline

Definition at line 74 of file index.h.

◆ operator>=()

template<typename NumericType >
bool nav_grid::GenericIndex< NumericType >::operator>= ( const GenericIndex< NumericType > &  other) const
inline

Definition at line 76 of file index.h.

◆ toString()

template<typename NumericType >
std::string nav_grid::GenericIndex< NumericType >::toString ( ) const
inline

String representation of this object.

Definition at line 81 of file index.h.

Member Data Documentation

◆ x

template<typename NumericType >
NumericType nav_grid::GenericIndex< NumericType >::x

Definition at line 49 of file index.h.

◆ y

template<typename NumericType >
NumericType nav_grid::GenericIndex< NumericType >::y

Definition at line 49 of file index.h.


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


nav_grid
Author(s):
autogenerated on Mon Feb 28 2022 23:32:36