src/SUIT/SUIT_DataObjectIterator.h

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 #ifndef SUIT_DATAOBJECT_ITERATOR_H
  23 #define SUIT_DATAOBJECT_ITERATOR_H
  24
  25 #include "SUIT_DataObject.h"
  26
  27 /*!
  28   \class SUIT_DataObjectIterator
  29   Provides functionality of SUIT tree detour
  30   It is possible to use "to-depth" or "to-breadth" detour and
  31   to control level detour (from left or from right)
  32 */
  33 class SUIT_EXPORT SUIT_DataObjectIterator
  34 {
  35 public:
  36   typedef enum { DepthLeft, DepthRight, BreadthLeft, BreadthRight, User } DetourType;
  37
  38   SUIT_DataObjectIterator( SUIT_DataObject* root, const int det, const bool fromTrueRoot = false );
  39
  40   virtual void      operator++();
  41   SUIT_DataObject*  current() const;
  42
  43   int               depth() const;
  44   int               detour() const;
  45
  46 protected:
  47   SUIT_DataObject*  parent( SUIT_DataObject* ) const;
  48   SUIT_DataObject*  extreme( DataObjectList&, bool FromLeft ) const;
  49   SUIT_DataObject*  globalSibling( SUIT_DataObject*, bool next ) const;
  50
  51 protected:
  52   SUIT_DataObject*  myRoot;
  53   SUIT_DataObject*  myCurrent;
  54
  55 private:
  56   SUIT_DataObject*  myExtremeChild;
  57   int               myDetourType, myCurrentLevel;
  58 };
  59
  60 /*!
  61   \class SUIT_DataObjectIterator
  62   Provides functionality of SUIT tree detour between certain levels
  63   Only "to-breadth" detour is used
  64 */
  65 class SUIT_DataObjectLevelIterator : public SUIT_DataObjectIterator
  66 {
  67 public:
  68   SUIT_DataObjectLevelIterator( SUIT_DataObject* root, const int start, const int end = 0,
  69                                   const bool LeftToRight = true );
  70   virtual void      operator++();
  71
  72 protected:
  73   int myStartLevel;
  74   int myEndLevel;
  75 };
  76
  77 #endif