fpmas::model::GridDimensions Class Reference

#include <grid_load_balancing.h>

Public Member Functions
	GridDimensions (DiscretePoint origin, DiscretePoint extent)
	GridDimensions ()
DiscretePoint	getOrigin () const
void	setOrigin (const DiscretePoint &point)
DiscretePoint	getExtent () const
void	setExtent (const DiscretePoint &point)
DiscreteCoordinate	width () const
DiscreteCoordinate	height () const

Detailed Description

Utility class used to describe the shape of a discrete grid.

A grid is described by its origin point and an extent until which the grid extents.

The origin is included in the grid, while the extent is not

For example, GridDimensions({0, 0}, {10, 10}) describes a grid where the bottom left corner is at (0, 0), and the top right corner is at (9, 9).

Constructor & Destructor Documentation

GridDimensions() [1/2]

fpmas::model::GridDimensions::GridDimensions ( DiscretePoint  origin, DiscretePoint  extent  )

inline

GridDimensions constructor.

Parameters

origin	origin point of the grid
extent	point to until which the grid extents

GridDimensions() [2/2]

fpmas::model::GridDimensions::GridDimensions ( )

inline

Default GridDimensions constructor.

Member Function Documentation

getOrigin()

DiscretePoint fpmas::model::GridDimensions::getOrigin ( ) const

inline

Origin of the grid.

setOrigin()

void fpmas::model::GridDimensions::setOrigin ( const DiscretePoint &  point )

inline

Sets the origin of the grid.

getExtent()

DiscretePoint fpmas::model::GridDimensions::getExtent ( ) const

inline

Extent of the grid.

setExtent()

void fpmas::model::GridDimensions::setExtent ( const DiscretePoint &  point )

inline

Sets the extent of the grid.

width()

DiscreteCoordinate fpmas::model::GridDimensions::width ( ) const

inline

Returns the width of the grid, i.e. the count of cells contained in the grid width.

height()

DiscreteCoordinate fpmas::model::GridDimensions::height ( ) const

inline

Returns the height of the grid, i.e. the count of cells contained in the grid height.

---

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

• src/fpmas/model/spatial/grid_load_balancing.h