0031501: Foundation Classes, Message_Printer - remove theToPutEndl argument -- prepar...
[occt.git] / src / IGESData / IGESData_SpecificModule.hxx
1 // Created on: 1993-09-07
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_SpecificModule_HeaderFile
18 #define _IGESData_SpecificModule_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Transient.hxx>
24 #include <Standard_Integer.hxx>
25 #include <Standard_Boolean.hxx>
26 class IGESData_IGESEntity;
27 class IGESData_IGESDumper;
28
29
30 class IGESData_SpecificModule;
31 DEFINE_STANDARD_HANDLE(IGESData_SpecificModule, Standard_Transient)
32
33 //! This class defines some Services which are specifically
34 //! attached to IGES Entities : Dump
35 class IGESData_SpecificModule : public Standard_Transient
36 {
37
38 public:
39
40   
41   //! Specific Dump for each type of IGES Entity : it concerns only
42   //! own parameters, the general data (Directory Part, Lists) are
43   //! taken into account by the IGESDumper
44   //! See class IGESDumper for the rules to follow for <own> and
45   //! <attached> level
46   Standard_EXPORT virtual void OwnDump (const Standard_Integer CN, const Handle(IGESData_IGESEntity)& ent, const IGESData_IGESDumper& dumper, Standard_OStream& S, const Standard_Integer own) const = 0;
47   
48   //! Specific Automatic Correction on own Parameters of an Entity.
49   //! It works by setting in accordance redundant data, if there are
50   //! when there is no ambiguity (else, it does nothing).
51   //! Remark that classic Corrections on Directory Entry (to set
52   //! void data) are taken into account alsewhere.
53   //!
54   //! For instance, many "Associativity Entities" have a Number of
55   //! Properties which must have a fixed value.
56   //! Or, a ConicalArc has its Form Number which records the kind of
57   //! Conic, also determined from its coefficients
58   //! But, a CircularArc of which Distances (Center-Start) and
59   //! (Center-End) are not equal cannot be corrected ...
60   //!
61   //! Returns True if something has been corrected in <ent>
62   //! By default, does nothing. If at least one of the Types
63   //! processed by a sub-class of SpecificModule has a Correct
64   //! procedure attached, this method can be redefined
65   Standard_EXPORT virtual Standard_Boolean OwnCorrect (const Standard_Integer CN, const Handle(IGESData_IGESEntity)& ent) const;
66
67
68
69
70   DEFINE_STANDARD_RTTIEXT(IGESData_SpecificModule,Standard_Transient)
71
72 protected:
73
74
75
76
77 private:
78
79
80
81
82 };
83
84
85
86
87
88
89
90 #endif // _IGESData_SpecificModule_HeaderFile