te::common::Module Class Reference

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

#include <Module.h>

Inheritance diagram for te::common::Module:
te::common::Singleton< Module >

Static Public Member Functions

static ModulegetInstance ()
 It returns a reference to the singleton instance. More...
 

Protected Member Functions

 Module ()
 The singleton constructor will make some initializations. More...
 
 ~Module ()
 

Static Private Member Functions

static void finalize ()
 This is the cleanup function for the TerraLib Common Runtime module. More...
 
static void initialize ()
 This is the startup function for the TerraLib Common Runtime module. More...
 

Private Attributes

std::shared_ptr< TerraLib::Modulem_module
 

Static Private Attributes

static const Modulesm_module
 let's force C++ to make an static initialization. More...
 

Friends

class te::common::Singleton< Module >
 

Detailed Description

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

This class is responsible for:

  • registering the initialization and cleanup routines for the Common Runtime module if it is required.
  • start the logger configuration if TerraLib is configured to have it initialized automatically.
  • registering the Common Runtime multilingual support.

Definition at line 54 of file Module.h.

Constructor & Destructor Documentation

◆ Module()

te::common::Module::Module ( )
protected

The singleton constructor will make some initializations.

The initialization includes:

  • registering the Common Runtime module in the list of initializable modules.
  • registering the Common Runtime multilingual support.
  • Singletons initialization
  • Logger initialization when automatic static initialization is enabled.

◆ ~Module()

te::common::Module::~Module ( )
protected

Member Function Documentation

◆ finalize()

static void te::common::Module::finalize ( )
staticprivate

This is the cleanup function for the TerraLib Common Runtime module.

Note
This method doesn't perform operations for this module.

◆ getInstance()

Module & te::common::Singleton< Module >::getInstance ( )
inlinestaticinherited

It returns a reference to the singleton instance.

Returns
A reference to the singleton instance.

Definition at line 126 of file Singleton.h.

◆ initialize()

static void te::common::Module::initialize ( )
staticprivate

This is the startup function for the TerraLib Common Runtime module.

Note
This method doesn't perform operations for this module.

Friends And Related Function Documentation

◆ te::common::Singleton< Module >

friend class te::common::Singleton< Module >
friend

Definition at line 56 of file Module.h.

Member Data Documentation

◆ m_module

std::shared_ptr<TerraLib::Module> te::common::Module::m_module
private

Definition at line 103 of file Module.h.

◆ sm_module

const Module& te::common::Module::sm_module
staticprivate

let's force C++ to make an static initialization.

Definition at line 102 of file Module.h.


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