Namespaces
namespace	plugin

Classes
class	AbstractPlugin
	The base class for plugins in TerraLib. More...

class	AbstractPluginEngine
	The base class for plugin engines. More...

class	CharEncoding
	A class for handling character enconding/decoding. More...

class	CppPlugin
	The base class for C++ plugins. More...

class	CppPluginEngine

class	CppPluginProxy
	A proxy class for C++ plugins. More...

struct	Exception
	Base exception class for TerraLib Core Runtime Library. More...

class	FileSystem
	A class for handling system files and paths using UTF-8 strings. More...

class	FileWatcher

struct	HostApplication
	Describe the host system. More...

struct	Info
	Basic information about a module. More...

class	Library
	A class for handling shared libraries (DLLs, SO, DyLibs). More...

struct	LibraryEntry

struct	LibraryInvalidSearchPathException
	An exception indicating an error when adding a given path to the operational system search library path. More...

struct	LibraryLoadException
	An exception indicating an error when loading a shared library. More...

class	LibraryManager
	A singleton that can be used to observe the available libraries in the system. More...

struct	LibraryNameException
	An execption indicating an error when the library name is empty. More...

struct	LibraryResetSearchPathException
	An exception indicating an error when reseting the operational system search library path. More...

struct	LibrarySearchPathException
	An exception indicating the operational system search library path was not found. More...

struct	LibrarySymbolNotFoundException
	An exception indicating an error when searching for a given symbol in a shared library. More...

struct	LibraryUnloadException
	An exception indicating an error when releasing a shared library. More...

class	Logger

struct	PluginCyclicDependencyException
	An exception indicating an error when two or more plugins have cyclic dependecy. More...

struct	PluginEngineLoadException
	An exception indicating an error when loading a plugin. More...

class	PluginEngineManager
	A singleton that can be used to register plugin engines. More...

struct	PluginEngineUnloadException
	An exception indicating an error when releasing a given plugin. More...

struct	PluginHasDependentException
	An exception indicating an error when trying to shutdown a plugin with a dependent. More...

struct	PluginInfo
	Basic information about a plugin. More...

struct	PluginLoadException
	An exception indicating an error when loading a plugin. More...

class	PluginManager
	A singleton for managing plugins. More...

struct	PluginMissingDependencyException
	An exception indicating an error when a dependecy is missing. More...

struct	PluginShutdownException
	An exception indicating an error when shutting down a plugin. More...

struct	PluginStartupException
	An exception indicating an error when trying to start a plugin. More...

struct	PluginUnloadException
	An exception indicating an error when unloading a plugin. More...

struct	Provider
	Describe the module provider. More...

class	Proxy

class	ProxyAuthenticationHandler

class	ProxyInfo

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

class	Translator
	This singleton is designed to deal with multi-language text translation in TerraLib. More...

class	URI
	A class to store the proxy information that must be used to access data located in URIs. More...

struct	URIException
	Base exception for DataRetrieverWCS. More...

Typedefs
typedef boost::function0< void >	CleanupFnct

typedef std::pair< std::string, std::string >	Parameter

typedef std::pair< std::string, std::string >	Resource

typedef boost::function0< void >	StartupFnct

typedef CppPlugin (	te_get_plugin_fnct_t) (const PluginInfo &pinfo)
	The type of function for plugin's entry point.

Enumerations
enum class	EncodingType { UTF8 , CP1250 , CP1251 , CP1252 , CP1253 , CP1254 , CP1257 , LATIN1 }
	Supported character encodings. More...

Functions
TECOREEXPORT std::string	ASCIIToHex (const std::string &text)

char *	Binary2Hex (const char *s, std::size_t size)
	Each char from the array of characters in binary format is converted into a pair of hex characters. The final string is NULL terminated.

void	Binary2Hex (const char s, std::size_t size, char outBuff)
	Each char from the array of characters in binary format is converted into a pair of hex characters. The final string is NULL terminated.

void	Char2Hex (unsigned char c, char *r)
	It converts the character to a hex representation.

TECOREEXPORT std::string	decodeBase64 (const std::string &val)

TECOREEXPORT std::vector< PluginInfo >	DefaultPluginFinder ()

TECOREEXPORT std::string	encodeBase64 (const std::string &val)

TECOREEXPORT std::map< std::string, std::string >	Expand (const std::string &query_str)
	Split a query string into its components.

TECOREEXPORT std::string	FindInTerraLibPath (const std::string &path)
	Returns the path relative to a directory or file in the context of TerraLib.

TECOREEXPORT std::string	GetAppDataLocation ()
	It returns the writable folder location to store application data applied to all users.

TECOREEXPORT std::string	GetAppLocalDataLocation ()
	It returns the writable folder location to store per user data.

unsigned char	GetDecimalFromHexLCase (char hexValue)
	It returns the decimal value in a char from a given hex value (for example: 'a' => 10, '8' => 8).

unsigned char	GetDecimalFromHexNotCS (unsigned char hexValue)
	It returns the decimal value in a char from a given hex value (for example: 'A' => 10, '8' => 8).

unsigned char	GetDecimalFromHexUCase (char hexValue)
	It returns the decimal value in a char from a given hex value (for example: 'A' => 10, '8' => 8).

TECOREEXPORT std::string	GetEnv (const std::string &key)
	Gets the value of the given key in the session environment variables.

TECOREEXPORT std::string	GetUserDirectory ()
	Returns the system user home dir path.

char *	Hex2Binary (const char *hex)
	It converts each pair of hex characters from a NULL-terminated string of hex characters into a binary format.

void	Hex2Binary (const char hex, std::size_t hSize, char outBuff)
	It converts each pair of hex characters from an input string of hex characters into a binary format.

char *	Hex2Binary2 (const char *hex)
	It converts each pair of hex characters from a NULL-terminated string of hex characters into a binary format.

void	Hex2Binary2 (const char hex, std::size_t hSize, char outBuff)
	It converts each pair of hex characters from an input string of hex characters into a binary format.

char	Hex2Char (const char *hex)
	It converts the character from a hex representation to a byte.

unsigned char	Hex2Char2 (const char *hex)
	It converts the character from a hex representation to a byte.

TECOREEXPORT std::string	HexToASCII (const std::string &text)

TECOREEXPORT PluginInfo	JSONPluginInfoSerializer (const std::string &file_name)
	A plugin finder that search for plugins in some special directories defined by compile time macros.

TECOREEXPORT std::vector< PluginInfo >	PluginFinder (const std::vector< std::string > &dirs)

TECOREEXPORT bool	SetEnv (const std::string &key, const std::string &value)
	Sets the given key/value to the session environment variables.

TECOREEXPORT std::string	SetURIParameter (const std::string &srcUri, const std::string &key, const std::string &value)
	Sets the given key and value to the given URI. If the key already exists, it will be replaced. If the key does not exists, it will be added.

TECOREEXPORT std::string	URIConvertASCIIToHex (const std::string &connInfo)

TECOREEXPORT std::string	URIConvertHexToASCII (const std::string &connInfo)

TECOREEXPORT std::string	URIDecode (const std::string &srcUri)
	Decodes an encoded URI. The algorithm implementation is based on http://www.codeguru.com/cpp/cpp/algorithms/strings/article.php/c12759/URI-Encoding-and-Decoding.htm.

TECOREEXPORT std::string	URIEncode (const std::string &srcUri)
	Encodes an decoded URI. The algorithm implementation is based on http://www.codeguru.com/cpp/cpp/algorithms/strings/article.php/c12759/URI-Encoding-and-Decoding.htm.

Typedef Documentation

◆ CleanupFnct

typedef boost::function0<void> te::core::CleanupFnct

Definition at line 58 of file LibraryManager.h.

◆ Parameter

typedef std::pair< std::string, std::string > te::core::Parameter

Definition at line 62 of file LibraryInfo.h.

◆ Resource

typedef std::pair< std::string, std::string > te::core::Resource

Definition at line 60 of file LibraryInfo.h.

◆ StartupFnct

typedef boost::function0<void> te::core::StartupFnct

Definition at line 51 of file LibraryManager.h.

◆ te_get_plugin_fnct_t

typedef CppPlugin *(* te::core::te_get_plugin_fnct_t) (const PluginInfo &pinfo)

The type of function for plugin's entry point.

Definition at line 77 of file CppPlugin.h.

Enumeration Type Documentation

◆ EncodingType

enum class te::core::EncodingType

strong

Supported character encodings.

Enumerator
UTF8	UTF-8 encoding.
CP1250	CP1250 encoding.
CP1251	CP1251 encoding.
CP1252	CP1252 encoding.
CP1253	CP1253 encoding.
CP1254	CP1254 encoding.
CP1257	CP1257 encoding.
LATIN1	Latin1 encoding (ISO8859-1).

Definition at line 50 of file CharEncoding.h.

Function Documentation

◆ ASCIIToHex()

TECOREEXPORT std::string te::core::ASCIIToHex ( const std::string & text )

◆ Binary2Hex() [1/2]

char * te::core::Binary2Hex	(	const char *	s,
		std::size_t	size
	)

inline

Each char from the array of characters in binary format is converted into a pair of hex characters. The final string is NULL terminated.

Parameters

s	An array of characters in binary format.
size	The size of the string of characters (not including the trailing '\0').

Note: The caller of this function will take the ownership of the returned pointer, so it must delete it. Use delete [] returned_pointer.; The returned buffer size is: 2 * size + 1.

Definition at line 602 of file HexUtils.h.

References Char2Hex().

◆ Binary2Hex() [2/2]

void te::core::Binary2Hex	(	const char *	s,
		std::size_t	size,
		char *	outBuff
	)

inline

Each char from the array of characters in binary format is converted into a pair of hex characters. The final string is NULL terminated.

Parameters

s	An array of characters in binary format.
size	The size of the string of characters (not including the trailing '\0').
outBuff	A pointer to a pre-allocated buffer where to output the binary version. It must have at least 2*size+1 bytes.

Definition at line 623 of file HexUtils.h.

References Char2Hex().

◆ Char2Hex()

void te::core::Char2Hex	(	unsigned char	c,
		char *	r
	)

inline

It converts the character to a hex representation.

Parameters

c	The byte to be transformed to hex representation.
r	The resulting hex encoding will be write in the r pointer.

Note: It is used by Binary2Hex function.

Definition at line 248 of file HexUtils.h.

Referenced by Binary2Hex(), and Binary2Hex().

◆ decodeBase64()

TECOREEXPORT std::string te::core::decodeBase64 ( const std::string & val )

◆ DefaultPluginFinder()

TECOREEXPORT std::vector< PluginInfo > te::core::DefaultPluginFinder ( )

A plugin finder that search for plugins in some special directories defined by compile time macros.

◆ encodeBase64()

TECOREEXPORT std::string te::core::encodeBase64 ( const std::string & val )

◆ Expand()

TECOREEXPORT std::map< std::string, std::string > te::core::Expand ( const std::string & query_str )

Split a query string into its components.

Parameters

query_str The query string that will have the data extracted.

Exceptions

Exception An exception can be thrown, if a parser error occurs during decomposition of the query string.

Returns: A container with the key-value pairs extracted from the query string.

◆ FindInTerraLibPath()

TECOREEXPORT std::string te::core::FindInTerraLibPath ( const std::string & path )

Returns the path relative to a directory or file in the context of TerraLib.

Parameters

path	A path to be searched in the TerraLib context.

Returns: A complete path to the file or directory if it is found, otherwise returns an empty string.

◆ GetAppDataLocation()

TECOREEXPORT std::string te::core::GetAppDataLocation ( )

It returns the writable folder location to store application data applied to all users.

Returns: The folder location to store application data applied to all users.

◆ GetAppLocalDataLocation()

TECOREEXPORT std::string te::core::GetAppLocalDataLocation ( )

It returns the writable folder location to store per user data.

Returns: The folder location to store per user data.

◆ GetDecimalFromHexLCase()

unsigned char te::core::GetDecimalFromHexLCase ( char hexValue )

inline

It returns the decimal value in a char from a given hex value (for example: 'a' => 10, '8' => 8).

Parameters

hexValue The hex value we want to extract the decimal value.

Returns: The decimal value in a char from a given hex value (for example: 'a' => 10, '8' => 8).

Note: This version is lower case sensitive, i. e., 'a' will return 10 and 'A' will return a wrong value.

Definition at line 185 of file HexUtils.h.

◆ GetDecimalFromHexNotCS()

unsigned char te::core::GetDecimalFromHexNotCS ( unsigned char hexValue )

inline

It returns the decimal value in a char from a given hex value (for example: 'A' => 10, '8' => 8).

Parameters

hexValue The hex value we want to extract the decimal value.

Returns: The decimal value in a char from a given hex value (for example: 'A' => 10, '8' => 8).

Note: This version is not case sensitive, i. e., 'A' and 'a' will return 10.

Definition at line 49 of file HexUtils.h.

Referenced by te::color::RGBAColor::setColor().

◆ GetDecimalFromHexUCase()

unsigned char te::core::GetDecimalFromHexUCase ( char hexValue )

inline

It returns the decimal value in a char from a given hex value (for example: 'A' => 10, '8' => 8).

Parameters

hexValue The hex value we want to extract the decimal value.

Returns: The decimal value in a char from a given hex value (for example: 'A' => 10, '8' => 8).

Note: This version is upper case sensitive, i. e., 'A' will return 10 and 'a' will return a wrong value.

Definition at line 119 of file HexUtils.h.

◆ GetEnv()

TECOREEXPORT std::string te::core::GetEnv ( const std::string & key )

Gets the value of the given key in the session environment variables.

Returns: The result of the set

◆ GetUserDirectory()

TECOREEXPORT std::string te::core::GetUserDirectory ( )

Returns the system user home dir path.

Returns: Returns the system user home dir path.

Note: An empty string will be returned on errors.

◆ Hex2Binary() [1/2]

char * te::core::Hex2Binary ( const char * hex )

inline

It converts each pair of hex characters from a NULL-terminated string of hex characters into a binary format.

This function can be used, for example, to decode the returned geometry from PostGIS.

Parameters

hex	A NULL-terminated string of hexadecimal characters.

Returns: An array of binary characters in binary format.

Note: The size of the returned array is the half of the input array.; The caller of this function will take the ownership of the returned pointer, so it must delete it. Use delete [] returned_pointer.

Definition at line 469 of file HexUtils.h.

◆ Hex2Binary() [2/2]

void te::core::Hex2Binary	(	const char *	hex,
		std::size_t	hSize,
		char *	outBuff
	)

inline

It converts each pair of hex characters from an input string of hex characters into a binary format.

This version can be used for those who wants to pre-allocate the memory where the parsed version will be output.

Parameters

hex	A string of hexadecimal characters.
hSize	The number of bytes in the input string. Remember that it must be a multiple of 2.
outBuff	A pointer to a pre-allocated buffer where to output the binary version. It must have at least hSize/2 bytes.

Note: The size of the input buffer (outBuff) must be at least the half of the input array.; The outBuff can be the same as the input buffer; in this case the input will be overwritten.

Definition at line 515 of file HexUtils.h.

◆ Hex2Binary2() [1/2]

char * te::core::Hex2Binary2 ( const char * hex )

inline

It converts each pair of hex characters from a NULL-terminated string of hex characters into a binary format.

This function can be used, for example, to decode the returned geometry from PostGIS.

Parameters

hex	A NULL-terminated string of hexadecimal characters.

Returns: An array of binary characters in binary format.

Note: The size of the returned array is the half of the input array.; The caller of this function will take the ownership of the returned pointer, so it must delete it. Use delete [] returned_pointer.

Warning: In our tests, this version was slower than the other equivalent.

Definition at line 557 of file HexUtils.h.

References Hex2Char2().

◆ Hex2Binary2() [2/2]

void te::core::Hex2Binary2	(	const char *	hex,
		std::size_t	hSize,
		char *	outBuff
	)

inline

It converts each pair of hex characters from an input string of hex characters into a binary format.

This version can be used for those who wants to pre-allocate the memory where the parsed version will be output.

Parameters

hex	A string of hexadecimal characters.
hSize	The number of bytes in the input string. Remember that it must be a multiple of 2.
outBuff	A pointer to a pre-allocated buffer where to output the binary version. It must have at least hSize/2 bytes.

Note: The size of the input buffer (outBuff) must be at least the half of the input array.

Definition at line 583 of file HexUtils.h.

References Hex2Char2().

◆ Hex2Char()

char te::core::Hex2Char ( const char * hex )

inline

It converts the character from a hex representation to a byte.

Parameters

h	At least a pair of bytes to be transformed from a hex representation.

Note: It is used by Hex2Binary function.

Returns: A byte representation from a two bytes hex representation.

Definition at line 270 of file HexUtils.h.

◆ Hex2Char2()

unsigned char te::core::Hex2Char2 ( const char * hex )

inline

It converts the character from a hex representation to a byte.

Parameters

h	At least a pair of bytes to be transformed from a hex representation.

Note: It is used by Hex2Binary function.

Returns: A byte representation from a two bytes hex representation.

Warning: In our tests, this version was slower than the other.

Definition at line 301 of file HexUtils.h.

Referenced by Hex2Binary2(), and Hex2Binary2().

◆ HexToASCII()

TECOREEXPORT std::string te::core::HexToASCII ( const std::string & text )

◆ JSONPluginInfoSerializer()

TECOREEXPORT PluginInfo te::core::JSONPluginInfoSerializer ( const std::string & file_name )

A plugin finder that search for plugins in some special directories defined by compile time macros.

Exceptions

InvalidArgumentException if the given file_name doesn't exist

◆ PluginFinder()

TECOREEXPORT std::vector< PluginInfo > te::core::PluginFinder ( const std::vector< std::string > & dirs )

A plugin finder that search for plugins in some special directories defined by configuration file.

◆ SetEnv()

TECOREEXPORT bool te::core::SetEnv	(	const std::string &	key,
		const std::string &	value
	)

Sets the given key/value to the session environment variables.

Returns: The result of the set

◆ SetURIParameter()

TECOREEXPORT std::string te::core::SetURIParameter	(	const std::string &	srcUri,
		const std::string &	key,
		const std::string &	value
	)

Sets the given key and value to the given URI. If the key already exists, it will be replaced. If the key does not exists, it will be added.

Parameters

srcUri	The input URI
key	The key to be added or replaced
value	The new value

Returns: A string with the adjusted URI.

◆ URIConvertASCIIToHex()

TECOREEXPORT std::string te::core::URIConvertASCIIToHex ( const std::string & connInfo )

◆ URIConvertHexToASCII()

TECOREEXPORT std::string te::core::URIConvertHexToASCII ( const std::string & connInfo )

◆ URIDecode()

TECOREEXPORT std::string te::core::URIDecode ( const std::string & srcUri )

Decodes an encoded URI. The algorithm implementation is based on http://www.codeguru.com/cpp/cpp/algorithms/strings/article.php/c12759/URI-Encoding-and-Decoding.htm.

Parameters

srcUri URI to be decoded

Returns: A string with decoded URI.

◆ URIEncode()

TECOREEXPORT std::string te::core::URIEncode ( const std::string & srcUri )

Encodes an decoded URI. The algorithm implementation is based on http://www.codeguru.com/cpp/cpp/algorithms/strings/article.php/c12759/URI-Encoding-and-Decoding.htm.

Parameters

srcUri URI to be encoded

Returns: A string with encoded URI.

Namespaces

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ CleanupFnct

◆ Parameter

◆ Resource

◆ StartupFnct

◆ te_get_plugin_fnct_t

Enumeration Type Documentation

◆ EncodingType

Function Documentation

◆ ASCIIToHex()

◆ Binary2Hex() [1/2]

◆ Binary2Hex() [2/2]

◆ Char2Hex()

◆ decodeBase64()

◆ DefaultPluginFinder()

◆ encodeBase64()

◆ Expand()

◆ FindInTerraLibPath()

◆ GetAppDataLocation()

◆ GetAppLocalDataLocation()

◆ GetDecimalFromHexLCase()

◆ GetDecimalFromHexNotCS()

◆ GetDecimalFromHexUCase()

◆ GetEnv()

◆ GetUserDirectory()

◆ Hex2Binary() [1/2]

◆ Hex2Binary() [2/2]

◆ Hex2Binary2() [1/2]

◆ Hex2Binary2() [2/2]

◆ Hex2Char()

◆ Hex2Char2()

◆ HexToASCII()

◆ JSONPluginInfoSerializer()

◆ PluginFinder()

◆ SetEnv()

◆ SetURIParameter()

◆ URIConvertASCIIToHex()

◆ URIConvertHexToASCII()

◆ URIDecode()

◆ URIEncode()