0031501: Foundation Classes, Message_Printer - remove theToPutEndl argument -- prepar...
[occt.git] / src / IGESSelect / IGESSelect_CounterOfLevelNumber.hxx
1 // Created on: 1994-05-31
2 // Created by: Modelistation
3 // Copyright (c) 1994-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _IGESSelect_CounterOfLevelNumber_HeaderFile
18 #define _IGESSelect_CounterOfLevelNumber_HeaderFile
19
20 #include <TColStd_HArray1OfInteger.hxx>
21 #include <IFSelect_SignCounter.hxx>
22 #include <TColStd_HSequenceOfInteger.hxx>
23
24 class Interface_InterfaceModel;
25 class TCollection_HAsciiString;
26
27 class IGESSelect_CounterOfLevelNumber;
28 DEFINE_STANDARD_HANDLE(IGESSelect_CounterOfLevelNumber, IFSelect_SignCounter)
29
30 //! This class gives information about Level Number. It counts
31 //! entities according level number, considering also the
32 //! multiple level (see the class LevelList) for which an entity
33 //! is attached to each of the listed levels.
34 //!
35 //! Data are available, as level number, or as their alphanumeric
36 //! counterparts ("LEVEL nnnnnnn", " NO LEVEL", " LEVEL LIST")
37 class IGESSelect_CounterOfLevelNumber : public IFSelect_SignCounter
38 {
39
40 public:
41
42   
43   //! Creates a CounterOfLevelNumber, clear, ready to work
44   //! <withmap> and <withlist> are transmitted to SignCounter
45   Standard_EXPORT IGESSelect_CounterOfLevelNumber(const Standard_Boolean withmap = Standard_True, const Standard_Boolean withlist = Standard_False);
46   
47   //! Resets already memorized informations : also numeric data
48   Standard_EXPORT virtual void Clear() Standard_OVERRIDE;
49   
50   //! Adds an entity by considering its lrvrl number(s)
51   //! A level is added both in numeric and alphanumeric form,
52   //! i.e. LevelList gives "LEVEL LIST", others (no level or
53   //! positive level) displays level number on 7 digits (C : %7d)
54   //! Remark : an entity attached to a Level List is added for
55   //! " LEVEL LIST", and for each of its constituant levels
56   Standard_EXPORT virtual void AddSign (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) Standard_OVERRIDE;
57   
58   //! The internal action to record a new level number, positive,
59   //! null (no level) or negative (level list)
60   Standard_EXPORT void AddLevel (const Handle(Standard_Transient)& ent, const Standard_Integer level);
61   
62   //! Returns the highest value found for a level number
63   Standard_EXPORT Standard_Integer HighestLevel() const;
64   
65   //! Returns the number of times a level is used,
66   //! 0 if it has not been recorded at all
67   //! <level> = 0 counts entities attached to no level
68   //! <level> < 0 counts entities attached to a LevelList
69   Standard_EXPORT Standard_Integer NbTimesLevel (const Standard_Integer level) const;
70   
71   //! Returns the ordered list of used positive Level numbers
72   Standard_EXPORT Handle(TColStd_HSequenceOfInteger) Levels() const;
73   
74   //! Determines and returns the value of the signature for an
75   //! entity as an HAsciiString. Redefined, gives the same result
76   //! as AddSign, see this method ("LEVEL LIST" or "nnnnnnn")
77   Standard_EXPORT virtual Handle(TCollection_HAsciiString) Sign (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
78   
79   //! Prints the counts of items (not the list) then the Highest
80   //! Level Number recorded
81   Standard_EXPORT virtual void PrintCount (Standard_OStream& S) const Standard_OVERRIDE;
82
83
84
85
86   DEFINE_STANDARD_RTTIEXT(IGESSelect_CounterOfLevelNumber,IFSelect_SignCounter)
87
88 protected:
89
90
91
92
93 private:
94
95
96   Standard_Integer thehigh;
97   Standard_Integer thenblists;
98   Handle(TColStd_HArray1OfInteger) thelevels;
99
100
101 };
102
103
104
105
106
107
108
109 #endif // _IGESSelect_CounterOfLevelNumber_HeaderFile