| TerraLib 4.1

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

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

Public Member Functions | Protected Member Functions | Protected Attributes | Friends
TeAbstractTheme Class Reference

An abstract theme class. More...

`#include <TeAbstractTheme.h>`

Inheritance diagram for TeAbstractTheme:

List of all members.

## Public Member Functions

short | temporaryVisibility (void)
| return the temporary state of theme
void | temporaryVisibility (short state)
| set the temporary state of theme
void | temporaryRepresentation (int rep)
| Set the visible temporary representation.
int | temporaryRepresentation (void)
| Return the visible temporary representation.
| TeAbstractTheme (const string &name, TeViewNode *parent, const int &view, const int &id, const TeViewNodeType &nodeType)
| Constructor.
| TeAbstractTheme (const TeViewNodeParams &params)
| Constructor.
| TeAbstractTheme (const TeAbstractTheme &other)
| Copy constructor.
virtual | ~TeAbstractTheme ()
| Destructor.
TeAbstractTheme & | operator= (const TeAbstractTheme &other)
| Assignment operator.
virtual void | setParent (TeViewNode *)
| Sets the parent node. The abstract theme does not have parent node.
virtual bool | operator< (const TeAbstractTheme &r) const
| Returns TRUE if a theme has lower priority than another.
virtual void | clearObjectSet ()
| Clear the set containing the objects of the theme.
virtual int | getNumLayerObjects ()
| Return the number of objects of the layer.
virtual map< string, int > & | getObjStatusMap ()
| Return the map containing the status of the objects.
virtual void | clearObjStatus ()
| Set the status of the objects to the default state.
virtual void | clearItemStatus ()
| Set the status of the items to the default state.
virtual map< string, int > & | getItemStatusMap ()
| Return the map containing the status of the items.
virtual void | setStatus (vector< string > &oidVec, vector< string > &itemVec, int status)
| the status
virtual void | setStatusForItemsToggled (set< string > &oidSet, vector< string > &itemVec)
| the status for the items that were toggled
virtual void | setStatusForObjectToggled (string oid)
| Set the status for the objects that were toggled.
virtual void | setStatusForNewObjectsPointed (set< string > &oidSet)
| Set the status for the new set of objects that were pointed.
virtual void | setStatusForObjectsAddedByPointing (set< string > &oidSet)
| Set the status for the additional set of objects that were pointed.
virtual void | setStatusForNewItemsPointed (vector< string > &itemVec)
| Set the status for the new set of items that were pointed.
virtual void | setStatusForItemsAddedByPointing (vector< string > &itemVec)
| Set the status for the additional set of items that were pointed.
virtual void | setStatusForNewItemsQueried (set< string > &oidSet, vector< string > &uidVec)
| Set the status for the new set of items that were queried.
virtual void | setStatusForItemsAddedByQuerying (set< string > &oidSet, vector< string > &uidVec)
| Set the status for the additional set of items that were queried.
virtual void | setStatusForItemsFilteredByQuerying (set< string > &oidSet, vector< string > &uidVec)
| Set the status for the set of items that were filtered by a query operation.
virtual void | removePointingColor ()
| Remove the pointing color.
virtual void | removeQueryColor ()
| Remove the query color.
virtual void | invertObjectStatus ()
| Invert the pointing status of the objects.
virtual void | setObjectsToDefaultStatus ()
| Set the objects to the default status.
virtual TeTime | getCreationTime () const
| Gets the creation time of the theme.
virtual void | setCreationTime (const TeTime &creationTime)
| Sets in memory the creation time of the theme.
virtual bool | updateThemeCreationTime (TeDatabase *database)
| Updates the creation in memory and in the database.
virtual bool | isUpdated ()
| Checks if the theme is update. If FALSE, the theme may be not be updated.
virtual bool | save ()=0
| Save the theme parameters.
virtual bool | buildGrouping (const TeGrouping &g, TeSelectedObjects selectedObjects=TeAll, vector< double > *dValuesVec=0)=0
| Save the grouping parameters in memory when there is no chronon.
virtual bool | buildGrouping (const TeGrouping &g, TeChronon chr, vector< map< string, string > > &mapObjValVec)=0
| Save the grouping parameters in memory when there is chronon.
virtual bool | saveGrouping (TeSelectedObjects selectedObjects=TeAll)=0
| Build the grouping and associate each object to its group.
virtual bool | deleteGrouping ()=0
| Delete grouping.
virtual void | setLegendsForObjects ()=0
| Set the legend id for each object of the theme.
virtual void | setOwnLegendsForObjects ()=0
| Set the own legend id for each object of the theme.
virtual set< string > | getObjects (TeSelectedObjects selectedObjects=TeAll)=0
| Get the set of objects corresponding to the object selection criteria.
virtual set< string > | getObjects (const vector< string > &itemVec)=0
| Get the set of objects corresponding to the list of items.
virtual vector< string > | getItemVector (TeSelectedObjects selectedObjects)=0
| Get the set of items corresponding to the object selection criteria.
virtual vector< string > | getItemVector (const set< string > &oidSet)=0
| Get the set of items corresponding to the set of objects.
virtual unsigned int | getNumberOfObjects ()=0
| Get the number of objects acessible by this theme.
virtual bool | saveMetadata (TeDatabase *)=0
| Save (insert or update) the theme metadata in the database.
TeAbstractTheme * | copyTo (TeDatabase *outputDatabase, TeView *view, const std::string &renameTo="", const int &orderIndex=-1)
| Copies the theme to the given database, inside the given view and with the (optionall) given new name.
virtual bool | loadMetadata (TeDatabase *)=0
| Load the theme metadata from database.
Scale
Methods related to the range of scales where this theme should be visible
virtual TeProjection * | getThemeProjection ()=0
| Returns a pointer to a projection that is the spatial reference for the objects of this theme.
virtual double | minScale ()
| Returns the minimum scale in which the theme is visible.
virtual void | minScale (double s)
| Sets the minimum scale in which the theme is visible.
virtual double | maxScale ()
| Returns the maximum scale in which the theme is visible.
virtual void | maxScale (double s)
| Sets the maximum scale in which the theme is visible.
Restrictions
Methods related to the restrictions over the theme used to generate this theme
virtual bool | hasRestriction ()
| Verifies if this theme has any kind of restrictions.
virtual string | attributeRest ()
| Returns the attribute restriction (where clause) used to generate the theme.
virtual void | attributeRest (const string &s)
| Sets the attribute restriction (where clause) used to generate the theme.
virtual bool | hasAttrRest ()
| Returns if there is an attribute restriction.
virtual string | temporalRest ()
| Returns the temporal restriction used to generate the theme.
virtual void | temporalRest (const string &t)
| Sets the temporal restriction used to generate the theme.
virtual bool | hasTemporalRest ()
| Returns TRUE if there is a temporal restriction defined in the theme.
virtual string | spatialRest ()
| Returns the spatial restriction used to generate the theme.
virtual void | spatialRest (const string &s)
| Sets the spatial restriction used to generate the theme.
virtual TeSpatialRelation | spatialRelation ()
| Returns the spatial relation (e.g WITHIN, COVERED BY, etc.) associate to the spatial restriction.
virtual void | spatialRelation (TeSpatialRelation s)
| Sets the spatial relation (e.g WITHIN, COVERED BY, etc.) associate to the spatial restriction.
virtual bool | hasSpatialRest ()
| Returns TRUE if this theme has a spatial restriction.
virtual void | hasSpatialRest (bool a)
| Sets the flag that indicates that there is a spatial restriction.
virtual TeBox | boxRestriction ()
| Returns the box associated with the spatial restriction.
virtual void | boxRestriction (TeBox &b)
| Sets the box associated with the spatial restriction.
virtual TeGeometry * | geomRestriction ()
| Returns a pointer to the geometry associated with the spatial restriction.
virtual void | geomRestriction (TeGeometry *g)
| Sets a pointer to the geometry associated with the spatial restriction.
virtual TeGeomRep | geomRepRestriction ()
| Returns the geometry representation of the theme which will be considered in the spatial restriction.
virtual void | geomRepRestriction (TeGeomRep &rep)
| Sets the geometry representation of the theme which will be considered in the spatial restriction.
virtual void | setSpatialRest (TeBox &box, TeGeomRep rep, TeSpatialRelation relation=TeWITHIN)
| Sets the spatial restriction to be a spatial relation with a box.
virtual void | setSpatialRest (TeGeometry *geom, TeGeomRep rep, TeSpatialRelation relation=TeWITHIN)
| Sets the spatial restriction to be a spatial relation with a geometry.
Visibility/Status
Methods related to the visibility/status of the theme and its components: graphs, geometrical representations of the objects, grouping.
virtual void | visibleRep (int rep)
| Sets the components or representations of the theme that are visible.
virtual int | visibleRep ()
| Returns the components or representations of the theme that are visible.
virtual int | visibleGeoRep ()
| Returns the geometrical representations of the theme that are visible.
virtual void | setAvailability (const bool &avaiability)
const bool & | isAvailable () const
bool | isEditable () const
void | setEditable (const bool &editable)
virtual int | visibility ()
| Returns a status of a theme.
virtual void | visibility (int v)
| Sets whether the theme should be visible and/or active.
Grouping
Methods related to grouping of objects of the theme. Each group is represented by a specific presentation visual called legend. An slice represents the range of values of an attribute that characterizes a group.
virtual TeGrouping & | grouping ()
| Returns a grouping associated the theme.
virtual void | grouping (const TeGrouping &g)
| Sets a grouping associated to the theme.
virtual TeLegendEntryVector & | legend ()
| Returns the vector of legends of the theme.
virtual bool | setGroupingVisual (int n, TeVisual *visual, TeGeomRep rep)
| Sets the visual associated to a geometric representation in the n-th group of the theme.
virtual bool | setGroupingVisual (int n, TeGeomRepVisualMap &vismap)
| Sets the visual of the n-th group of the theme.
virtual void | resetGrouping ()
| Clear the existing grouping of objects of this theme.
virtual void | cleanLegend ()
| Clear the vector of legends.
virtual bool | buildGrouping (const TeGrouping &g, vector< TeSlice > &slices)
| Save grouping parameters in memory passing an arbitrary set of slices.
virtual TeSliceVector | getSlices ()
| Returns the slices associated to the grouping of the theme.
Legends
Legends are also used to define presentation characteristics of the objets of the theme that aren't grouped, according to some specific characteristics (such as being pointed, being queried, among others).
virtual void | defaultLegend (TeLegendEntry &leg)
| Sets a default legend of the objects of the theme.
virtual TeLegendEntry & | defaultLegend ()
| Returns the default legend of the objects of the theme.
virtual void | setVisualDefault (TeVisual *visual, TeGeomRep rep)
| Sets the visual of the default legend for a specific geometrical representation.
virtual void | outOfCollectionLegend (TeLegendEntry &leg)
| Sets a legend for objects of the layer that weren't selected in this theme.
virtual TeLegendEntry & | outOfCollectionLegend ()
| Returns the legend of the layer objects that are not selected in this layer.
virtual void | setVisualOutOfCollection (TeVisual *visual, TeGeomRep rep)
| Sets the visual of the non-selected objects legend for a specific geometrical representation.
virtual void | withoutDataConnectionLegend (TeLegendEntry &leg)
| Sets a legend for objects that have geometries but not descriptive attributes.
virtual TeLegendEntry & | withoutDataConnectionLegend ()
| Returns the legend of objects that have geometries but not descriptive attributes.
virtual void | setVisualWithoutDataConnection (TeVisual *visual, TeGeomRep rep)
| Sets the visual of the without-attributes objects legend for a specific geometrical representation.
virtual void | pointingLegend (TeLegendEntry &leg)
| Sets a legend for the theme objects selected by pointing.
virtual TeLegendEntry & | pointingLegend ()
| Returns the legend of the theme objects selected by pointing.
virtual void | setVisualPointing (TeVisual *visual, TeGeomRep rep)
| Sets the visual of the pointed objects legend for a specific geometrical representation.
virtual void | queryLegend (TeLegendEntry &leg)
| Sets a legend for the theme objects selected by a query.
virtual TeLegendEntry & | queryLegend ()
| Returns the legend of the theme objects selected by a query.
virtual void | setVisualQuery (TeVisual *visual, TeGeomRep rep)
| Sets the visual of the queried objects legend for a specific geometrical representation.
virtual void | queryAndPointingLegend (TeLegendEntry &leg)
| Sets a legend for the theme objects selected by query and pointing.
virtual TeLegendEntry & | queryAndPointingLegend ()
| Returns the legend of the theme objects selected by query and pointing.
virtual map< string, int > & | getObjLegendMap ()
| Returns the map of legend ids associated to each object.
virtual map< string, int > & | getObjOwnLegendMap ()
| Returns the map of legend ids associated to each object.
virtual void | setVisualQueryAndPointing (TeVisual *visual, TeGeomRep rep)
| Sets the visual of the queried and pointed objects legend for a specific geometrical representation.
virtual void | legend (TeLegendEntry &leg)
| Sets a legend for the theme objects.
Raster Visual
Methods to deal with the visual presentation of the raster representations
virtual TeRasterTransform * | rasterVisual ()
| Returns the visual presentation of raster geometry.
virtual void | rasterVisual (TeRasterTransform *r)
| Sets the visual presentation of raster geometry.
virtual void | removeRasterVisual ()
| Removes the visual presentation of the raster.
virtual void | createRasterVisual (TeRaster *rst=0)
| Creates an appropriate visual presentation to the raster of the theme.
Box
Methods related to the bounding box of a theme
virtual TeBox & | getThemeBox ()
| Returns the theme box.
virtual void | setThemeBox (const TeBox &box)
| Sets the theme box.
virtual TeBox & | box ()
| Returns the theme box.
Locate geometries
Returns the geometry(ies) of the theme given coordinate
virtual bool | locatePolygon (TeCoord2D &pt, TePolygon &polygon, const double &tol=0.0)=0
virtual bool | locatePolygonSet (TeCoord2D &pt, double tol, TePolygonSet &polygons)=0
virtual bool | locateLine (TeCoord2D &pt, TeLine2D &line, const double &tol=0.0)=0
virtual bool | locatePoint (TeCoord2D &pt, TePoint &point, const double &tol=0.0)=0
virtual bool | locateCell (TeCoord2D &pt, TeCell &c, const double &tol=0.0)=0

## Protected Member Functions

virtual bool | eraseMetadata (TeDatabase *)=0
| Erase the theme metadata in the database.
virtual bool | beforeCopyThemeTo (TeAbstractTheme *absThemeCopy, TeDatabase *outputDatabase)
| Should be reimplemented to set all the parameters and pre-requisites necessaries to copy a theme to the given database. This method will be called before the theme is saved in the database.
virtual bool | afterCopyThemeTo (TeAbstractTheme *absThemeCopy, TeDatabase *outputDatabase)
| Should be reimplemented if some functions for the theme copy need to be done after the theme was saved on its new location. This method will be called after the theme is saved in the database.

## Protected Attributes

short | temporaryVisibility_
int | temporaryRepresentation_
string | generateAttributeRest_
string | generateTemporalRest_
string | generateSpatialRest_
TeSpatialRelation | spatialRelation_
bool | hasSpatialRes_
TeBox | boxRest_
TeGeometry * | geomRest_
TeGeomRep | geomRepRest_
double | minScale_
double | maxScale_
int | visibleRep_
int | enableVisibility_
TeGrouping | grouping_
TeLegendEntryVector | legend_
TeLegendEntry | outOfCollectionLegend_
TeLegendEntry | withoutDataConnectionLegend_
TeLegendEntry | defaultLegend_
TeLegendEntry | pointingLegend_
TeLegendEntry | queryLegend_
TeLegendEntry | queryAndPointingLegend_
map< string, int > | objLegendMap_
map< string, int > | objOwnLegendMap_
TeRasterTransform * | rasterVisual_
| visual of raster
bool | isAvailable_
| Theme source can be accessed.
bool | isEditable_
| Theme can be edited.
TeBox | themeBox_
set< string > | objectSet_
| A set containing the theme objects.
int | numLayerObjects_
| Number of objects of the layer.
map< string, int > | itemStatusMap_
| Status of the item (concatenation of the unique names of each theme table)
map< string, int > | objStatusMap_
| Status of the object.
TeTime | creationTime_
| Stores the creation time of the theme.

## Friends

class | TeDatabase

## Detailed Description

An abstract theme class.

Examples:

  rasterSlicing.cpp.

## Constructor & Destructor Documentation

TeAbstractTheme::TeAbstractTheme | ( | const string & | name,
|  | TeViewNode * | parent,
|  | const int & | view,
|  | const int & | id,
|  | const TeViewNodeType & | nodeType
| ) |  |

Constructor.

TeAbstractTheme::TeAbstractTheme | ( | const TeViewNodeParams & | params | ) |

Constructor.

TeAbstractTheme::TeAbstractTheme | ( | const TeAbstractTheme & | other | ) |

Copy constructor.

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

Destructor.

## Member Function Documentation

bool TeAbstractTheme::afterCopyThemeTo | ( | TeAbstractTheme * | absThemeCopy,
|  | TeDatabase * | outputDatabase
| ) |  | `[protected, virtual]`

Should be reimplemented if some functions for the theme copy need to be done after the theme was saved on its new location. This method will be called after the theme is saved in the database.

Reimplemented in TeTheme.

virtual string TeAbstractTheme::attributeRest | ( |  | ) | `[inline, virtual]`

Returns the attribute restriction (where clause) used to generate the theme.

Examples:
  createSTElementSetFromTheme.cpp, and createTheme.cpp.

virtual void TeAbstractTheme::attributeRest | ( | const string & | s | ) | `[inline, virtual]`

Sets the attribute restriction (where clause) used to generate the theme.

bool TeAbstractTheme::beforeCopyThemeTo | ( | TeAbstractTheme * | absThemeCopy,
|  | TeDatabase * | outputDatabase
| ) |  | `[protected, virtual]`

Should be reimplemented to set all the parameters and pre-requisites necessaries to copy a theme to the given database. This method will be called before the theme is saved in the database.

Reimplemented in TeExternalTheme, TeFileTheme, and TeTheme.

virtual TeBox& TeAbstractTheme::box | ( |  | ) | `[inline, virtual]`

Returns the theme box.

virtual TeBox TeAbstractTheme::boxRestriction | ( |  | ) | `[inline, virtual]`

Returns the box associated with the spatial restriction.

virtual void TeAbstractTheme::boxRestriction | ( | TeBox & | b | ) | `[inline, virtual]`

Sets the box associated with the spatial restriction.

bool TeAbstractTheme::buildGrouping | ( | const TeGrouping & | g,
|  | vector< TeSlice > & | slices
| ) |  | `[virtual]`

Save grouping parameters in memory passing an arbitrary set of slices.

Examples:
  rasterSlicing.cpp.

virtual bool TeAbstractTheme::buildGrouping | ( | const TeGrouping & | g,
|  | TeSelectedObjects | selectedObjects = `TeAll`,
|  | vector< double > * | dValuesVec = `0`
| ) |  | `[pure virtual]`

Save the grouping parameters in memory when there is no chronon.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::buildGrouping | ( | const TeGrouping & | g,
|  | TeChronon | chr,
|  | vector< map< string, string > > & | mapObjValVec
| ) |  | `[pure virtual]`

Save the grouping parameters in memory when there is chronon.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

void TeAbstractTheme::cleanLegend | ( |  | ) | `[virtual]`

Clear the vector of legends.

virtual void TeAbstractTheme::clearItemStatus | ( |  | ) | `[inline, virtual]`

Set the status of the items to the default state.

virtual void TeAbstractTheme::clearObjectSet | ( |  | ) | `[inline, virtual]`

Clear the set containing the objects of the theme.

virtual void TeAbstractTheme::clearObjStatus | ( |  | ) | `[inline, virtual]`

Set the status of the objects to the default state.

TeAbstractTheme * TeAbstractTheme::copyTo | ( | TeDatabase * | outputDatabase,
|  | TeView * | view,
|  | const std::string & | renameTo = `""`,
|  | const int & | orderIndex = `-1`
| ) |  |

Copies the theme to the given database, inside the given view and with the (optionall) given new name.

void TeAbstractTheme::createRasterVisual | ( | TeRaster * | rst = `0` | ) | `[virtual]`

Creates an appropriate visual presentation to the raster of the theme.

Reimplemented in TeExternalTheme, and TeTheme.

virtual void TeAbstractTheme::defaultLegend | ( | TeLegendEntry & | leg | ) | `[inline, virtual]`

Sets a default legend of the objects of the theme.

Examples:
  rasterSlicing.cpp.

virtual TeLegendEntry& TeAbstractTheme::defaultLegend | ( |  | ) | `[inline, virtual]`

Returns the default legend of the objects of the theme.

virtual bool TeAbstractTheme::deleteGrouping | ( |  | ) | `[pure virtual]`

Delete grouping.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::eraseMetadata | ( | TeDatabase * |  | ) | `[protected, pure virtual]`

Erase the theme metadata in the database.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual void TeAbstractTheme::geomRepRestriction | ( | TeGeomRep & | rep | ) | `[inline, virtual]`

Sets the geometry representation of the theme which will be considered in the spatial restriction.

virtual TeGeomRep TeAbstractTheme::geomRepRestriction | ( |  | ) | `[inline, virtual]`

Returns the geometry representation of the theme which will be considered in the spatial restriction.

virtual TeGeometry* TeAbstractTheme::geomRestriction | ( |  | ) | `[inline, virtual]`

Returns a pointer to the geometry associated with the spatial restriction.

virtual void TeAbstractTheme::geomRestriction | ( | TeGeometry * | g | ) | `[inline, virtual]`

Sets a pointer to the geometry associated with the spatial restriction.

TeTime TeAbstractTheme::getCreationTime | ( |  | ) | const`[virtual]`

Gets the creation time of the theme.

virtual map<string, int>& TeAbstractTheme::getItemStatusMap | ( |  | ) | `[inline, virtual]`

Return the map containing the status of the items.

virtual vector<string> TeAbstractTheme::getItemVector | ( | TeSelectedObjects | selectedObjects | ) | `[pure virtual]`

Get the set of items corresponding to the object selection criteria.

Implemented in TeFileTheme, TeSFSTheme, and TeTheme.

virtual vector<string> TeAbstractTheme::getItemVector | ( | const set< string > & | oidSet | ) | `[pure virtual]`

Get the set of items corresponding to the set of objects.

Implemented in TeFileTheme, TeSFSTheme, and TeTheme.

virtual unsigned int TeAbstractTheme::getNumberOfObjects | ( |  | ) | `[pure virtual]`

Get the number of objects acessible by this theme.

Implemented in TeFileTheme, TeSFSTheme, and TeTheme.

virtual int TeAbstractTheme::getNumLayerObjects | ( |  | ) | `[inline, virtual]`

Return the number of objects of the layer.

virtual set<string> TeAbstractTheme::getObjects | ( | TeSelectedObjects | selectedObjects = `TeAll` | ) | `[pure virtual]`

Get the set of objects corresponding to the object selection criteria.

Implemented in TeFileTheme, TeSFSTheme, and TeTheme.

virtual set<string> TeAbstractTheme::getObjects | ( | const vector< string > & | itemVec | ) | `[pure virtual]`

Get the set of objects corresponding to the list of items.

Implemented in TeFileTheme, TeSFSTheme, and TeTheme.

virtual map<string, int>& TeAbstractTheme::getObjLegendMap | ( |  | ) | `[inline, virtual]`

Returns the map of legend ids associated to each object.

virtual map<string, int>& TeAbstractTheme::getObjOwnLegendMap | ( |  | ) | `[inline, virtual]`

Returns the map of legend ids associated to each object.

virtual map<string, int>& TeAbstractTheme::getObjStatusMap | ( |  | ) | `[inline, virtual]`

Return the map containing the status of the objects.

TeSliceVector TeAbstractTheme::getSlices | ( |  | ) | `[virtual]`

Returns the slices associated to the grouping of the theme.

virtual TeBox& TeAbstractTheme::getThemeBox | ( |  | ) | `[inline, virtual]`

Returns the theme box.

virtual TeProjection* TeAbstractTheme::getThemeProjection | ( |  | ) | `[pure virtual]`

Returns a pointer to a projection that is the spatial reference for the objects of this theme.

Concrete classes should reimplement this method.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual TeGrouping& TeAbstractTheme::grouping | ( |  | ) | `[inline, virtual]`

Returns a grouping associated the theme.

Examples:
  rasterSlicing.cpp.

virtual void TeAbstractTheme::grouping | ( | const TeGrouping & | g | ) | `[inline, virtual]`

Sets a grouping associated to the theme.

virtual bool TeAbstractTheme::hasAttrRest | ( |  | ) | `[inline, virtual]`

Returns if there is an attribute restriction.

Reimplemented in TeExternalTheme.

virtual bool TeAbstractTheme::hasRestriction | ( |  | ) | `[inline, virtual]`

Verifies if this theme has any kind of restrictions.

Reimplemented in TeExternalTheme.

virtual bool TeAbstractTheme::hasSpatialRest | ( |  | ) | `[inline, virtual]`

Returns TRUE if this theme has a spatial restriction.

Reimplemented in TeExternalTheme.

virtual void TeAbstractTheme::hasSpatialRest | ( | bool | a | ) | `[inline, virtual]`

Sets the flag that indicates that there is a spatial restriction.

virtual bool TeAbstractTheme::hasTemporalRest | ( |  | ) | `[inline, virtual]`

Returns TRUE if there is a temporal restriction defined in the theme.

Reimplemented in TeExternalTheme.

void TeAbstractTheme::invertObjectStatus | ( |  | ) | `[virtual]`

Invert the pointing status of the objects.

const bool & TeAbstractTheme::isAvailable | ( |  | ) | const

bool TeAbstractTheme::isEditable | ( |  | ) | const

Returns:

bool TeAbstractTheme::isUpdated | ( |  | ) | `[virtual]`

Checks if the theme is update. If FALSE, the theme may be not be updated.

Reimplemented in TeTheme.

void TeAbstractTheme::legend | ( | TeLegendEntry & | leg | ) | `[virtual]`

Sets a legend for the theme objects.

virtual TeLegendEntryVector& TeAbstractTheme::legend | ( |  | ) | `[inline, virtual]`

Returns the vector of legends of the theme.

virtual bool TeAbstractTheme::loadMetadata | ( | TeDatabase * |  | ) | `[pure virtual]`

Load the theme metadata from database.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::locateCell | ( | TeCoord2D & | pt,
|  | TeCell & | c,
|  | const double & | tol = `0.0`
| ) |  | `[pure virtual]`

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::locateLine | ( | TeCoord2D & | pt,
|  | TeLine2D & | line,
|  | const double & | tol = `0.0`
| ) |  | `[pure virtual]`

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::locatePoint | ( | TeCoord2D & | pt,
|  | TePoint & | point,
|  | const double & | tol = `0.0`
| ) |  | `[pure virtual]`

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::locatePolygon | ( | TeCoord2D & | pt,
|  | TePolygon & | polygon,
|  | const double & | tol = `0.0`
| ) |  | `[pure virtual]`

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual bool TeAbstractTheme::locatePolygonSet | ( | TeCoord2D & | pt,
|  | double | tol,
|  | TePolygonSet & | polygons
| ) |  | `[pure virtual]`

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

virtual void TeAbstractTheme::maxScale | ( | double | s | ) | `[inline, virtual]`

Sets the maximum scale in which the theme is visible.

virtual double TeAbstractTheme::maxScale | ( |  | ) | `[inline, virtual]`

Returns the maximum scale in which the theme is visible.

virtual void TeAbstractTheme::minScale | ( | double | s | ) | `[inline, virtual]`

Sets the minimum scale in which the theme is visible.

virtual double TeAbstractTheme::minScale | ( |  | ) | `[inline, virtual]`

Returns the minimum scale in which the theme is visible.

virtual bool TeAbstractTheme::operator< | ( | const TeAbstractTheme & | r | ) | const`[inline, virtual]`

Returns TRUE if a theme has lower priority than another.

TeAbstractTheme & TeAbstractTheme::operator= | ( | const TeAbstractTheme & | other | ) |

Assignment operator.

virtual void TeAbstractTheme::outOfCollectionLegend | ( | TeLegendEntry & | leg | ) | `[inline, virtual]`

Sets a legend for objects of the layer that weren't selected in this theme.

Useful when is necessary to see the theme in the context of the layer

virtual TeLegendEntry& TeAbstractTheme::outOfCollectionLegend | ( |  | ) | `[inline, virtual]`

Returns the legend of the layer objects that are not selected in this layer.

virtual TeLegendEntry& TeAbstractTheme::pointingLegend | ( |  | ) | `[inline, virtual]`

Returns the legend of the theme objects selected by pointing.

virtual void TeAbstractTheme::pointingLegend | ( | TeLegendEntry & | leg | ) | `[inline, virtual]`

Sets a legend for the theme objects selected by pointing.

virtual void TeAbstractTheme::queryAndPointingLegend | ( | TeLegendEntry & | leg | ) | `[inline, virtual]`

Sets a legend for the theme objects selected by query and pointing.

virtual TeLegendEntry& TeAbstractTheme::queryAndPointingLegend | ( |  | ) | `[inline, virtual]`

Returns the legend of the theme objects selected by query and pointing.

virtual void TeAbstractTheme::queryLegend | ( | TeLegendEntry & | leg | ) | `[inline, virtual]`

Sets a legend for the theme objects selected by a query.

virtual TeLegendEntry& TeAbstractTheme::queryLegend | ( |  | ) | `[inline, virtual]`

Returns the legend of the theme objects selected by a query.

virtual TeRasterTransform* TeAbstractTheme::rasterVisual | ( |  | ) | `[inline, virtual]`

Returns the visual presentation of raster geometry.

virtual void TeAbstractTheme::rasterVisual | ( | TeRasterTransform * | r | ) | `[inline, virtual]`

Sets the visual presentation of raster geometry.

void TeAbstractTheme::removePointingColor | ( |  | ) | `[virtual]`

Remove the pointing color.

void TeAbstractTheme::removeQueryColor | ( |  | ) | `[virtual]`

Remove the query color.

void TeAbstractTheme::removeRasterVisual | ( |  | ) | `[virtual]`

Removes the visual presentation of the raster.

void TeAbstractTheme::resetGrouping | ( |  | ) | `[virtual]`

Clear the existing grouping of objects of this theme.

Examples:
  themeGrouping.cpp.

virtual bool TeAbstractTheme::save | ( |  | ) | `[pure virtual]`

Save the theme parameters.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

Examples:
  rasterSlicing.cpp.

virtual bool TeAbstractTheme::saveGrouping | ( | TeSelectedObjects | selectedObjects = `TeAll` | ) | `[pure virtual]`

Build the grouping and associate each object to its group.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

Examples:
  rasterSlicing.cpp.

virtual bool TeAbstractTheme::saveMetadata | ( | TeDatabase * |  | ) | `[pure virtual]`

Save (insert or update) the theme metadata in the database.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

void TeAbstractTheme::setAvailability | ( | const bool & | avaiability | ) | `[virtual]`

void TeAbstractTheme::setCreationTime | ( | const TeTime & | creationTime | ) | `[virtual]`

Sets in memory the creation time of the theme.

void TeAbstractTheme::setEditable | ( | const bool & | editable | ) |

Parameters:

  editable |

bool TeAbstractTheme::setGroupingVisual | ( | int | n,
|  | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[virtual]`

Sets the visual associated to a geometric representation in the n-th group of the theme.

Examples:
  rasterSlicing.cpp, and themeGrouping.cpp.

bool TeAbstractTheme::setGroupingVisual | ( | int | n,
|  | TeGeomRepVisualMap & | vismap
| ) |  | `[virtual]`

Sets the visual of the n-th group of the theme.

virtual void TeAbstractTheme::setLegendsForObjects | ( |  | ) | `[pure virtual]`

Set the legend id for each object of the theme.

Implemented in TeExternalTheme, TeFileTheme, TeSFSTheme, and TeTheme.

void TeAbstractTheme::setObjectsToDefaultStatus | ( |  | ) | `[virtual]`

Set the objects to the default status.

virtual void TeAbstractTheme::setOwnLegendsForObjects | ( |  | ) | `[pure virtual]`

Set the own legend id for each object of the theme.

Implemented in TeFileTheme, TeSFSTheme, and TeTheme.

void TeAbstractTheme::setParent | ( | TeViewNode * |  | ) | `[virtual]`

Sets the parent node. The abstract theme does not have parent node.

Reimplemented from TeViewNode.

void TeAbstractTheme::setSpatialRest | ( | TeGeometry * | geom,
|  | TeGeomRep | rep,
|  | TeSpatialRelation | relation = `TeWITHIN`
| ) |  | `[virtual]`

Sets the spatial restriction to be a spatial relation with a geometry.

Reimplemented in TeTheme.

void TeAbstractTheme::setSpatialRest | ( | TeBox & | box,
|  | TeGeomRep | rep,
|  | TeSpatialRelation | relation = `TeWITHIN`
| ) |  | `[virtual]`

Sets the spatial restriction to be a spatial relation with a box.

Reimplemented in TeTheme.

void TeAbstractTheme::setStatus | ( | vector< string > & | oidVec,
|  | vector< string > & | itemVec,
|  | int | status
| ) |  | `[virtual]`

the status

void TeAbstractTheme::setStatusForItemsAddedByPointing | ( | vector< string > & | itemVec | ) | `[virtual]`

Set the status for the additional set of items that were pointed.

void TeAbstractTheme::setStatusForItemsAddedByQuerying | ( | set< string > & | oidSet,
|  | vector< string > & | uidVec
| ) |  | `[virtual]`

Set the status for the additional set of items that were queried.

void TeAbstractTheme::setStatusForItemsFilteredByQuerying | ( | set< string > & | oidSet,
|  | vector< string > & | uidVec
| ) |  | `[virtual]`

Set the status for the set of items that were filtered by a query operation.

void TeAbstractTheme::setStatusForItemsToggled | ( | set< string > & | oidSet,
|  | vector< string > & | itemVec
| ) |  | `[virtual]`

the status for the items that were toggled

void TeAbstractTheme::setStatusForNewItemsPointed | ( | vector< string > & | itemVec | ) | `[virtual]`

Set the status for the new set of items that were pointed.

void TeAbstractTheme::setStatusForNewItemsQueried | ( | set< string > & | oidSet,
|  | vector< string > & | uidVec
| ) |  | `[virtual]`

Set the status for the new set of items that were queried.

void TeAbstractTheme::setStatusForNewObjectsPointed | ( | set< string > & | oidSet | ) | `[virtual]`

Set the status for the new set of objects that were pointed.

void TeAbstractTheme::setStatusForObjectsAddedByPointing | ( | set< string > & | oidSet | ) | `[virtual]`

Set the status for the additional set of objects that were pointed.

void TeAbstractTheme::setStatusForObjectToggled | ( | string | oid | ) | `[virtual]`

Set the status for the objects that were toggled.

virtual void TeAbstractTheme::setThemeBox | ( | const TeBox & | box | ) | `[inline, virtual]`

Sets the theme box.

virtual void TeAbstractTheme::setVisualDefault | ( | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[inline, virtual]`

Sets the visual of the default legend for a specific geometrical representation.

Examples:
  createTheme.cpp.

virtual void TeAbstractTheme::setVisualOutOfCollection | ( | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[inline, virtual]`

Sets the visual of the non-selected objects legend for a specific geometrical representation.

virtual void TeAbstractTheme::setVisualPointing | ( | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[inline, virtual]`

Sets the visual of the pointed objects legend for a specific geometrical representation.

virtual void TeAbstractTheme::setVisualQuery | ( | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[inline, virtual]`

Sets the visual of the queried objects legend for a specific geometrical representation.

virtual void TeAbstractTheme::setVisualQueryAndPointing | ( | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[inline, virtual]`

Sets the visual of the queried and pointed objects legend for a specific geometrical representation.

virtual void TeAbstractTheme::setVisualWithoutDataConnection | ( | TeVisual * | visual,
|  | TeGeomRep | rep
| ) |  | `[inline, virtual]`

Sets the visual of the without-attributes objects legend for a specific geometrical representation.

virtual void TeAbstractTheme::spatialRelation | ( | TeSpatialRelation | s | ) | `[inline, virtual]`

Sets the spatial relation (e.g WITHIN, COVERED BY, etc.) associate to the spatial restriction.

virtual TeSpatialRelation TeAbstractTheme::spatialRelation | ( |  | ) | `[inline, virtual]`

Returns the spatial relation (e.g WITHIN, COVERED BY, etc.) associate to the spatial restriction.

virtual void TeAbstractTheme::spatialRest | ( | const string & | s | ) | `[inline, virtual]`

Sets the spatial restriction used to generate the theme.

virtual string TeAbstractTheme::spatialRest | ( |  | ) | `[inline, virtual]`

Returns the spatial restriction used to generate the theme.

virtual string TeAbstractTheme::temporalRest | ( |  | ) | `[inline, virtual]`

Returns the temporal restriction used to generate the theme.

virtual void TeAbstractTheme::temporalRest | ( | const string & | t | ) | `[inline, virtual]`

Sets the temporal restriction used to generate the theme.

int TeAbstractTheme::temporaryRepresentation | ( | void |  | ) | `[inline]`

Return the visible temporary representation.

void TeAbstractTheme::temporaryRepresentation | ( | int | rep | ) | `[inline]`

Set the visible temporary representation.

void TeAbstractTheme::temporaryVisibility | ( | short | state | ) | `[inline]`

set the temporary state of theme

short TeAbstractTheme::temporaryVisibility | ( | void |  | ) | `[inline]`

return the temporary state of theme

bool TeAbstractTheme::updateThemeCreationTime | ( | TeDatabase * | database | ) | `[virtual]`

Updates the creation in memory and in the database.

virtual void TeAbstractTheme::visibility | ( | int | v | ) | `[inline, virtual]`

Sets whether the theme should be visible and/or active.

- Returns 0 if the theme is not visible and not active
- Returns 1 if the theme is visible and not active
- Returns 2 if theme is and active and not visible
- Returns 3 if theme is and visible and active

Reimplemented from TeViewNode.

virtual int TeAbstractTheme::visibility | ( |  | ) | `[inline, virtual]`

Returns a status of a theme.

- Returns 0 if the theme is not visible and not active
- Returns 1 if the theme is visible and not active
- Returns 2 if theme is and active and not visible
- Returns 3 if theme is and visible and active

Reimplemented from TeViewNode.

int TeAbstractTheme::visibleGeoRep | ( |  | ) | `[virtual]`

Returns the geometrical representations of the theme that are visible.

virtual int TeAbstractTheme::visibleRep | ( |  | ) | `[inline, virtual]`

Returns the components or representations of the theme that are visible.

The result is a combination of any type of geometrical representation (TeGeomRep) plus:

- 0x20000000: representing the visibility of the legend
- 0x40000000: representing the visibility of the groupings
- 0x80000000: representing the visibility of the pie/chart graphs

virtual void TeAbstractTheme::visibleRep | ( | int | rep | ) | `[inline, virtual]`

Sets the components or representations of the theme that are visible.

The param rep is a combination of any type of geometrical representation (TeGeomRep) plus:

- 0x20000000: representing the visibility of the legend
- 0x40000000: representing the visibility of the groupings
- 0x80000000: representing the visibility of the pie/chart graphs

Examples:
  createTheme.cpp, and rasterSlicing.cpp.

virtual TeLegendEntry& TeAbstractTheme::withoutDataConnectionLegend | ( |  | ) | `[inline, virtual]`

Returns the legend of objects that have geometries but not descriptive attributes.

virtual void TeAbstractTheme::withoutDataConnectionLegend | ( | TeLegendEntry & | leg | ) | `[inline, virtual]`

Sets a legend for objects that have geometries but not descriptive attributes.

Useful when in intermediary situations such as editing

## Friends And Related Function Documentation

friend class TeDatabase`[friend]`

## Member Data Documentation

TeBox TeAbstractTheme::boxRest_`[protected]`

TeTime TeAbstractTheme::creationTime_`[protected]`

Stores the creation time of the theme.

TeLegendEntry TeAbstractTheme::defaultLegend_`[protected]`

int TeAbstractTheme::enableVisibility_`[protected]`

string TeAbstractTheme::generateAttributeRest_`[protected]`

string TeAbstractTheme::generateSpatialRest_`[protected]`

string TeAbstractTheme::generateTemporalRest_`[protected]`

TeGeomRep TeAbstractTheme::geomRepRest_`[protected]`

TeGeometry* TeAbstractTheme::geomRest_`[protected]`

TeGrouping TeAbstractTheme::grouping_`[protected]`

bool TeAbstractTheme::hasSpatialRes_`[protected]`

bool TeAbstractTheme::isAvailable_`[protected]`

Theme source can be accessed.

bool TeAbstractTheme::isEditable_`[protected]`

Theme can be edited.

map<string, int> TeAbstractTheme::itemStatusMap_`[protected]`

Status of the item (concatenation of the unique names of each theme table)

TeLegendEntryVector TeAbstractTheme::legend_`[protected]`

double TeAbstractTheme::maxScale_`[protected]`

double TeAbstractTheme::minScale_`[protected]`

int TeAbstractTheme::numLayerObjects_`[protected]`

Number of objects of the layer.

set<string> TeAbstractTheme::objectSet_`[protected]`

A set containing the theme objects.

map<string, int> TeAbstractTheme::objLegendMap_`[protected]`

map<string, int> TeAbstractTheme::objOwnLegendMap_`[protected]`

map<string, int> TeAbstractTheme::objStatusMap_`[protected]`

Status of the object.

TeLegendEntry TeAbstractTheme::outOfCollectionLegend_`[protected]`

TeLegendEntry TeAbstractTheme::pointingLegend_`[protected]`

TeLegendEntry TeAbstractTheme::queryAndPointingLegend_`[protected]`

TeLegendEntry TeAbstractTheme::queryLegend_`[protected]`

TeRasterTransform* TeAbstractTheme::rasterVisual_`[protected]`

visual of raster

TeSpatialRelation TeAbstractTheme::spatialRelation_`[protected]`

int TeAbstractTheme::temporaryRepresentation_`[protected]`

short TeAbstractTheme::temporaryVisibility_`[protected]`

TeBox TeAbstractTheme::themeBox_`[protected]`

int TeAbstractTheme::visibleRep_`[protected]`

TeLegendEntry TeAbstractTheme::withoutDataConnectionLegend_`[protected]`

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

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines