AddDeepAttribute.h

Go to the documentation of this file.

/*  Copyright (C) 2001-2009 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

    TerraLib 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 3 of the License,
    or (at your option) any later version.

    TerraLib 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 TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
  \file AddDeepAttribute.h

  \brief This class defines a function used to add to a graph the deep information attribute

*/

#ifndef __TERRALIB_GRAPH_INTERNAL_ADDDEEPATTRIBUTE_H
#define __TERRALIB_GRAPH_INTERNAL_ADDDEEPATTRIBUTE_H

// Terralib Includes
#include "../Config.h"


// STL Includes
#include <string>
#include <set>

namespace te
{
  namespace graph
  {
    // Forward declaration
    class BidirectionalGraph;
    class Vertex;

    /*!
      \class AddDeepAttribute

      \brief This class defines a function used to add to a graph the deep information attribute

    */

    class TEGRAPHEXPORT AddDeepAttribute
    {
      public:

        /*! 
          \brief Default constructor. 

          \param graph    Pointer to a bidirectional graph

          \param  attributeName The name used to represent the deep attribute 
        
        */
        AddDeepAttribute(te::graph::BidirectionalGraph* graph, std::string attributeName);

        /*! \brief Virtual destructor. */
        virtual ~AddDeepAttribute();


      protected:

         /*!
          \brief Recursive function used to calculate the deep attribute

          \param v              Current vertex in processing

          \param g              The bidirection graph 

          \param deepValue     Current value for deep attribute calculated

          \param vertexIdSet   The set of vertex already visited
        */
        void calculateDeepValue(te::graph::Vertex* v, te::graph::BidirectionalGraph* g, int& deepValue, std::set<int>& vertexIdSet);

    };

  } // end namespace graph
} // end namespace te

#endif // __TERRALIB_GRAPH_INTERNAL_ADDDEEPATTRIBUTE_H