otb::ConfigurationManager Class Reference

#include <otbConfigurationManager.h>

Public Types
typedef ::itksysFundamentalType_UInt64	RAMValueType

Static Public Member Functions
static std::string	GetDEMDirectory ()
static std::string	GetGeoidFile ()
static itk::LoggerBase::PriorityLevelType	GetLoggerLevel ()
static RAMValueType	GetMaxRAMHint ()
static int	InitOpenMPThreads ()

Private Member Functions
	ConfigurationManager ()=delete
	ConfigurationManager (const ConfigurationManager &)=delete
void	operator= (const ConfigurationManager &)=delete
	~ConfigurationManager ()=delete

Detailed Description

Retrieve configuration values from env var or default values.

This is a simple helper class to retrieve configuration values from environment variables if they are set, or from default values if not.

Please refer to each static method documentation for available configuration values and related environment variables.

Definition at line 49 of file otbConfigurationManager.h.

Member Typedef Documentation

RAMValueType

typedef ::itksysFundamentalType_UInt64 otb::ConfigurationManager::RAMValueType

Definition at line 53 of file otbConfigurationManager.h.

Constructor & Destructor Documentation

ConfigurationManager() [1/2]

otb::ConfigurationManager::ConfigurationManager ( )

privatedelete

~ConfigurationManager()

otb::ConfigurationManager::~ConfigurationManager ( )

privatedelete

ConfigurationManager() [2/2]

otb::ConfigurationManager::ConfigurationManager ( const ConfigurationManager &  )

privatedelete

Member Function Documentation

GetDEMDirectory()

static std::string otb::ConfigurationManager::GetDEMDirectory ( )

static

DEMDirectory is a directory were DEM tiles are stored.

If environment variable OTB_DEM_DIRECTORY is defined, returns it contents as a string Else, returns an empty string

GetGeoidFile()

static std::string otb::ConfigurationManager::GetGeoidFile ( )

static

GeoidFile is path to a geoid file.

If environment variable OTB_GEOID_FILE is defined, returns it contents as a string Else, returns an empty string

GetLoggerLevel()

static itk::LoggerBase::PriorityLevelType otb::ConfigurationManager::GetLoggerLevel ( )

static

Logger level controls the level of logging that OTB will output.

This is used to set-up the otb::Logger class.

If OTB_LOGGER_LEVEL environment variable is set to one of DEBUG, INFO, WARNING, CRITICAL or FATAL, the logger level will be set accordingly.

Priority is DEBUG < INFO < WARNING < CRITICAL < FATAL.

Only messages with a higher priority than the logger level will be displayed.

By default (if OTB_LOGGER_LEVEL is not set or can not be decoded), level is INFO.

GetMaxRAMHint()

static RAMValueType otb::ConfigurationManager::GetMaxRAMHint ( )

static

MaxRAMHint denotes the maximum memory OTB should use for processing, expressed in MegaBytes.

If environment variable OTB_MAX_RAM_HINT is defined and could be converted to int, return its content as a 64 bits unsigned int. Else, returns default value, which is 128 Mb

InitOpenMPThreads()

static int otb::ConfigurationManager::InitOpenMPThreads ( )

static

If OpenMP is enabled, the number of threads for openMP is set to the same number as in ITK (see GetGlobalDefaultNumberOfThreads()). This number of threads is returned. If OpenMP is disabled, this function does nothing

Referenced by main().

operator=()

void otb::ConfigurationManager::operator= ( const ConfigurationManager &  )

privatedelete

---

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

• otbConfigurationManager.h