0031501: Foundation Classes, Message_Printer - remove theToPutEndl argument -- prepar...
[occt.git] / src / IGESData / IGESData_IGESDumper.hxx
1 // Created on: 1993-09-06
2 // Created by: Christian CAILLET
3 // Copyright (c) 1993-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 _IGESData_IGESDumper_HeaderFile
18 #define _IGESData_IGESDumper_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <IGESData_SpecificLib.hxx>
25 #include <Standard_Integer.hxx>
26 class IGESData_IGESModel;
27 class Interface_InterfaceError;
28 class IGESData_Protocol;
29 class IGESData_IGESEntity;
30
31 //! Provides a way to obtain a clear Dump of an IGESEntity
32 //! (distinct from normalized output). It works with tools
33 //! attached to Entities, as for normalized Reade and Write
34 //!
35 //! For each Entity, displaying data is splitted in own data
36 //! (specific to each type) and other attached data, which are
37 //! defined for all IGES Types (either from "Directory Entry" or
38 //! from Lists of Associativities and Properties)
39 class IGESData_IGESDumper 
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   
46   //! Returns an IGESDumper ready to work. The IGESModel provides
47   //! the numbering of Entities : as for any InterfaceModel, it
48   //! gives each Entity a number; but for IGESEntities, the "Number
49   //! of Directory Entry" according to the definition of IGES Files,
50   //! is also usefull
51   Standard_EXPORT IGESData_IGESDumper(const Handle(IGESData_IGESModel)& model, const Handle(IGESData_Protocol)& protocol);
52   
53   //! Prints onto an output, the "Number of Directory Entry" which
54   //! corresponds to an IGESEntity in the IGESModel, under the form
55   //! "D#nnn" (a Null Handle gives D#0)
56   Standard_EXPORT void PrintDNum (const Handle(IGESData_IGESEntity)& ent, Standard_OStream& S) const;
57   
58   //! Prints onto an output, the "Number of Directory Entry" (see
59   //! PrintDNum) plus IGES Type and Form Numbers, which gives
60   //! "D#nnn  Type nnn  Form nnn"
61   Standard_EXPORT void PrintShort (const Handle(IGESData_IGESEntity)& ent, Standard_OStream& S) const;
62   
63   Standard_EXPORT void Dump (const Handle(IGESData_IGESEntity)& ent, Standard_OStream& S, const Standard_Integer own, const Standard_Integer attached = -1) const;
64   
65   //! Specific Dump for each IGES Entity, call by Dump (just above)
66   //! <own> is the parameter <own> from Dump
67   Standard_EXPORT void OwnDump (const Handle(IGESData_IGESEntity)& ent, Standard_OStream& S, const Standard_Integer own) const;
68
69
70
71
72 protected:
73
74
75
76
77
78 private:
79
80
81
82   Handle(IGESData_IGESModel) themodel;
83   IGESData_SpecificLib thelib;
84
85
86 };
87
88
89
90
91
92
93
94 #endif // _IGESData_IGESDumper_HeaderFile