src/DF/DF_ChildIterator.hxx

   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 DFCHILDITERATOR_HXX
  23 #define DFCHILDITERATOR_HXX
  24
  25 #include "DF_definitions.hxx"
  26 #include "DF_Label.hxx"
  27
  28 #include <string>
  29
  30 //Class DF_ChildIterator is used to iterate a tree of Labels in the Document
  31 class DF_ChildIterator {
  32 public:
  33   //Constructor
  34   Standard_EXPORT DF_ChildIterator(const DF_Label& theLabel, bool allLevels = false);
  35
  36   Standard_EXPORT DF_ChildIterator();
  37
  38   Standard_EXPORT ~DF_ChildIterator();
  39
  40   //Initializes the iterator, if allLevels is true the iterator before iterating the next
  41   //brother of the current Label iterates the Label children
  42   Standard_EXPORT void Init(const DF_Label& theLabel, bool allLevels = false);
  43
  44   //Returns a current Label
  45   Standard_EXPORT DF_Label Value();
  46
  47   //Returns true if there is a current Label
  48   Standard_EXPORT bool More();
  49
  50   //Moves to the next Label
  51   Standard_EXPORT void Next();
  52
  53 private:
  54   DF_LabelNode*    _root;
  55   DF_LabelNode*    _current;
  56   bool             _allLevels;
  57 };
  58
  59 #endif