dc/d54/common_8h_source.html

 /*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.


     This file is part of the TerraLib - a Framework for building GIS enabled applications.


     TerraLib is free software: you can redistribute it and/or modify

     it under the terms of the GNU General Public License as published by

     the Free Software Foundation, either version 3 of the License,

     or (at your option) any later version.


     TerraLib is distributed in the hope that it will be useful,

     but WITHOUT ANY WARRANTY; without even the implied warranty of

     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

     GNU General Public License for more details.


     You should have received a copy of the GNU General Public License

     along with TerraLib. See COPYING. If not, write to

     TerraLib Team at <terralib-team@terralib.org>.

  */


 /*!

   \file common.h


   \brief This file contains include headers for the TerraLib Common Runtime module.

  */


 #ifndef __TERRALIB_INTERNAL_COMMON_H

 #define __TERRALIB_INTERNAL_COMMON_H


 // TerraLib

 #include "common/AbstractFactory.h"

 #include "common/BaseVisitable.h"

 #include "common/BaseVisitor.h"

 #include "common/BoostUtils.h"

 #include "common/ByteSwapUtils.h"

 #include "common/Comparators.h"

 #include "common/Config.h"

 #include "common/Distance.h"

 #include "common/Enums.h"

 #include "common/Exception.h"

 #include "common/FactoryDictionary.h"

 #include "common/Globals.h"

 #include "common/LoggedException.h"

 #include "core/logger/Logger.h"

 #include "common/Module.h"

 #include "common/ParameterizedAbstractFactory.h"

 #include "common/PlatformUtils.h"

 #include "common/Singleton.h"

 #include "common/STLUtils.h"

 #include "common/StringUtils.h"

 #include "common/TerraLib.h"

 #include "common/ThreadingPolicies.h"

 #include "common/TreeItem.h"

 #include "common/UnitOfMeasure.h"

 #include "common/UnitsOfMeasureManager.h"

 #include "common/Visitor.h"

 #include "common/progress/AbstractProgressViewer.h"

 #include "common/progress/ConsoleProgressViewer.h"

 #include "common/progress/ProgressManager.h"

 #include "common/progress/ProgressTimer.h"

 #include "common/progress/TaskProgress.h"


 /*!

   \defgroup common Common


   \brief The common module contains the foundation classes and functions for all TerraLib modules.


   The TerraLib Common Module contains the foundation classes and functions that makes the basic support for other TerraLib modules.

   It provides portable and cross platform code not focus exclusively in the geo-spatial domain.

   On the contrary, the helper classes, utilitary functions, generic class templates and generic design pattern classes

   are domain application neutral and can be used by any application.


   The TerraLib modules has made use of Boost libraries but some functionalities are not found in Boost, so the common runtime module fills this gap

   and add some low-level code used by TerraLib applications. You will find in this module classes for: abstract factories, singletons, visitors, support for i18n,

   message logging, shared library management, threading policies and much more.


   Besides the classes you will find useful routines for: byte swap, hex-encoding/decoding, platform specific routines, auxiliary functions for STL containers.


   The main classes/concepts in this module are listed here. The namespace associated to the Common module is te::common.

   To know more about it, see the te::common namespace documentation.

 */


 namespace te

 {

   /*!

     \brief Namespace for the Common module of TerraLib.

   */

   namespace common

   {

   } // end namespace common

 }   // end namesp


 #endif  // __TERRALIB_INTERNAL_COMMON_H


AbstractFactory.h
A class that defines the interface of an abstract factory.

AbstractProgressViewer.h
A class that defines the interface of an abstract progress viewer.

BaseVisitable.h
The root of all hierarchies that can be visited.

BaseVisitor.h
A general root class for a visitor hierarchy.

BoostUtils.h
This file contains several utility functions for dealing with Boost containers and algorithms.

ByteSwapUtils.h
Utility functions to swap bytes: double, int and unsigned int.

Comparators.h
Several functor types for comparing objects.

ConsoleProgressViewer.h
A progress viewer implementation for the console.

Distance.h
A given distance has a measurement and a unit-of-measure.

FactoryDictionary.h
A dictionary for a Factory.

LoggedException.h
A class that automatically logs the exception message.

Logger.h
This class is designed to manage the log of information in TerraLib.

ParameterizedAbstractFactory.h
A class that defines the basic interface of an abstract factory that makes use of parameters to const...

PlatformUtils.h
This file is a wrapper around platform specific include files.

ProgressManager.h
A singleton class used to manage tasks progresses and their viewers.

ProgressTimer.h
The ProgressTimer is a utility class that can be used to calculate the estimated time to finish a tas...

STLUtils.h
This file contains several utility functions for dealing with STL containers.

Singleton.h
Template support for singleton pattern.

StringUtils.h
Utility functions for dealing with strings.

TaskProgress.h
This class can be used to inform the progress of a task.

ThreadingPolicies.h
Threading policies that can be applied to TerraLib classes that need some synchronization schema.

UnitOfMeasure.h
A class for representing a unit of measure.

UnitsOfMeasureManager.h
A singleton class for dealing with units-of-measure.

Enums.h
General enumerations.

Exception.h
This class is designed to declare objects to be thrown as exceptions by TerraLib.

Globals.h
An static class with global definitions.

Module.h
This singleton defines an entry in the Platform for the TerraLib Common Runtime module.

TerraLib.h
An utility class to control the startup and cleanup of the TerraLib Platform and its resources.

TreeItem.h
A base class for data organized as a tree.

Visitor.h
A generic class for visitors.

te
TerraLib.
Definition: AddressGeocodingOp.h:52

Config.h
Configuration flags for the TerraLib Common Runtime module.