TerraLib 4.1
TeAppTheme Class Reference

An extension to the definition of a Theme in TerraLib. More...

#include <TeAppTheme.h>

List of all members.

Public Member Functions

 TeAppTheme (TeAbstractTheme *theme=0)
 Constructors.
 ~TeAppTheme ()
 Destructor.
 TeAppTheme (const TeAppTheme &other)
TeAppThemeoperator= (const TeAppTheme &other)
TeAbstractThemegetTheme ()
 Returns the theme which this theme application is related.
bool outOfCollectionVisibility ()
 Returns TRUE if objects of the layer that don�t belong to the theme are visible.
void outOfCollectionVisibility (bool v)
 Set whether objects of the layer that don�t belong to the theme are visible.
bool withoutDataConnectionVisibility ()
 Returns TRUE if objects whithout descriptive attributes are visible.
void withoutDataConnectionVisibility (bool v)
 Set whether objects whithout descriptive attributes are visible.
string refineAttributeWhere ()
 Returns a attribute restriction (where clause) used to refine the selection defined by the theme.
void refineAttributeWhere (const string &s)
 Set a attribute restriction (where clause) to refine the selection defined by the theme.
string refineSpatialWhere ()
 Returns a spatial restriction (where clause) used to refine the selection defined by the theme.
void refineSpatialWhere (const string &s)
 Set a spatial restriction (where clause) used to refine the selection defined by the theme.
string refineTemporalWhere ()
 Returns a temporal restriction (where clause) used to refine the selection defined by the theme.
void refineTemporalWhere (const string &t)
 Set a temporal restriction (where clause) used to refine the selection defined by the theme.
string groupColor ()
 Returns the grouping colors.
void groupColor (const string &c)
 Set the grouping colors.
TeColorDirection groupColorDir ()
 Returns the grouping colors direction.
void groupColorDir (TeColorDirection n)
 Set the grouping colors direction.
TeSelectedObjects groupObjects ()
 Returns a code identifying which objects should be grouped.
void groupObjects (TeSelectedObjects n)
 Set a code identifying which objects should be grouped.
double pieDiameter ()
 Returns the diameter in pixels of the pie charts.
void pieDiameter (double n)
 Set the diameter in pixels of the pie charts.
string pieDimAttribute ()
 Returns the name of the attribute which gives the dimension of the diameter in pixels of the pie charts.
void pieDimAttribute (const string &s)
 Set the name of the attribute which gives the dimension of the diameter in pixels of the pie charts.
double pieMinDiameter ()
 Returns the minimum diameter in pixels of the pie charts.
void pieMinDiameter (double n)
 Set the minimum diameter in pixels of pie charts.
double pieMaxDiameter ()
 Returns the maximum diameter in pixels of the pie charts.
void pieMaxDiameter (double n)
 Set the maximum diameter in pixels of pie charts.
double barMinHeight ()
 Returns the minimum height in pixels of the bar charts.
void barMinHeight (double n)
 Set the minimum height in pixels of the bar charts.
double barMaxHeight ()
 Returns the maximum height in pixels of the bar charts.
void barMaxHeight (double n)
 Set the maximum height in pixels of the bar charts.
double barWidth ()
 Returns the bar width in pixels of the bar charts.
void barWidth (double n)
 Set the bar width in pixels of the bar charts.
TeChartType chartType ()
 Returns the type of the chart.
void chartType (TeChartType n)
 Set the type of the chart.
string chartFunction ()
 Get the chart aggregate function.
void chartFunction (string s)
 Set the chart aggregate function.
TeSelectedObjects chartObjects ()
 Returns the objects where the charts should be plotted.
void chartObjects (TeSelectedObjects n)
 Set the objects where the charts should be plotted.
double chartMaxVal ()
 Returns the maximum value used to plot charts.
void chartMaxVal (double n)
 Set the maximum value used to plot charts.
double chartMinVal ()
 Returns the minimum value used to plot charts.
void chartMinVal (double n)
 Set the minimum value used to plot charts.
int keepDimension ()
 Returns TRUE if charts keep its dimension in zooming operations.
void keepDimension (int n)
 Set if charts keep its dimension in zooming operations.
bool showCanvasLegend ()
 Returns TRUE if the legends of the grouping should be plot in the canvas.
void showCanvasLegend (bool cl)
 Set whether the legends of the grouping should be plot in the canvas.
TeCoord2D canvasLegUpperLeft ()
 Returns the upper left position of the canvas legend.
void canvasLegUpperLeft (TeCoord2D c)
 Set the upper left position of the canvas legend.
double canvasLegWidth ()
 Returns the canvas legend width.
void canvasLegWidth (double w)
 Set the canvas legend width.
double canvasLegHeight ()
 Returns the canvas legend height.
void canvasLegHeight (double h)
 Set the canvas legend height.
TeGeomRep editRep ()
 Returns the geometrical representation being edited.
void editRep (TeGeomRep r)
 Set the geometrical representation being edited.
unsigned int getTableIndexFromField (string fieldName)
 Get the table index from the list of the theme tables, through a given field.
bool mixColor ()
void mixColor (bool mixcolor)
bool countObj ()
void countObj (bool countobj)
string textTable ()
 Returns the name of a text table that is visible by this theme (used to label objects)
void textTable (const string &t)
 Set the name of a text table that is visible by this theme (used to label objects)
bool locateText (TeCoord2D &pt, TeText &text, const double &tol=0.0)
TeVisual getTextVisual (const TeText &text)
bool setAlias (string att, string attAlias)
string getLegendTitleAlias ()
string getPieBarAlias (string atr)
void removeAlias (string att)
void removeAllAlias ()
void concatTableName (string &attr)
int numObjects ()
 Returns the number of objects in a theme.
TeBoxboundingBox ()
 Returns the bounding box of the theme.
TeThemegetSourceTheme ()
 Get the source theme.
TeDatabasegetLocalDatabase ()
 Get local database where metadata is stored.
string getLocalCollectionTable ()
 Get the collection table atored in the local database.

Public Attributes

vector< TeColorchartColors_
 Vector of colors used to plot the charts.
vector< stringchartAttributes_
 Vector of attributes used to plot the charts.
string chartSelected_
TeCoord2D chartPoint_
TePoint tePoint_

Detailed Description

An extension to the definition of a Theme in TerraLib.


Constructor & Destructor Documentation

TeAppTheme::TeAppTheme ( TeAbstractTheme theme = 0)

Constructors.

TeAppTheme::~TeAppTheme ( )

Destructor.

TeAppTheme::TeAppTheme ( const TeAppTheme other)

Member Function Documentation

double TeAppTheme::barMaxHeight ( ) [inline]

Returns the maximum height in pixels of the bar charts.

void TeAppTheme::barMaxHeight ( double  n) [inline]

Set the maximum height in pixels of the bar charts.

double TeAppTheme::barMinHeight ( ) [inline]

Returns the minimum height in pixels of the bar charts.

void TeAppTheme::barMinHeight ( double  n) [inline]

Set the minimum height in pixels of the bar charts.

void TeAppTheme::barWidth ( double  n) [inline]

Set the bar width in pixels of the bar charts.

double TeAppTheme::barWidth ( ) [inline]

Returns the bar width in pixels of the bar charts.

TeBox & TeAppTheme::boundingBox ( )

Returns the bounding box of the theme.

double TeAppTheme::canvasLegHeight ( ) [inline]

Returns the canvas legend height.

void TeAppTheme::canvasLegHeight ( double  h) [inline]

Set the canvas legend height.

TeCoord2D TeAppTheme::canvasLegUpperLeft ( ) [inline]

Returns the upper left position of the canvas legend.

void TeAppTheme::canvasLegUpperLeft ( TeCoord2D  c) [inline]

Set the upper left position of the canvas legend.

double TeAppTheme::canvasLegWidth ( ) [inline]

Returns the canvas legend width.

void TeAppTheme::canvasLegWidth ( double  w) [inline]

Set the canvas legend width.

string TeAppTheme::chartFunction ( ) [inline]

Get the chart aggregate function.

void TeAppTheme::chartFunction ( string  s) [inline]

Set the chart aggregate function.

double TeAppTheme::chartMaxVal ( ) [inline]

Returns the maximum value used to plot charts.

void TeAppTheme::chartMaxVal ( double  n) [inline]

Set the maximum value used to plot charts.

double TeAppTheme::chartMinVal ( ) [inline]

Returns the minimum value used to plot charts.

void TeAppTheme::chartMinVal ( double  n) [inline]

Set the minimum value used to plot charts.

TeSelectedObjects TeAppTheme::chartObjects ( ) [inline]

Returns the objects where the charts should be plotted.

void TeAppTheme::chartObjects ( TeSelectedObjects  n) [inline]

Set the objects where the charts should be plotted.

TeChartType TeAppTheme::chartType ( ) [inline]

Returns the type of the chart.

void TeAppTheme::chartType ( TeChartType  n) [inline]

Set the type of the chart.

void TeAppTheme::concatTableName ( string attr)
bool TeAppTheme::countObj ( ) [inline]
void TeAppTheme::countObj ( bool  countobj) [inline]
TeGeomRep TeAppTheme::editRep ( ) [inline]

Returns the geometrical representation being edited.

void TeAppTheme::editRep ( TeGeomRep  r) [inline]

Set the geometrical representation being edited.

string TeAppTheme::getLegendTitleAlias ( )
string TeAppTheme::getLocalCollectionTable ( )

Get the collection table atored in the local database.

TeDatabase * TeAppTheme::getLocalDatabase ( )

Get local database where metadata is stored.

string TeAppTheme::getPieBarAlias ( string  atr)
TeTheme * TeAppTheme::getSourceTheme ( )

Get the source theme.

unsigned int TeAppTheme::getTableIndexFromField ( string  fieldName)

Get the table index from the list of the theme tables, through a given field.

TeVisual TeAppTheme::getTextVisual ( const TeText text)
TeAbstractTheme* TeAppTheme::getTheme ( ) [inline]

Returns the theme which this theme application is related.

string TeAppTheme::groupColor ( ) [inline]

Returns the grouping colors.

void TeAppTheme::groupColor ( const string c) [inline]

Set the grouping colors.

void TeAppTheme::groupColorDir ( TeColorDirection  n) [inline]

Set the grouping colors direction.

TeColorDirection TeAppTheme::groupColorDir ( ) [inline]

Returns the grouping colors direction.

TeSelectedObjects TeAppTheme::groupObjects ( ) [inline]

Returns a code identifying which objects should be grouped.

void TeAppTheme::groupObjects ( TeSelectedObjects  n) [inline]

Set a code identifying which objects should be grouped.

int TeAppTheme::keepDimension ( ) [inline]

Returns TRUE if charts keep its dimension in zooming operations.

void TeAppTheme::keepDimension ( int  n) [inline]

Set if charts keep its dimension in zooming operations.

bool TeAppTheme::locateText ( TeCoord2D pt,
TeText text,
const double &  tol = 0.0 
)
void TeAppTheme::mixColor ( bool  mixcolor) [inline]
bool TeAppTheme::mixColor ( ) [inline]
int TeAppTheme::numObjects ( )

Returns the number of objects in a theme.

TeAppTheme & TeAppTheme::operator= ( const TeAppTheme other)
bool TeAppTheme::outOfCollectionVisibility ( ) [inline]

Returns TRUE if objects of the layer that don�t belong to the theme are visible.

void TeAppTheme::outOfCollectionVisibility ( bool  v) [inline]

Set whether objects of the layer that don�t belong to the theme are visible.

void TeAppTheme::pieDiameter ( double  n) [inline]

Set the diameter in pixels of the pie charts.

double TeAppTheme::pieDiameter ( ) [inline]

Returns the diameter in pixels of the pie charts.

void TeAppTheme::pieDimAttribute ( const string s) [inline]

Set the name of the attribute which gives the dimension of the diameter in pixels of the pie charts.

string TeAppTheme::pieDimAttribute ( ) [inline]

Returns the name of the attribute which gives the dimension of the diameter in pixels of the pie charts.

void TeAppTheme::pieMaxDiameter ( double  n) [inline]

Set the maximum diameter in pixels of pie charts.

double TeAppTheme::pieMaxDiameter ( ) [inline]

Returns the maximum diameter in pixels of the pie charts.

double TeAppTheme::pieMinDiameter ( ) [inline]

Returns the minimum diameter in pixels of the pie charts.

void TeAppTheme::pieMinDiameter ( double  n) [inline]

Set the minimum diameter in pixels of pie charts.

string TeAppTheme::refineAttributeWhere ( ) [inline]

Returns a attribute restriction (where clause) used to refine the selection defined by the theme.

void TeAppTheme::refineAttributeWhere ( const string s) [inline]

Set a attribute restriction (where clause) to refine the selection defined by the theme.

string TeAppTheme::refineSpatialWhere ( ) [inline]

Returns a spatial restriction (where clause) used to refine the selection defined by the theme.

void TeAppTheme::refineSpatialWhere ( const string s) [inline]

Set a spatial restriction (where clause) used to refine the selection defined by the theme.

string TeAppTheme::refineTemporalWhere ( ) [inline]

Returns a temporal restriction (where clause) used to refine the selection defined by the theme.

void TeAppTheme::refineTemporalWhere ( const string t) [inline]

Set a temporal restriction (where clause) used to refine the selection defined by the theme.

void TeAppTheme::removeAlias ( string  att)
void TeAppTheme::removeAllAlias ( )
bool TeAppTheme::setAlias ( string  att,
string  attAlias 
)
void TeAppTheme::showCanvasLegend ( bool  cl) [inline]

Set whether the legends of the grouping should be plot in the canvas.

bool TeAppTheme::showCanvasLegend ( ) [inline]

Returns TRUE if the legends of the grouping should be plot in the canvas.

string TeAppTheme::textTable ( ) [inline]

Returns the name of a text table that is visible by this theme (used to label objects)

void TeAppTheme::textTable ( const string t) [inline]

Set the name of a text table that is visible by this theme (used to label objects)

void TeAppTheme::withoutDataConnectionVisibility ( bool  v) [inline]

Set whether objects whithout descriptive attributes are visible.

bool TeAppTheme::withoutDataConnectionVisibility ( ) [inline]

Returns TRUE if objects whithout descriptive attributes are visible.


Member Data Documentation

Vector of attributes used to plot the charts.

Vector of colors used to plot the charts.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines