dp3::parmdb::GridRep Class Reference

The letter class for a 2-D grid with regular or irregular axes. More...

#include <Grid.h>

Public Types
typedef std::shared_ptr< GridRep >	ShPtr

Public Member Functions
	GridRep ()
	Default constructor uses two default RegularAxis objects. More...
	GridRep (Axis::ShPtr first, Axis::ShPtr second)
	Create from given axes. More...
	GridRep (const std::vector< Box > &domains, bool sort)
	GridRep (const std::vector< Grid > &domains, bool sort)
bool	isDefault () const
	Is it the default grid? More...
Axis::ShPtr &	getAxis (size_t n)
const Axis::ShPtr &	getAxis (size_t n) const

Detailed Description

The letter class for a 2-D grid with regular or irregular axes.

Member Typedef Documentation

ShPtr

typedef std::shared_ptr<GridRep> dp3::parmdb::GridRep::ShPtr

Constructor & Destructor Documentation

GridRep() [1/4]

dp3::parmdb::GridRep::GridRep

(

)

Default constructor uses two default RegularAxis objects.

GridRep() [2/4]

dp3::parmdb::GridRep::GridRep	(	Axis::ShPtr	first,
		Axis::ShPtr	second
	)

Create from given axes.

GridRep() [3/4]

dp3::parmdb::GridRep::GridRep	(	const std::vector< Grid > &	domains,
		bool	sort
	)

Create a grid from a series of grids. They have to be in order of startY,startX. They are sorted if needed. The grids in the vector must span a rectangular grid, otherwise an exception is thrown. Its axes can be regular (RegularAxis) or irregular (OrderedAxis). The vector can be empty. In that case a default Grid is created.

GridRep() [4/4]

dp3::parmdb::GridRep::GridRep	(	const std::vector< Box > &	domains,
		bool	sort
	)

Create a grid from a series of domains. They have to be in order of startY,startX. They are sorted if needed. The domains in the vector must span a rectangular grid, otherwise an exception is thrown. Its axes can be regular (RegularAxis) or irregular (OrderedAxis). The vector can be empty. In that case a default Grid is created.

Member Function Documentation

getAxis() [1/2]

Axis::ShPtr& dp3::parmdb::GridRep::getAxis ( size_t  n )

inline

Get the given axis.

getAxis() [2/2]

const Axis::ShPtr& dp3::parmdb::GridRep::getAxis ( size_t  n ) const

inline

isDefault()

bool dp3::parmdb::GridRep::isDefault ( ) const

inline

Is it the default grid?

---

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

• Grid.h