0031939: Coding - correction of spelling errors in comments [part 2]
[occt.git] / tools / DFBrowser / DFBrowser_ThreadItemSearch.hxx
1 // Created on: 2017-06-16
2 // Created by: Natalia ERMOLAEVA
3 // Copyright (c) 2017 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement. 
15
16 #ifndef DFBrowser_ThreadItemSearch_H
17 #define DFBrowser_ThreadItemSearch_H
18
19 #include <inspector/DFBrowser_ThreadItem.hxx>
20 #include <inspector/DFBrowser_SearchLineModel.hxx> // to include DFBrowser_SearchItemInfo
21
22 #include <Standard.hxx>
23 #include <TDF_Label.hxx>
24
25 #include <Standard_WarningsDisable.hxx>
26 #include <QAbstractItemModel>
27 #include <QMap>
28 #include <QStringList>
29 #include <Standard_WarningsRestore.hxx>
30
31 class DFBrowser_Module;
32 class DFBrowser_SearchLine;
33 class DFBrowser_SearchLineModel;
34
35 //! \class DFBrowser_ThreadItemSearch
36 //! Iterates by OCAF application to fill internal containers with information necessary for search
37 class DFBrowser_ThreadItemSearch : public DFBrowser_ThreadItem
38 {
39 public:
40
41   //! Constructor
42   DFBrowser_ThreadItemSearch (DFBrowser_SearchLine* theSearchLine) : mySearchLine (theSearchLine) {}
43
44   //! Destructor
45   virtual ~DFBrowser_ThreadItemSearch() {}
46
47   //! Obtains the current OCAF application from the current module, iterates by all documents to fill
48   //! internal containers for search functionality
49   Standard_EXPORT virtual void Run() Standard_OVERRIDE;
50
51   //! Sets filled containers into search line
52   Standard_EXPORT virtual void ApplyValues() Standard_OVERRIDE;
53
54   //! Clears search line values
55   Standard_EXPORT static void ClearValues (DFBrowser_SearchLine* theSearchLine);
56
57 private:
58
59   //! Fills information containers by iterating through sub-labels and attributes
60   //! The method is recursive by labels.
61   //! \parm theLabel a current label, the label information is got and children and attributes information
62   //! \param theCurrentPath it contains the current path to the label (stores in container)
63   //! \param theValues container of document item values
64   //! \param theInfoValues container of document item values
65   void getLabelLines (const TDF_Label& theLabel, QStringList& theCurrentPath,
66                       QMap<QString, DFBrowser_SearchItemInfo >& theValues, QStringList& theInfoValues);
67
68   //! Adds label information into container: search will be performed by label entry
69   //! \parm theLabel a current label
70   //! \param theCurrentPath it contains the current path to the label (stores in container)
71   //! \param theValues container of document item values
72   //! \param theInfoValues container of document item values
73   void addLabel (const TDF_Label& theLabel, const QStringList& theCurrentPath,
74                  QMap<QString, DFBrowser_SearchItemInfo>& theValues, QStringList& theInfoValues);
75
76   //! Adds attribute information, it is either attribute kind or attribute value for TDataStd_Name or TDataStd_Comment
77   //! \parm theAttribute a current attribute
78   //! \param theCurrentPath it contains the current path to the label (stores in container)
79   //! \param theValues container of document item values
80   //! \param theInfoValues container of document item values
81   void addAttribute (const Handle(TDF_Attribute)& theAttribute, const QStringList& theCurrentPath,
82                      QMap<QString, DFBrowser_SearchItemInfo>& theValues, QStringList& theInfoValues);
83
84 private:
85
86   DFBrowser_SearchLine* mySearchLine; //!< class that should be filled by apply of the thread item
87   //!< a document index to container of entry/attribute name to item information
88   QMap<int, QMap<QString, DFBrowser_SearchItemInfo > > myDocumentValues;
89   QMap<int, QStringList> myDocumentInfoValues; //!< a document index to entry/attribute name
90 };
91
92
93 #endif