tool_grid.cpp

Go to the documentation of this file.

//                                                       //
//                         SAGA                          //
//                                                       //
//      System for Automated Geoscientific Analyses      //
//                                                       //
//           Application Programming Interface           //
//                                                       //
//                  Library: SAGA_API                    //
//                                                       //
//-------------------------------------------------------//
//                                                       //
//                    tool_grid.cpp                      //
//                                                       //
//          Copyright (C) 2005 by Olaf Conrad            //
//                                                       //
//-------------------------------------------------------//
//                                                       //
// This file is part of 'SAGA - System for Automated     //
// Geoscientific Analyses'.                              //
//                                                       //
// 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.       //
//                                                       //
// This library is distributed in the hope that it will  //
// be useful, but WITHOUT ANY WARRANTY; without even the //
// implied warranty of MERCHANTABILITY or FITNESS FOR A  //
// PARTICULAR PURPOSE. See the GNU Lesser General Public //
// License for more details.                             //
//                                                       //
// You should have received a copy of the GNU Lesser     //
// General Public License along with this program; if    //
// not, see <http://www.gnu.org/licenses/>.              //
//                                                       //
//-------------------------------------------------------//
//                                                       //
//    contact:    Olaf Conrad                            //
//                Institute of Geography                 //
//                University of Goettingen               //
//                Goldschmidtstr. 5                      //
//                37077 Goettingen                       //
//                Germany                                //
//                                                       //
//    e-mail:     oconrad@saga-gis.org                   //
//                                                       //
 
//---------------------------------------------------------
#include "tool.h"
 

//                                                       //
//                                                       //
//                                                       //
 
//---------------------------------------------------------
CSG_Tool_Grid::CSG_Tool_Grid(void)
        : CSG_Tool()
{
        m_pLock         = NULL;
 
        Parameters.Use_Grid_System();
}
 
//---------------------------------------------------------
CSG_Tool_Grid::~CSG_Tool_Grid(void)
{
        Lock_Destroy();
}
 

//                                                       //
 
//---------------------------------------------------------
bool CSG_Tool_Grid::Set_System(const CSG_Grid_System &System)
{
        if( Parameters.Get_Grid_System() )
        {
                return( Parameters.Get_Grid_System()->Create(System) );
        }
 
        return( false );
}
 

//                                                       //
 
//---------------------------------------------------------
bool CSG_Tool_Grid::Set_Progress_Cells(sLong Cell)        const
{
        if( Get_System().is_Valid() )
        {
                return( CSG_Tool::Set_Progress((double)Cell, (double)Get_NCells() - 1.) );
        }
 
        return( is_Progress() );
}
 
//---------------------------------------------------------
bool CSG_Tool_Grid::Set_Progress_Rows(int Row)  const
{
        return( CSG_Tool::Set_Progress((double)Row, (double)Get_NY() - 1.) );
}
 

//                                                       //
 
//---------------------------------------------------------
void CSG_Tool_Grid::Lock_Create(void)
{
        if( Get_System().is_Valid() )
        {
                if( m_pLock && Get_System().is_Equal(m_pLock->Get_System()) )
                {
                        m_pLock->Assign(0.0);
                }
                else
                {
                        Lock_Destroy();
 
                        m_pLock = new CSG_Grid(
                                SG_DATATYPE_Char, Get_NX(), Get_NY(), Get_Cellsize(), Get_XMin(), Get_YMin()
                        );
                }
        }
}
 
//---------------------------------------------------------
void CSG_Tool_Grid::Lock_Destroy(void)
{
        if( m_pLock )
        {
                delete(m_pLock);
 
                m_pLock = NULL;
        }
}
 

//                                                       //
//                                                       //
//                                                       //
 
//---------------------------------------------------------