| 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
TeQuerierParams Class Reference

A class responsible for defining the querier mechanism behavior. More...

`#include <TeQuerierParams.h>`

List of all members.

## Public Member Functions

| TeQuerierParams (bool loadGeom=false, bool loadAllAttr=true)
| Constructor.
| TeQuerierParams (bool loadGeom, const vector< string > &loadAttr)
| Constructor.
| TeQuerierParams (bool loadGeom, TeGroupingAttr &groupAttr)
| Constructor.
virtual | ~TeQuerierParams ()
| Destructor.
| TeQuerierParams (const TeQuerierParams &qp)
| Copy Constructor.
virtual TeQuerierParams & | operator= (const TeQuerierParams &rhs)
| Assignment operator.
virtual void | setParams (TeLayer *layer)
| Sets the layer that will be used as source of instances.
virtual void | setParams (TeTheme *theme, TeChronon chr=TeNOCHRONON)
| Sets the theme that will be used as source of instances and a chronon that defines the time frames.
virtual void | setParams (TeTheme *theme, const string &objId, TeChronon chr=TeNOCHRONON)
| Sets the theme that will be used as source of instances of a specific object and a chronon that defines the time frames.
virtual void | setParams (const string &fileName, TeChronon chr=TeNOCHRONON)
| Sets the file name that will be used as source of instances and a chronon that defines the time frames.
virtual void | setFillParams (bool loadGeom, bool loadAllAttr, vector< string > loadAttr=vector< string >())
| Sets the parameters used to fill the instances.
virtual void | setFillParams (bool loadGeom, TeGroupingAttr attrG)
| Sets the parameters used to fill the instances.
virtual void | setSpatialRest (TeBox &box, int relation=TeWITHIN, TeGeomRep rep=TeGEOMETRYNONE)
| Sets a spatial restriction (a spatial relation and a bounding box)
virtual void | setSpatialRest (TeGeometry *geom, int relation=TeWITHIN, TeGeomRep rep=TeGEOMETRYNONE)
| Sets a spatial restriction (a spatial relation and a geometry)
virtual void | setSelecetObjs (TeSelectedObjects so)
| Sets the selected objects.
virtual void | setLoadAttrs (const vector< string > &vec)
| Sets which attributes must be loaded.
virtual string | decName () const
| Returns the identification of the strategy associated to the querier.
virtual TeTheme * | theme ()
| Returns the source theme.
virtual TeLayer * | layer ()
| Returns the source layer.
virtual string | fileName ()
| Returns the source file name.
virtual TeBox & | box ()
| Returns the minimal bounding box.
virtual void | box (TeBox &b)
| Sets the minimal bounding box.
virtual TeChronon | chronon ()
| Returns the chronon used to create the time frames.
virtual string | objId ()
| Returns the object identification.
virtual TeGroupingAttr & | groupAttr ()
| Returns which attributes will be loaded and how they will be grouped.
virtual bool | loadGeom ()
| Returns if the querier must load the geometries.
virtual bool | loadAllAttr ()
| Returns if the querier must load all attributes.
virtual vector< string > & | loadAttrs ()
| Returns the subset of attributes that will be loaded.
virtual vector< string > & | loadSetedAttrs ()
| Internal function. Returns the subset of attributes that will be loaded.
virtual TeSelectedObjects | selectedObjs ()
| Returns which objects must be loaded.
virtual int | spatialRelation ()
| Returns the spatial relation.
virtual bool | hasSpatialRes ()
| Verifies if there is a spatial restriction defined.
virtual TeBox | boxRest ()
| Returns the bounding box associated to the spatial restriction.
virtual TeGeometry * | geomRest ()
| Returns the geometry associated to the spatial restriction.
virtual TeGeomRep | geomRepRest ()
| Returns which theme geometric representation must be considered by the spatial restriction.
virtual void | clear ()
| Clear querier params.

## Protected Attributes

bool | loadGeometries_
| if the querier must load the geometries of each instance
bool | loadAllAttributes_
| if the querier must load all attributes of each instance
vector< string > | loadAttrNames_
| which attributes the querier must load
vector< string > | loadAttrNamesSeted_
| internal structure
TeGroupingAttr | groupingAttr_
| which attributes will be load and which aggregate function will be used in each attribute
bool | themeFlag_
| if the theme is temporary
TeTheme * | theme_
| pointer to a source theme
TeLayer * | layer_
| pointer to a source layer
string | fileName_
| source file name (.shp, etc)
TeBox | box_
| minimal bounding box that contains all geometries returned by this querier
TeChronon | chr_
| chronon used to generate time frames
string | objId_
| object identification
string | strategy_
TeSelectedObjects | selectedObjs_
| querier strategy name
int | spatialRelation_
| spatial relation used by spatial restriction
bool | hasSpatialRes_
| Verifies if there is a spatial restriction defined.
TeBox | boxRest_
| A bounding box used by spatial restriction.
TeGeometry * | geomRest_
| A geometry pointer used by spatial restriction.
TeGeomRep | geomRepRest_
| geometric representation of the theme that will be considered by spatial restriction

## Detailed Description

A class responsible for defining the querier mechanism behavior.

This class contains a set of attributes that define the querier behavior, for example, which instances the querier will load or if the querier will load the geometries and which attributes. It is used in the querier constructor.

See also:
  TeQuerier

Examples:

  querierFromLayer.cpp, querierFromTheme.cpp, querierGroupChronon.cpp, querierGroupElement.cpp, querierGroupSpatialRest.cpp, querierWithSpatialRestBox.cpp, and querierWithSpatialRestGeometry.cpp.

## Constructor & Destructor Documentation

TeQuerierParams::TeQuerierParams | ( | bool | loadGeom = `false`,
|  | bool | loadAllAttr = `true`
| ) |  | `[inline]`

Constructor.

TeQuerierParams::TeQuerierParams | ( | bool | loadGeom,
|  | const vector< string > & | loadAttr
| ) |  | `[inline]`

Constructor.

TeQuerierParams::TeQuerierParams | ( | bool | loadGeom,
|  | TeGroupingAttr & | groupAttr
| ) |  | `[inline]`

Constructor.

TeQuerierParams::~TeQuerierParams | ( |  | ) | `[virtual]`

Destructor.

TeQuerierParams::TeQuerierParams | ( | const TeQuerierParams & | qp | ) |

Copy Constructor.

## Member Function Documentation

TeBox & TeQuerierParams::box | ( |  | ) | `[virtual]`

Returns the minimal bounding box.

virtual void TeQuerierParams::box | ( | TeBox & | b | ) | `[inline, virtual]`

Sets the minimal bounding box.

virtual TeBox TeQuerierParams::boxRest | ( |  | ) | `[inline, virtual]`

Returns the bounding box associated to the spatial restriction.

virtual TeChronon TeQuerierParams::chronon | ( |  | ) | `[inline, virtual]`

Returns the chronon used to create the time frames.

void TeQuerierParams::clear | ( | void |  | ) | `[virtual]`

Clear querier params.

virtual string TeQuerierParams::decName | ( |  | ) | const`[inline, virtual]`

Returns the identification of the strategy associated to the querier.

virtual string TeQuerierParams::fileName | ( |  | ) | `[inline, virtual]`

Returns the source file name.

virtual TeGeomRep TeQuerierParams::geomRepRest | ( |  | ) | `[inline, virtual]`

Returns which theme geometric representation must be considered by the spatial restriction.

virtual TeGeometry* TeQuerierParams::geomRest | ( |  | ) | `[inline, virtual]`

Returns the geometry associated to the spatial restriction.

virtual TeGroupingAttr& TeQuerierParams::groupAttr | ( |  | ) | `[inline, virtual]`

Returns which attributes will be loaded and how they will be grouped.

virtual bool TeQuerierParams::hasSpatialRes | ( |  | ) | `[inline, virtual]`

Verifies if there is a spatial restriction defined.

virtual TeLayer* TeQuerierParams::layer | ( |  | ) | `[inline, virtual]`

Returns the source layer.

virtual bool TeQuerierParams::loadAllAttr | ( |  | ) | `[inline, virtual]`

Returns if the querier must load all attributes.

virtual vector<string>& TeQuerierParams::loadAttrs | ( |  | ) | `[inline, virtual]`

Returns the subset of attributes that will be loaded.

virtual bool TeQuerierParams::loadGeom | ( |  | ) | `[inline, virtual]`

Returns if the querier must load the geometries.

virtual vector<string>& TeQuerierParams::loadSetedAttrs | ( |  | ) | `[inline, virtual]`

Internal function. Returns the subset of attributes that will be loaded.

virtual string TeQuerierParams::objId | ( |  | ) | `[inline, virtual]`

Returns the object identification.

TeQuerierParams & TeQuerierParams::operator= | ( | const TeQuerierParams & | rhs | ) | `[virtual]`

Assignment operator.

virtual TeSelectedObjects TeQuerierParams::selectedObjs | ( |  | ) | `[inline, virtual]`

Returns which objects must be loaded.

void TeQuerierParams::setFillParams | ( | bool | loadGeom,
|  | bool | loadAllAttr,
|  | vector< string > | loadAttr = `vector<string>()`
| ) |  | `[virtual]`

Sets the parameters used to fill the instances.

void TeQuerierParams::setFillParams | ( | bool | loadGeom,
|  | TeGroupingAttr | attrG
| ) |  | `[virtual]`

Sets the parameters used to fill the instances.

virtual void TeQuerierParams::setLoadAttrs | ( | const vector< string > & | vec | ) | `[inline, virtual]`

Sets which attributes must be loaded.

void TeQuerierParams::setParams | ( | TeTheme * | theme,
|  | TeChronon | chr = `TeNOCHRONON`
| ) |  | `[virtual]`

Sets the theme that will be used as source of instances and a chronon that defines the time frames.

void TeQuerierParams::setParams | ( | TeLayer * | layer | ) | `[virtual]`

Sets the layer that will be used as source of instances.

Examples:
  querierFromLayer.cpp, querierFromTheme.cpp, querierGroupChronon.cpp, querierGroupElement.cpp, querierGroupSpatialRest.cpp, querierWithSpatialRestBox.cpp, and querierWithSpatialRestGeometry.cpp.

void TeQuerierParams::setParams | ( | const string & | fileName,
|  | TeChronon | chr = `TeNOCHRONON`
| ) |  | `[virtual]`

Sets the file name that will be used as source of instances and a chronon that defines the time frames.

void TeQuerierParams::setParams | ( | TeTheme * | theme,
|  | const string & | objId,
|  | TeChronon | chr = `TeNOCHRONON`
| ) |  | `[virtual]`

Sets the theme that will be used as source of instances of a specific object and a chronon that defines the time frames.

virtual void TeQuerierParams::setSelecetObjs | ( | TeSelectedObjects | so | ) | `[inline, virtual]`

Sets the selected objects.

void TeQuerierParams::setSpatialRest | ( | TeGeometry * | geom,
|  | int | relation = `TeWITHIN`,
|  | TeGeomRep | rep = `TeGEOMETRYNONE`
| ) |  | `[virtual]`

Sets a spatial restriction (a spatial relation and a geometry)

void TeQuerierParams::setSpatialRest | ( | TeBox & | box,
|  | int | relation = `TeWITHIN`,
|  | TeGeomRep | rep = `TeGEOMETRYNONE`
| ) |  | `[virtual]`

Sets a spatial restriction (a spatial relation and a bounding box)

Examples:
  querierGroupSpatialRest.cpp, querierWithSpatialRestBox.cpp, and querierWithSpatialRestGeometry.cpp.

virtual int TeQuerierParams::spatialRelation | ( |  | ) | `[inline, virtual]`

Returns the spatial relation.

virtual TeTheme* TeQuerierParams::theme | ( |  | ) | `[inline, virtual]`

Returns the source theme.

## Member Data Documentation

TeBox TeQuerierParams::box_`[protected]`

minimal bounding box that contains all geometries returned by this querier

TeBox TeQuerierParams::boxRest_`[protected]`

A bounding box used by spatial restriction.

TeChronon TeQuerierParams::chr_`[protected]`

chronon used to generate time frames

string TeQuerierParams::fileName_`[protected]`

source file name (.shp, etc)

TeGeomRep TeQuerierParams::geomRepRest_`[protected]`

geometric representation of the theme that will be considered by spatial restriction

TeGeometry* TeQuerierParams::geomRest_`[protected]`

A geometry pointer used by spatial restriction.

TeGroupingAttr TeQuerierParams::groupingAttr_`[protected]`

which attributes will be load and which aggregate function will be used in each attribute

bool TeQuerierParams::hasSpatialRes_`[protected]`

Verifies if there is a spatial restriction defined.

TeLayer* TeQuerierParams::layer_`[protected]`

pointer to a source layer

bool TeQuerierParams::loadAllAttributes_`[protected]`

if the querier must load all attributes of each instance

vector<string> TeQuerierParams::loadAttrNames_`[protected]`

which attributes the querier must load

vector<string> TeQuerierParams::loadAttrNamesSeted_`[protected]`

internal structure

bool TeQuerierParams::loadGeometries_`[protected]`

if the querier must load the geometries of each instance

string TeQuerierParams::objId_`[protected]`

object identification

TeSelectedObjects TeQuerierParams::selectedObjs_`[protected]`

querier strategy name

if the querier must load only the instances pointed or queried

int TeQuerierParams::spatialRelation_`[protected]`

spatial relation used by spatial restriction

string TeQuerierParams::strategy_`[protected]`

TeTheme* TeQuerierParams::theme_`[protected]`

pointer to a source theme

bool TeQuerierParams::themeFlag_`[protected]`

if the theme is temporary

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeQuerierParams.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeQuerierParams.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines