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 (Index startIndex, Size size, BufferRegion::Quadrant quadrant)
BufferRegion::Quadrant	getQuadrant () const
const Size &	getSize () const
const Index &	getStartIndex () const
void	setQuadrant (BufferRegion::Quadrant type)
void	setSize (const Size &size)
void	setStartIndex (const Index &startIndex)
virtual	~BufferRegion ()=default

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	startIndex_
	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

Quadrant

enum grid_map::BufferRegion::Quadrant

strong

The definition of the buffer region positions.

Enumerator
Undefined
TopLeft
TopRight
BottomLeft
BottomRight

Definition at line 26 of file BufferRegion.hpp.

Constructor & Destructor Documentation

BufferRegion() [1/2]

grid_map::BufferRegion::BufferRegion

(

)

Definition at line 12 of file BufferRegion.cpp.

BufferRegion() [2/2]

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

Definition at line 18 of file BufferRegion.cpp.

~BufferRegion()

virtual grid_map::BufferRegion::~BufferRegion ( )

virtualdefault

Member Function Documentation

getQuadrant()

BufferRegion::Quadrant grid_map::BufferRegion::getQuadrant

(

)

const

Definition at line 44 of file BufferRegion.cpp.

getSize()

const Size & grid_map::BufferRegion::getSize

(

)

const

Definition at line 34 of file BufferRegion.cpp.

getStartIndex()

const Index & grid_map::BufferRegion::getStartIndex

(

)

const

Definition at line 24 of file BufferRegion.cpp.

setQuadrant()

void grid_map::BufferRegion::setQuadrant

(

BufferRegion::Quadrant

type

)

Definition at line 49 of file BufferRegion.cpp.

setSize()

void grid_map::BufferRegion::setSize

(

const Size &

size

)

Definition at line 39 of file BufferRegion.cpp.

setStartIndex()

void grid_map::BufferRegion::setStartIndex

(

const Index &

startIndex

)

Definition at line 29 of file BufferRegion.cpp.

Member Data Documentation

nQuadrants

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

static

Definition at line 35 of file BufferRegion.hpp.

quadrant_

Quadrant grid_map::BufferRegion::quadrant_

private

Quadrant type of the buffer region.

Definition at line 57 of file BufferRegion.hpp.

size_

Size grid_map::BufferRegion::size_

private

Size of the buffer region.

Definition at line 54 of file BufferRegion.hpp.

startIndex_

Index grid_map::BufferRegion::startIndex_

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:

• BufferRegion.hpp
• BufferRegion.cpp