1 #ifndef HYDROData_Iterator_HeaderFile
2 #define HYDROData_Iterator_HeaderFile
4 #include <HYDROData_Object.h>
5 #include <HYDROData_Document.h>
7 #include <TDF_ChildIDIterator.hxx>
9 /**\class HYDROData_Iterator
10 * \brief Allows to iterate all objects by the document and kind of object.
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.
16 class HYDROData_Iterator
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
24 HYDRODATA_EXPORT HYDROData_Iterator(Handle(HYDROData_Document) theDoc,
25 ObjectKind theKind = KIND_UNKNOWN);
28 * Iterates to the next object
30 HYDRODATA_EXPORT void Next();
33 * Returns true if current object exists
35 HYDRODATA_EXPORT bool More() const;
38 * Returns the current object of the iterator.
40 HYDRODATA_EXPORT Handle(HYDROData_Object) Current();
44 friend class HYDROData_Document;
45 friend class HYDROData_Image;
48 * Creates object in the document, call HYDROData_Document method to create
49 * objects from other packages.
50 * \param theDoc document where object will be located
51 * \param theKind kind of the new object, can not be UNKNOWN
53 static Handle_HYDROData_Object CreateObject(
54 Handle_HYDROData_Document theDoc, ObjectKind theKind);
57 * Returns object associated to the given label.
59 static Handle_HYDROData_Object Object(const TDF_Label theLabel);
61 TDF_ChildIDIterator myIter; ///< iterator by the objects in the document