E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeUtils.h

Go to the documentation of this file.

/************************************************************************************
TerraLib - a library for developing GIS applications.
Copyright  2001-2004 INPE and Tecgraf/PUC-Rio.

This code is part of the TerraLib library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

You should have received a copy of the GNU Lesser General Public
License along with this library.

The authors reassure the license terms regarding the warranties.
They specifically disclaim any warranties, including, but not limited to,
the implied warranties of merchantability and fitness for a particular purpose.
The library provided hereunder is on an "as is" basis, and the authors have no
obligation to provide maintenance, support, updates, enhancements, or modifications.
In no event shall INPE and Tecgraf / PUC-Rio be held liable to any party for direct,
indirect, special, incidental, or consequential damages arising out of the use
of this library and its documentation.
*************************************************************************************/
#ifndef  __TERRALIB_INTERNAL_UTILS_H
#define  __TERRALIB_INTERNAL_UTILS_H

#if defined(_MSC_VER) /* MSVC Compiler */
#pragma warning(disable: 4786)
#endif

#include <string>
#include <vector>
#include <cstdio>
#include <time.h>


#include "TeCoord2D.h"
#include "TeProgress.h"
#include "TeAttribute.h"
#include "TeBox.h"

class TeProjection;

using namespace std;


           TL_DLL string TeGetExtension ( const char* value );

           TL_DLL string TeGetName ( const char* value );

           TL_DLL string TeGetBaseName ( const char* value );

           TL_DLL string TeGetPath(const char* value);


           TL_DLL void TeWriteToFile(const string& fileName, const string& text, const string& mode);

           TL_DLL string Te2String ( const int value );

           TL_DLL string Te2String ( const unsigned int value );

           TL_DLL string Te2String ( const long value );
  
  TL_DLL string Te2String ( const long long int value );

           TL_DLL string Te2String ( const unsigned long value );

           TL_DLL string Te2String ( const double value, int precision );

           TL_DLL string Te2String ( const double value );


           TL_DLL void TeConvertToUpperCase ( const string& , char* );

           TL_DLL string TeConvertToUpperCase (const string &name);

           TL_DLL string TeConvertToLowerCase (const string &name);

           TL_DLL std::string TeRemoveSpecialChars ( const std::string& str);

           TL_DLL std::string TeReplaceSpecialChars ( const std::string& str);

           TL_DLL std::string TeReplaceSpecialChars ( const std::string& str,  bool& changed);

           TL_DLL bool TeRenameInvalidFieldName(TeAttributeList &attr);
  
  /*
    \param strIn Input String.
    \param separatorSymbol The symbol between the decimal string part
    and the remaining characteres.
    \param strOut Output string.
  */
  TL_DLL void TeRemoveRightDecimalZeroes( const std::string& strIn, 
    char separatorSymbol, std::string& strOut );
  

           TL_DLL void TeTrim(string &str);

           TL_DLL int TeSplitString(const string& input, const string& delimiter, vector<string>& results);

           /*
                      \params caseS flag indicating if it is a case sensitive comparation
           */
           TL_DLL bool TeStringCompare(const string& str1, const string& str2, bool caseS=false);


           /*
                      \param name                                 string to be checked
                      \param changed                   output flag to identify that string has changed
                      \param invalidChar    output or sequence of chars that are invalid in the name
                      \return the modified valid name
           */
           TL_DLL string TeCheckName(const string& name, bool& changed, string& invalidChar);

    inline int TeRound(double val)
           {          
                      if (val>=0)
                                 return (int)(val+.5);
                      else
                                 return (int)(val-.5);
           }

           TL_DLL double TeRoundD(double val, int precision=8);

           TL_DLL bool TeCompareDouble(double a, double b, int precision);

           /*
                      \param val the number to be adjusted
                      \param precision the number of decimals places to be used
                      \param reduce flag to indicate that the number should be reduced instead to increased
                      \return the adjusted number
           */
           TL_DLL double TeAdjustToPrecision(double val, int precision, bool reduce=false);

           /*
                      Raster elements have area, so raster element in upper-left position has
                      index from [-0.5,+0.5) in i and j dimension.
           */
    inline int TeRoundRasterIndex(double val)
           {          
                      int ind = (int) val;
                      if (val < (ind-0.5))
                                 ind -= 1;
                      else if (val >= (ind+0.5))
                                 ind += 1;
                      return ind;
           }
    inline double TeCubicRoot( double x )
           {
                      if( x < 0 ) {
                      return ( -1. ) * pow(  ( -1. ) * x, ( 1. / 3. ) );
                      } else {
                                 return pow(  x, ( 1. / 3. ) );
                      }
           };
           
    inline bool TeFPEquals(double d1, double d2, double precision)
           {
                      double eps1 = fabs(d1), 
                                 eps2 = fabs(d2), 
                                 eps;
                      eps = (eps1 > eps2) ? eps1 : eps2;
                      if (eps == 0.0)
                                 return true; //both numbers are 0.0
                      eps *= precision;
                      return (fabs(d1 - d2) < eps);
           }

           static inline short swaps(short value)
           {
                      short svalue = ((value & 0x00ff) << 8) | ((value >> 8) & 0x00ff);
                      return svalue;
           }
  
  TL_DLL unsigned long int TeGetFreePhysicalMemory();

  TL_DLL unsigned long int TeGetTotalPhysicalMemory();
  
  TL_DLL unsigned long int TeGetUsedVirtualMemory();

  TL_DLL unsigned long int TeGetTotalVirtualMemory();  
  
  TL_DLL unsigned int TeGetPhysProcNumber();  
    
  TL_DLL bool TeGetTempFileName( std::string& filename );    
  
  TL_DLL unsigned long int TeGetFileSize( const std::string& filename );  
  
  TL_DLL bool TeCheckFileExistence( const std::string& filename );
  
  /*
    \param path The directory path.
    \param recursive If true, a recursive search will be performed.
    \param filesnames The files names.
    \return true if OK, false on errors.
  */
  TL_DLL bool 
  TeGetDirFullFilesNames( const std::string& path,
    const bool& recursive,
    std::vector< std::string >& filesnames );  
    
  TL_DLL bool TeCopyFile( const std::string& inputFileName,
    const std::string& outputFileName );   
    
  TL_DLL bool TeCompareFiles( const std::string& inputFileName1,
    const std::string& inputFileName2 );      
    
  TL_DLL bool TeReplaceTextFileSubString( const std::string& inputFileName,
    const std::string& outputFileName, const std::string& oldSubString,
    const std::string& newSubString );    
    
  TL_DLL unsigned long int TeCreateHashFromString( 
    unsigned char const* inputString,
    const unsigned int& inputStringSize );      


  TL_DLL void TeGetEspecialCharsFixVector(std::vector<std::string> & especialIn, std::vector<std::string> & especialOut);

  TL_DLL void TeGetAccentuatedUpperVector(std::vector<std::string> & upperIn, std::vector<std::string> & upperOut);

  TL_DLL void TeGetAccentuatedLowerVector(std::vector<std::string> & lowerIn, std::vector<std::string> & lowerOut);

  TL_DLL bool TeCheckBoxConsistency(const TeBox& box, TeProjection* boxProjection);

  TL_DLL std::string TeGetUnitName(const TeUnits& units);

  TL_DLL TeUnits TeGetUnit(const std::string& unitName);

  TL_DLL double TeConvertUnits(const double& value, const TeUnits& unitFrom, const TeUnits& unitTo);

  TL_DLL bool TeFileExists(const std::string& fileName);

  TL_DLL bool TeFileCopy(const std::string& fileNameIn, const std::string& fileNameOut);

  TL_DLL bool TeFileDelete(const std::string& fileName);

  TL_DLL bool TeFileRename(const std::string& oldFileName, const std::string& newFileName);

#endif