0024057: Eliminate compiler warning C4100 in MSVC++ with warning level 4
[occt.git] / src / IGESSelect / IGESSelect_ViewSorter.cdl
1 -- Created on: 1994-05-31
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1994-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23 class ViewSorter  from IGESSelect  inherits TShared
24
25     ---Purpose : Sorts IGES Entities on the views and drawings.
26     --           In a first step, it splits a set of entities according the
27     --           different views they are attached to.
28     --           Then, packets according single views (+ drawing frames), or
29     --           according drawings (which refer to the views) can be determined
30     --           
31     --           It is a TShared, hence it can be a workomg field of a non-
32     --           mutable object (a Dispatch for instance)
33
34 uses Transient, HSequenceOfTransient,
35      IndexedMapOfTransient, SequenceOfInteger,
36      EntityIterator, InterfaceModel, Graph,
37      PacketList,     IGESEntity,  IGESModel
38
39 is
40
41     Create returns mutable ViewSorter;
42     ---Purpose : Creates a ViewSorter, empty. SetModel remains to be called
43
44     SetModel (me : mutable; model : IGESModel);
45     ---Purpose : Sets the Model (for PacketList)
46
47     Clear (me : mutable);
48     ---Purpose : Clears recorded data
49
50     Add      (me : mutable; ent : any Transient) returns Boolean;
51     ---Purpose : Adds an item according its type : AddEntity,AddList,AddModel
52
53     AddEntity (me : mutable; igesent : any IGESEntity) returns Boolean;
54     ---Purpose : Adds an IGES entity. Records the view it is attached to.
55     --           Records directly <ent> if it is a ViewKindEntity or a Drawing
56     --           Returns True if added, False if already in the map
57
58     AddList   (me : mutable; list : HSequenceOfTransient);
59     ---Purpose : Adds a list of entities by adding each of the items
60
61     AddModel  (me : mutable; model : InterfaceModel);
62     ---Purpose : Adds all the entities contained in a Model
63
64     NbEntities (me) returns Integer;
65     ---Purpose : Returns the count of already recorded
66
67         --  Preparations  --
68
69     SortSingleViews (me : mutable; alsoframes : Boolean);
70     ---Purpose : Prepares the result to keep only sets attached to Single Views
71     --           If <alsoframes> is given True, it keeps also the Drawings as
72     --           specific sets, in order to get their frames.
73     --           Entities attached to no single view are put in Remaining List.
74     --           
75     --           Result can then be read by the methods NbSets,SetItem,SetList,
76     --           RemainingList(final = True)
77
78     SortDrawings (me : mutable; G : Graph);
79     ---Purpose : Prepares the result to the sets attached to Drawings :
80     --           All the single views referenced by a Drawing become bound to
81     --           the set for this Drawing
82     --           
83     --           Entities or Views which correspond to no Drawing are put into
84     --           the Remaining List.
85     --           
86     --           Result can then be read by the methods NbSets,SetItem,SetList,
87     --           RemainingList(final = True)
88
89         --  Queries  --
90
91     NbSets (me; final : Boolean) returns Integer;
92     ---Purpose : Returns the count of sets recorded, one per distinct item.
93     --           The Remaining List is not counted.
94     --           If <final> is False, the sets are attached to distinct views
95     --           determined by the method Add.
96     --           If <final> is True, they are the sets determined by the last
97     --           call to, either SortSingleViews, or SortDrawings.
98     --           
99     --  Warning : Drawings directly recorded are also counted as sets, because
100     --           of their Frame (which is made of Annotations)
101
102     SetItem (me; num : Integer; final : Boolean) returns any IGESEntity;
103     ---Purpose : Returns the Item which is attached to a set of entities
104     --           For <final> and definition of sets, see method NbSets.
105     --           This item can be a kind of View or a Drawing
106
107     Sets (me; final : Boolean) returns PacketList;
108     ---Purpose : Returns the complete content of the determined Sets, which
109     --           include Duplicated and Remaining (duplication 0) lists
110     --           For <final> and definition of sets, see method NbSets.
111
112 fields
113
114     themodel   : IGESModel;
115     themap     : IndexedMapOfTransient;
116     theitems   : IndexedMapOfTransient;
117     thefinals  : IndexedMapOfTransient;
118     theinditem : SequenceOfInteger;
119     theindfin  : SequenceOfInteger;
120
121 end ViewSorter;