te::qt::widgets::SymbolLibraryManager Class Reference

The SymbolLibraryManager is a singleton that can be used to manage all loaded symbol libraries in TerraLib. More...

#include <SymbolLibraryManager.h>

Inheritance diagram for te::qt::widgets::SymbolLibraryManager:
te::common::Singleton< T >

Public Member Functions

 ~SymbolLibraryManager ()
 Destructor. More...
 
SymbolLibraryManager Accessor Method

Method used to access the data stored on this manager.

void insert (SymbolLibrary *library)
 It inserts a new symbol library that will be managed by SymbolLibraryManager. More...
 
void remove (SymbolLibrary *library)
 It removes the symbol library from the manager. More...
 
SymbolLibraryfindByName (const std::string &name) const
 It returns the symbol library identified by a given name or NULL if none is found. More...
 
std::pair< std::map< std::string, SymbolLibrary * >::const_iterator, std::map< std::string, SymbolLibrary * >::const_iterator > getIterator () const
 It returns a pair of iterators over the symbol libraries of this manager. More...
 
void clear ()
 It unloads all symbol libraries managed by SymbolLibraryManager. More...
 

Static Public Member Functions

static T & getInstance ()
 It returns a reference to the singleton instance. More...
 

Protected Member Functions

 SymbolLibraryManager ()
 It initializes the Singleton. More...
 

Private Attributes

std::map< std::string, SymbolLibrary * > m_symbolLibraryMap
 The set of symbol libraries. More...
 

Friends

class te::common::Singleton< SymbolLibraryManager >
 

Detailed Description

The SymbolLibraryManager is a singleton that can be used to manage all loaded symbol libraries in TerraLib.

See also
Symbol, SymbolLibrary, Singleton

Definition at line 53 of file SymbolLibraryManager.h.

Constructor & Destructor Documentation

te::qt::widgets::SymbolLibraryManager::~SymbolLibraryManager ( )

Destructor.

te::qt::widgets::SymbolLibraryManager::SymbolLibraryManager ( )
protected

It initializes the Singleton.

Member Function Documentation

void te::qt::widgets::SymbolLibraryManager::clear ( )

It unloads all symbol libraries managed by SymbolLibraryManager.

SymbolLibrary* te::qt::widgets::SymbolLibraryManager::findByName ( const std::string &  name) const

It returns the symbol library identified by a given name or NULL if none is found.

Parameters
nameThe name of the symbol library we are looking for.
Returns
A pointer to a symbol library or NULL if none is found.
template<class T >
T & te::common::Singleton< T >::getInstance ( )
inlinestaticinherited

It returns a reference to the singleton instance.

Returns
A reference to the singleton instance.

Definition at line 120 of file Singleton.h.

std::pair<std::map<std::string, SymbolLibrary*>::const_iterator, std::map<std::string, SymbolLibrary*>::const_iterator> te::qt::widgets::SymbolLibraryManager::getIterator ( ) const

It returns a pair of iterators over the symbol libraries of this manager.

Returns
A pair of iterators over the symbol libraries of this manager where pair.first will be the beginning and pair.second will be the end iterator.
void te::qt::widgets::SymbolLibraryManager::insert ( SymbolLibrary library)

It inserts a new symbol library that will be managed by SymbolLibraryManager.

Parameters
libraryThe new symbol library to be managed by this manager.
void te::qt::widgets::SymbolLibraryManager::remove ( SymbolLibrary library)

It removes the symbol library from the manager.

Parameters
libraryThe symbol library to be removed.
Exceptions
ExceptionIf the symbol library doesn't exist it will raise an exception.

Friends And Related Function Documentation

Definition at line 55 of file SymbolLibraryManager.h.

Member Data Documentation

std::map<std::string, SymbolLibrary*> te::qt::widgets::SymbolLibraryManager::m_symbolLibraryMap
private

The set of symbol libraries.

Definition at line 113 of file SymbolLibraryManager.h.


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