| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Attributes
TeCoverageParams Class Reference

A class to handle the parameters set associated with a coverage. More...

`#include <TeCoverageParams.h>`

List of all members.

## Public Member Functions

| TeCoverageParams ()
| Default constructor.
| TeCoverageParams (TeDatabase *database, const int layerId, const std::string &coverageId="0")
| Constructor specifying database access.
| TeCoverageParams (const TeCoverageParams &other)
| Copy constructor.
TeCoverageParams & | operator= (const TeCoverageParams &rhs)
| Operator=.
virtual | ~TeCoverageParams ()
| Destructor.
void | setDatabase (TeDatabase *database)
| Set pointer to the database.
TeDatabase * | getDatabase () const
| Return a pointer to the database.
void | setLayerId (const int layerId)
| Set layer identifier.
int | getLayerId () const
| Return the layer identifier.
void | setCoverageId (std::string &coverageId)
| Set coverage identifier.
std::string | getCoverageId () const
| Return the coverage identifier.
void | setCoverageTable (std::string &coverageTable)
| Set the name of the coverage table.
std::string | getCoverageTable () const
| Return the name of the coverage table.
void | setFileName (std::string &fileName)
| Set the name of the coverage source file.
std::string | getFileName () const
| Return the name of the coverage source file.
void | setDimensions (std::vector< TeCoverageDimension > &dimensions)
| Set information about the dimensions of a coverage.
std::vector< TeCoverageDimension > | getDimensions () const
| Return information about the dimensions of a coverage.
void | setProjection (TeProjection *projection)
| Set the projection.
TeProjection * | getProjection () const
| Return the projection.
void | setBoundingBox (TeBox &boundingBox)
| Set bounding box of a coverage.
TeBox | getBoundingBox () const
| Return the bounding box of a coverage.
void | setNumElements (const int numElements)
| Set number of elements of a coverage.
int | getNumElements () const
| Return the number of elements of a coverage.
void | setPersistenceType (const TeCoveragePersistenceType persistenceType)
| Set persistence type of the coverage.
TeCoveragePersistenceType | getPersistenceType () const
| Return the persistence type of the coverage.

## Protected Attributes

TeDatabase * | database_
| Pointer to the TerraLib database.
int | layerId_
| Layer identifier.
std::string | coverageId_
| Coverage identifier.
std::string | coverageTable_
| Coverage table name.
std::string | fileName_
| Name of a coverage source file.
std::vector< TeCoverageDimension > | dimensions_
| Dimensions information.
TeProjection * | projection_
| Projection used in a coverage.
TeBox | boundingBox_
| Bounding box for all elements of a coverage.
int | numElements_
| Number of elements of the coverage.
TeCoveragePersistenceType | persistenceType_
| Type of data persistence.

## Detailed Description

A class to handle the parameters set associated with a coverage.

This class is a data structure to store and manipulate a set of
  parameters and definitions that characterizes a coverage. It contains parameters relative to storaging, geographical or interpretation aspects.

Not all parameters are valid, or make sense, for all coverages. Private
  parameters should be accessed through the methods provided.

## Constructor & Destructor Documentation

TeCoverageParams::TeCoverageParams | ( |  | ) | `[inline]`

Default constructor.

TeCoverageParams::TeCoverageParams | ( | TeDatabase * | database,
|  | const int | layerId,
|  | const std::string & | coverageId = `"0"`
| ) |  | `[inline]`

Constructor specifying database access.

TeCoverageParams::TeCoverageParams | ( | const TeCoverageParams & | other | ) |

Copy constructor.

virtual TeCoverageParams::~TeCoverageParams | ( |  | ) | `[inline, virtual]`

Destructor.

## Member Function Documentation

TeBox TeCoverageParams::getBoundingBox | ( |  | ) | const`[inline]`

Return the bounding box of a coverage.

std::string TeCoverageParams::getCoverageId | ( |  | ) | const`[inline]`

Return the coverage identifier.

std::string TeCoverageParams::getCoverageTable | ( |  | ) | const`[inline]`

Return the name of the coverage table.

TeDatabase* TeCoverageParams::getDatabase | ( |  | ) | const`[inline]`

Return a pointer to the database.

std::vector<TeCoverageDimension> TeCoverageParams::getDimensions | ( |  | ) | const`[inline]`

Return information about the dimensions of a coverage.

std::string TeCoverageParams::getFileName | ( |  | ) | const`[inline]`

Return the name of the coverage source file.

int TeCoverageParams::getLayerId | ( |  | ) | const`[inline]`

Return the layer identifier.

int TeCoverageParams::getNumElements | ( |  | ) | const`[inline]`

Return the number of elements of a coverage.

TeCoveragePersistenceType TeCoverageParams::getPersistenceType | ( |  | ) | const`[inline]`

Return the persistence type of the coverage.

TeProjection* TeCoverageParams::getProjection | ( |  | ) | const`[inline]`

Return the projection.

TeCoverageParams& TeCoverageParams::operator= | ( | const TeCoverageParams & | rhs | ) |

Operator=.

void TeCoverageParams::setBoundingBox | ( | TeBox & | boundingBox | ) | `[inline]`

Set bounding box of a coverage.

void TeCoverageParams::setCoverageId | ( | std::string & | coverageId | ) | `[inline]`

Set coverage identifier.

void TeCoverageParams::setCoverageTable | ( | std::string & | coverageTable | ) | `[inline]`

Set the name of the coverage table.

void TeCoverageParams::setDatabase | ( | TeDatabase * | database | ) | `[inline]`

Set pointer to the database.

void TeCoverageParams::setDimensions | ( | std::vector< TeCoverageDimension > & | dimensions | ) | `[inline]`

Set information about the dimensions of a coverage.

void TeCoverageParams::setFileName | ( | std::string & | fileName | ) | `[inline]`

Set the name of the coverage source file.

void TeCoverageParams::setLayerId | ( | const int | layerId | ) | `[inline]`

Set layer identifier.

void TeCoverageParams::setNumElements | ( | const int | numElements | ) | `[inline]`

Set number of elements of a coverage.

void TeCoverageParams::setPersistenceType | ( | const TeCoveragePersistenceType | persistenceType | ) | `[inline]`

Set persistence type of the coverage.

void TeCoverageParams::setProjection | ( | TeProjection * | projection | ) | `[inline]`

Set the projection.

## Member Data Documentation

TeBox TeCoverageParams::boundingBox_`[protected]`

Bounding box for all elements of a coverage.

std::string TeCoverageParams::coverageId_`[protected]`

Coverage identifier.

std::string TeCoverageParams::coverageTable_`[protected]`

Coverage table name.

TeDatabase* TeCoverageParams::database_`[protected]`

Pointer to the TerraLib database.

std::vector<TeCoverageDimension> TeCoverageParams::dimensions_`[protected]`

Dimensions information.

std::string TeCoverageParams::fileName_`[protected]`

Name of a coverage source file.

int TeCoverageParams::layerId_`[protected]`

Layer identifier.

int TeCoverageParams::numElements_`[protected]`

Number of elements of the coverage.

TeCoveragePersistenceType TeCoverageParams::persistenceType_`[protected]`

Type of data persistence.

TeProjection* TeCoverageParams::projection_`[protected]`

Projection used in a coverage.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeCoverageParams.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines