0031501: Foundation Classes, Message_Printer - remove theToPutEndl argument -- prepar...
[occt.git] / src / StepData / StepData_StepModel.hxx
1 // Created on: 1992-02-11
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-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 _StepData_StepModel_HeaderFile
18 #define _StepData_StepModel_HeaderFile
19
20 #include <Interface_EntityList.hxx>
21 #include <TColStd_HArray1OfInteger.hxx>
22 #include <Interface_InterfaceModel.hxx>
23
24 class Standard_NoSuchObject;
25 class Standard_Transient;
26 class Interface_InterfaceModel;
27 class Interface_EntityIterator;
28 class Interface_Check;
29 class TCollection_HAsciiString;
30
31 class StepData_StepModel;
32 DEFINE_STANDARD_HANDLE(StepData_StepModel, Interface_InterfaceModel)
33
34 //! Gives access to
35 //! - entities in a STEP file,
36 //! - the STEP file header.
37 class StepData_StepModel : public Interface_InterfaceModel
38 {
39
40 public:
41
42   
43   //! Creates an empty STEP model with an empty header.
44   Standard_EXPORT StepData_StepModel();
45   
46   //! returns entity given its rank.
47   //! Same as InterfaceEntity, but with a shorter name
48   Standard_EXPORT Handle(Standard_Transient) Entity (const Standard_Integer num) const;
49   
50   //! gets header from another Model (uses Header Protocol)
51   Standard_EXPORT void GetFromAnother (const Handle(Interface_InterfaceModel)& other) Standard_OVERRIDE;
52   
53   //! Returns a New Empty Model, same type as <me>, i.e. StepModel
54   Standard_EXPORT Handle(Interface_InterfaceModel) NewEmptyModel() const Standard_OVERRIDE;
55   
56   //! returns Header entities under the form of an iterator
57   Standard_EXPORT Interface_EntityIterator Header() const;
58   
59   //! says if a Header entity has a specifed type
60   Standard_EXPORT Standard_Boolean HasHeaderEntity (const Handle(Standard_Type)& atype) const;
61   
62   //! Returns Header entity with specified type, if there is
63   Standard_EXPORT Handle(Standard_Transient) HeaderEntity (const Handle(Standard_Type)& atype) const;
64   
65   //! Clears the Header
66   Standard_EXPORT void ClearHeader() Standard_OVERRIDE;
67   
68   //! Adds an Entity to the Header
69   Standard_EXPORT void AddHeaderEntity (const Handle(Standard_Transient)& ent);
70   
71   //! Specific Check, checks Header Items with HeaderProtocol
72   Standard_EXPORT virtual void VerifyCheck (Handle(Interface_Check)& ach) const Standard_OVERRIDE;
73   
74   //! Dumps the Header, with the Header Protocol of StepData.
75   //! If the Header Protocol is not defined, for each Header Entity,
76   //! prints its Type. Else sends the Header under the form of
77   //! HEADER Section of an Ascii Step File
78   //! <level> is not used because Header is not so big
79   Standard_EXPORT void DumpHeader (Standard_OStream& S, const Standard_Integer level = 0) const Standard_OVERRIDE;
80   
81   //! erases specific labels, i.e. clears the map (entity-ident)
82   Standard_EXPORT void ClearLabels() Standard_OVERRIDE;
83   
84   //! Attaches an ident to an entity to produce a label
85   //! (does nothing if <ent> is not in <me>)
86   Standard_EXPORT void SetIdentLabel (const Handle(Standard_Transient)& ent, const Standard_Integer ident);
87   
88   //! returns the label ident attached to an entity, 0 if not in me
89   Standard_EXPORT Standard_Integer IdentLabel (const Handle(Standard_Transient)& ent) const;
90   
91   //! Prints label specific to STEP norm for a given entity, i.e.
92   //! if a LabelIdent has been recorded, its value with '#', else
93   //! the number in the model with '#' and between ()
94   Standard_EXPORT void PrintLabel (const Handle(Standard_Transient)& ent, Standard_OStream& S) const Standard_OVERRIDE;
95   
96   //! Returns a string with the label attached to a given entity,
97   //! same form as for PrintLabel
98   Standard_EXPORT Handle(TCollection_HAsciiString) StringLabel (const Handle(Standard_Transient)& ent) const Standard_OVERRIDE;
99
100
101
102
103   DEFINE_STANDARD_RTTIEXT(StepData_StepModel,Interface_InterfaceModel)
104
105 protected:
106
107
108
109
110 private:
111
112
113   Interface_EntityList theheader;
114   Handle(TColStd_HArray1OfInteger) theidnums;
115
116
117 };
118
119
120
121
122
123
124
125 #endif // _StepData_StepModel_HeaderFile