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

Go to the documentation of this file.

/************************************************************************************
TerraLib - a library for developing GIS applications.
Copyright © 2001-2005 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_DECODER_H
#define  __TERRALIB_INTERNAL_DECODER_H

#include "TeDefines.h"
#include "TeFactory.h"
#include "TeCoord2D.h"
#include "TeRasterParams.h"

using namespace std;
#include <string>
#include <list>
#include <map>

class TeRaster;
class TeDecoderMemory;
class TeProjection;
struct TeBox;

/* 
           A decoder keeps its own copy of the  parameters associated
           to the raster being decoded.
*/
class TL_DLL TeDecoder {

public:
           TeDecoder();


           TeDecoder(const TeRasterParams& par);

           virtual ~TeDecoder();

           TeRasterParams& params();

           void updateParams(TeRasterParams& par);


           virtual bool setElement(int col, int lin, double val, int band=0 ) = 0;

           /*
                      This method should be used only to set the values of images with 3 bands associated
                      to the three colour channes: RGB
                      \param col column of the image
                      \param lin line of the image
                      \param Rval the value associated to the band 0 (associated to the R colour Channel)
                      \param Gval the value associated to the band 1 (associated to the G colour Channel)
                      \param Bval the value associated to the band 2 (associated to the B colour Channel)
                      \param transp an optional transparency degree, with a range of 0 (totally transparent) to 255 (totally opaque)
                      \return true if if succeed and false otherwise
           */
           virtual bool setElementRGB(int col, int lin, double Rval, double Gval, double Bval, unsigned int /*transp*/ = 255);


           virtual bool getElement(int col, int lin, double& val, int band=0 ) = 0;

           virtual TeCoord2D coord2Index (const TeCoord2D &pt);

           virtual TeCoord2D index2Coord (const TeCoord2D &pt);

           /*  
               \param par the raster parameters structure
           */
           virtual void init( TeRasterParams& par );

           virtual void init() = 0;

           virtual bool clear() = 0;

           static TeDecoder* DefaultObject( const TeRasterParams& par);


           /*
                      \param bb             box        that represents the interest region
                      \param resFac         resolution factor
                      \param parBlock to return the common parameters of the blocks that are selected
                      \returns TRUE if could select at least one block and FALSE otherwise
           */
           virtual bool selectBlocks(TeBox& /* bb */, int /* resFac */, TeRasterParams& /*parBlock*/);

           virtual int numberOfSelectedBlocks();
           
           virtual bool getSelectedRasterBlock(TeDecoderMemory* /* memDec */);

           virtual void clearBlockSelection();

           /*
                      \param bb             box that represents the interest region
                      \param ncols          number of columns in the box
                      \param nlines         number of lines in the box
                      \param proj                      pointer to the projection of the box
           */
           virtual int bestResolution(TeBox& /*bb*/, int /*ncols*/, int /*nlines*/, TeProjection* /*proj*/);

           virtual int bestResolution(double /*res*/);
                      
protected:

           TeRasterParams  params_;         
};


class TL_DLL TeDecoderFactory: public TeFactory<TeDecoder,TeRasterParams> 
{
public:

           TeDecoderFactory(const string& name);

           virtual ~TeDecoderFactory();

           static TeDecoder* loadDecoder(const TeRasterParams& params);

           virtual bool acceptFile(const std::string& fileName);

           typedef map<string,string> TeNames2Decoders;

           static TeNames2Decoders& instanceName2Dec ()
           { 
                      static TeNames2Decoders names2dec_;
                      return names2dec_;
           }
};

#endif