Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
grid_map::BufferRegion Class Reference

#include <BufferRegion.hpp>

Public Types

enum  Quadrant {
  Quadrant::Undefined, Quadrant::TopLeft, Quadrant::TopRight, Quadrant::BottomLeft,
  Quadrant::BottomRight
}
 

Public Member Functions

 BufferRegion ()
 
 BufferRegion (const Index &startIndex, const Size &size, const BufferRegion::Quadrant &quadrant)
 
BufferRegion::Quadrant getQuadrant () const
 
const SizegetSize () const
 
const IndexgetStartIndex () const
 
void setQuadrant (BufferRegion::Quadrant type)
 
void setSize (const Size &size)
 
void setStartIndex (const Index &startIndex)
 
virtual ~BufferRegion ()
 

Static Public Attributes

static constexpr unsigned int nQuadrants = 4
 

Private Attributes

Quadrant quadrant_
 Quadrant type of the buffer region. More...
 
Size size_
 Size of the buffer region. More...
 
Index staretIndex_
 Start index (typically top-left) of the buffer region. More...
 

Detailed Description

This class holds information about a rectangular region of cells of the circular buffer.

Definition at line 19 of file BufferRegion.hpp.

Member Enumeration Documentation

The definition of the buffer region positions.

Enumerator
Undefined 
TopLeft 
TopRight 
BottomLeft 
BottomRight 

Definition at line 26 of file BufferRegion.hpp.

Constructor & Destructor Documentation

grid_map::BufferRegion::BufferRegion ( )

Definition at line 12 of file BufferRegion.cpp.

grid_map::BufferRegion::BufferRegion ( const Index startIndex,
const Size size,
const BufferRegion::Quadrant quadrant 
)

Definition at line 19 of file BufferRegion.cpp.

grid_map::BufferRegion::~BufferRegion ( )
virtual

Definition at line 26 of file BufferRegion.cpp.

Member Function Documentation

BufferRegion::Quadrant grid_map::BufferRegion::getQuadrant ( ) const

Definition at line 50 of file BufferRegion.cpp.

const Size & grid_map::BufferRegion::getSize ( ) const

Definition at line 40 of file BufferRegion.cpp.

const Index & grid_map::BufferRegion::getStartIndex ( ) const

Definition at line 30 of file BufferRegion.cpp.

void grid_map::BufferRegion::setQuadrant ( BufferRegion::Quadrant  type)

Definition at line 55 of file BufferRegion.cpp.

void grid_map::BufferRegion::setSize ( const Size size)

Definition at line 45 of file BufferRegion.cpp.

void grid_map::BufferRegion::setStartIndex ( const Index startIndex)

Definition at line 35 of file BufferRegion.cpp.

Member Data Documentation

constexpr unsigned int grid_map::BufferRegion::nQuadrants = 4
static

Definition at line 35 of file BufferRegion.hpp.

Quadrant grid_map::BufferRegion::quadrant_
private

Quadrant type of the buffer region.

Definition at line 57 of file BufferRegion.hpp.

Size grid_map::BufferRegion::size_
private

Size of the buffer region.

Definition at line 54 of file BufferRegion.hpp.

Index grid_map::BufferRegion::staretIndex_
private

Start index (typically top-left) of the buffer region.

Definition at line 51 of file BufferRegion.hpp.


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


grid_map_core
Author(s): P├ęter Fankhauser
autogenerated on Sat Aug 1 2020 05:51:35