src/HYDROData/HYDROData_Iterator.h

   1 #ifndef HYDROData_Iterator_HeaderFile
   2 #define HYDROData_Iterator_HeaderFile
   3
   4 #include <HYDROData_Object.h>
   5 #include <HYDROData_Document.h>
   6
   7 #include <TDF_ChildIDIterator.hxx>
   8
   9 /**\class HYDROData_Iterator
  10  * \brief Allows to iterate all objects by the document and kind of object.
  11  *
  12  * Using the document data structures, iterates through objects, filtered by
  13  * kind of this object. This class must have information about all kinds of
  14  * objects of the document: for correct iteration and creation of them.
  15  */
  16 class HYDROData_Iterator
  17 {
  18 public:
  19   /**
  20    * Initializes iterator by objects of the document.
  21    * \param theDoc document to iterate
  22    * \param theKind kind of the iterated object, can be UNKNOWN: to iterate all objects
  23    */
  24   HYDRODATA_EXPORT HYDROData_Iterator(Handle(HYDROData_Document) theDoc,
  25                                       ObjectKind theKind = KIND_UNKNOWN);
  26
  27   /**
  28    * Iterates to the next object
  29    */
  30   HYDRODATA_EXPORT void Next();
  31
  32   /**
  33    * Returns true if current object exists
  34    */
  35   HYDRODATA_EXPORT bool More() const;
  36
  37   /**
  38    * Returns the current object of the iterator.
  39    */
  40   HYDRODATA_EXPORT Handle(HYDROData_Object) Current();
  41
  42 protected:
  43
  44   friend class HYDROData_Document;
  45   friend class HYDROData_Image;
  46   friend class HYDROData_Calculation;
  47
  48   /**
  49    * Creates object in the document, call HYDROData_Document method to create
  50    * objects from other packages.
  51    * \param theDoc document where object will be located
  52    * \param theKind kind of the new object, can not be UNKNOWN
  53    */
  54   static Handle_HYDROData_Object CreateObject(
  55     Handle_HYDROData_Document theDoc, ObjectKind theKind);
  56
  57   /**
  58    * Returns object associated to the given label.
  59    */
  60   static Handle_HYDROData_Object Object(const TDF_Label theLabel);
  61
  62   TDF_ChildIDIterator myIter; ///< iterator by the objects in the document
  63 };
  64
  65 #endif