0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IGESData / IGESData_GlobalSection.hxx
1 // Created on: 1992-04-06
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 _IGESData_GlobalSection_HeaderFile
18 #define _IGESData_GlobalSection_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Character.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_Real.hxx>
27 #include <Standard_Boolean.hxx>
28 class TCollection_HAsciiString;
29 class Interface_ParamSet;
30 class Interface_Check;
31 class gp_XYZ;
32
33 //! Description of a global section (corresponds to file header)
34 //! used as well in IGESModel, IGESReader and IGESWriter
35 //! Warning : From IGES-5.1, a parameter is added : LastChangeDate (concerns
36 //! transferred set of data, not the file itself)
37 //! Of course, it can be absent if read from earlier versions
38 //! (a default is then to be set to current date)
39 //! From 5.3, one more : ApplicationProtocol (optional)
40 class IGESData_GlobalSection 
41 {
42 public:
43
44   DEFINE_STANDARD_ALLOC
45
46   //! Creates an empty GlobalSection, ready to be filled,
47   //! Warning : No default value is provided
48   Standard_EXPORT IGESData_GlobalSection();
49   
50   //! Fills GlobalSection from a ParamSet (i.e. taken from file)
51   //! undefined parameters do not change default values when defined
52   //! Fills Check about Corrections or Fails
53   Standard_EXPORT void Init (const Handle(Interface_ParamSet)& params, Handle(Interface_Check)& ach);
54
55   //! Copies data referenced by Handle (that is, Strings)
56   //! useful to "isolate" a GlobalSection after copy by "="
57   //! (from a Model to another Model for instance)
58   Standard_EXPORT void CopyRefs();
59
60   //! Returns all contained data in the form of a ParamSet
61   //! Remark : Strings are given under Hollerith form
62   Standard_EXPORT Handle(Interface_ParamSet) Params() const;
63   
64   //! Returns a string withpout its Hollerith marks (nnnH ahead).
65   //! Remark : all strings stored in GlobalSection are expurged
66   //! from Hollerith information (without nnnH)
67   //! If <astr> is not Hollerith form, it is simply copied
68   Standard_EXPORT Handle(TCollection_HAsciiString) TranslatedFromHollerith (const Handle(TCollection_HAsciiString)& astr) const;
69   
70   //! Returns the parameter delimiter character.
71   Standard_EXPORT Standard_Character Separator() const;
72   
73   //! Returns the record delimiter character.
74   Standard_EXPORT Standard_Character EndMark() const;
75   
76   //! Returns the name of the sending system.
77   Standard_EXPORT Handle(TCollection_HAsciiString) SendName() const;
78   
79   //! Returns the name of the IGES file.
80   Standard_EXPORT Handle(TCollection_HAsciiString) FileName() const;
81   
82   //! Returns the Native System ID of the system that created the IGES file.
83   Standard_EXPORT Handle(TCollection_HAsciiString) SystemId() const;
84   
85   //! Returns the name of the pre-processor used to write the IGES file.
86   Standard_EXPORT Handle(TCollection_HAsciiString) InterfaceVersion() const;
87   
88   //! Returns the number of binary bits for integer representations.
89   Standard_EXPORT Standard_Integer IntegerBits() const;
90   
91   //! Returns the maximum power of a decimal representation of a
92   //! single-precision floating point number in the sending system.
93   Standard_EXPORT Standard_Integer MaxPower10Single() const;
94   
95   Standard_EXPORT Standard_Integer MaxDigitsSingle() const;
96   
97   //! Returns the maximum power of a decimal representation of a
98   //! double-precision floating point number in the sending system.
99   Standard_EXPORT Standard_Integer MaxPower10Double() const;
100   
101   Standard_EXPORT Standard_Integer MaxDigitsDouble() const;
102   
103   //! Returns the name of the receiving system.
104   Standard_EXPORT Handle(TCollection_HAsciiString) ReceiveName() const;
105   
106   //! Returns the scale used in the IGES file.
107   Standard_EXPORT Standard_Real Scale() const;
108   
109   //! Returns the unit flag that was used to write the IGES file.
110   Standard_EXPORT Standard_Integer UnitFlag() const;
111   
112   //! Returns the name of the unit the IGES file was written in.
113   Standard_EXPORT Handle(TCollection_HAsciiString) UnitName() const;
114   
115   //! Returns the maximum number of line weight gradations.
116   Standard_EXPORT Standard_Integer LineWeightGrad() const;
117   
118   //! Returns the of maximum line weight width in IGES file units.
119   Standard_EXPORT Standard_Real MaxLineWeight() const;
120   
121   //! Returns the IGES file creation date.
122   Standard_EXPORT Handle(TCollection_HAsciiString) Date() const;
123   
124   //! Returns the resolution used in the IGES file.
125   Standard_EXPORT Standard_Real Resolution() const;
126   
127   //! Returns the approximate maximum coordinate value found in the model.
128   Standard_EXPORT Standard_Real MaxCoord() const;
129   
130   //! Returns True if the approximate maximum coordinate value found in
131   //! the model is greater than 0.
132   Standard_EXPORT Standard_Boolean HasMaxCoord() const;
133   
134   //! Returns the name of the IGES file author.
135   Standard_EXPORT Handle(TCollection_HAsciiString) AuthorName() const;
136   
137   //! Returns the name of the company where the IGES file was written.
138   Standard_EXPORT Handle(TCollection_HAsciiString) CompanyName() const;
139   
140   //! Returns the IGES version that the IGES file was written in.
141   Standard_EXPORT Standard_Integer IGESVersion() const;
142   
143   Standard_EXPORT Standard_Integer DraftingStandard() const;
144   
145   //! Returns the date and time when the model was created or last
146   //! modified (for IGES 5.1 and later).
147   Standard_EXPORT Handle(TCollection_HAsciiString) LastChangeDate() const;
148   
149   //! Returns True if the date and time when the model was created or
150   //! last modified are specified, i.e. not defaulted to NULL.
151   Standard_EXPORT Standard_Boolean HasLastChangeDate() const;
152   
153   Standard_EXPORT void SetLastChangeDate();
154   
155   Standard_EXPORT Handle(TCollection_HAsciiString) ApplicationProtocol() const;
156   
157   Standard_EXPORT Standard_Boolean HasApplicationProtocol() const;
158   
159   //! Returns a string built from year,
160   //! month, day, hour, minute and second values. The form of the
161   //! resulting string is defined as follows:
162   //! -      -1: YYMMDD.HHNNSS,
163   //! -       0: YYYYMMDD.HHNNSS,
164   //! -       1: YYYY-MM-DD:HH-NN-SS, where:
165   //! - YYYY or YY is 4 or 2 digit year,
166   //! - HH is hour (00-23),
167   //! - MM is month (01-12),
168   //! - NN is minute (00-59)
169   //! - DD is day (01-31),
170   //! - SS is second (00-59).
171   Standard_EXPORT static Handle(TCollection_HAsciiString) NewDateString (const Standard_Integer year, const Standard_Integer month, const Standard_Integer day, const Standard_Integer hour, const Standard_Integer minut, const Standard_Integer second, const Standard_Integer mode = -1);
172   
173   //! Converts the string given in the
174   //! form YYMMDD.HHNNSS or YYYYMMDD.HHNNSS to either
175   //! YYMMDD.HHNNSS, YYYYMMDD.HHNNSS or YYYY-MM-DD:HH-NN-SS.
176   Standard_EXPORT static Handle(TCollection_HAsciiString) NewDateString (const Handle(TCollection_HAsciiString)& date, const Standard_Integer mode = 1);
177   
178   //! Returns the unit value (in
179   //! meters) that the IGES file was written in.
180   Standard_EXPORT Standard_Real UnitValue() const;
181   
182   Standard_EXPORT void SetSeparator (const Standard_Character val);
183   
184   Standard_EXPORT void SetEndMark (const Standard_Character val);
185   
186   Standard_EXPORT void SetSendName (const Handle(TCollection_HAsciiString)& val);
187   
188   Standard_EXPORT void SetFileName (const Handle(TCollection_HAsciiString)& val);
189   
190   Standard_EXPORT void SetSystemId (const Handle(TCollection_HAsciiString)& val);
191   
192   Standard_EXPORT void SetInterfaceVersion (const Handle(TCollection_HAsciiString)& val);
193   
194   Standard_EXPORT void SetIntegerBits (const Standard_Integer val);
195   
196   Standard_EXPORT void SetMaxPower10Single (const Standard_Integer val);
197   
198   Standard_EXPORT void SetMaxDigitsSingle (const Standard_Integer val);
199   
200   Standard_EXPORT void SetMaxPower10Double (const Standard_Integer val);
201   
202   Standard_EXPORT void SetMaxDigitsDouble (const Standard_Integer val);
203   
204   Standard_EXPORT void SetReceiveName (const Handle(TCollection_HAsciiString)& val);
205   
206   Standard_EXPORT void SetScale (const Standard_Real val);
207   
208   Standard_EXPORT void SetUnitFlag (const Standard_Integer val);
209   
210   Standard_EXPORT void SetUnitName (const Handle(TCollection_HAsciiString)& val);
211   
212   Standard_EXPORT void SetLineWeightGrad (const Standard_Integer val);
213   
214   Standard_EXPORT void SetMaxLineWeight (const Standard_Real val);
215   
216   Standard_EXPORT void SetDate (const Handle(TCollection_HAsciiString)& val);
217   
218   Standard_EXPORT void SetResolution (const Standard_Real val);
219   
220   Standard_EXPORT void SetMaxCoord (const Standard_Real val = 0.0);
221   
222   Standard_EXPORT void MaxMaxCoord (const Standard_Real val = 0.0);
223   
224   Standard_EXPORT void MaxMaxCoords (const gp_XYZ& xyz);
225   
226   Standard_EXPORT void SetAuthorName (const Handle(TCollection_HAsciiString)& val);
227   
228   Standard_EXPORT void SetCompanyName (const Handle(TCollection_HAsciiString)& val);
229   
230   Standard_EXPORT void SetIGESVersion (const Standard_Integer val);
231   
232   Standard_EXPORT void SetDraftingStandard (const Standard_Integer val);
233   
234   Standard_EXPORT void SetLastChangeDate (const Handle(TCollection_HAsciiString)& val);
235   
236   Standard_EXPORT void SetApplicationProtocol (const Handle(TCollection_HAsciiString)& val);
237
238 private:
239
240   Standard_Character theSeparator;
241   Standard_Character theEndMark;
242   Handle(TCollection_HAsciiString) theSendName;
243   Handle(TCollection_HAsciiString) theFileName;
244   Handle(TCollection_HAsciiString) theSystemId;
245   Handle(TCollection_HAsciiString) theInterfaceVersion;
246   Standard_Integer theIntegerBits;
247   Standard_Integer theMaxPower10Single;
248   Standard_Integer theMaxDigitsSingle;
249   Standard_Integer theMaxPower10Double;
250   Standard_Integer theMaxDigitsDouble;
251   Handle(TCollection_HAsciiString) theReceiveName;
252   Standard_Real theScale;
253   Standard_Integer theUnitFlag;
254   Handle(TCollection_HAsciiString) theUnitName;
255   Standard_Integer theLineWeightGrad;
256   Standard_Real theMaxLineWeight;
257   Handle(TCollection_HAsciiString) theDate;
258   Standard_Real theResolution;
259   Standard_Real theMaxCoord;
260   Standard_Boolean hasMaxCoord;
261   Handle(TCollection_HAsciiString) theAuthorName;
262   Handle(TCollection_HAsciiString) theCompanyName;
263   Standard_Integer theIGESVersion;
264   Standard_Integer theDraftingStandard;
265   Handle(TCollection_HAsciiString) theLastChangeDate;
266   Handle(TCollection_HAsciiString) theAppliProtocol;
267
268 };
269
270 #endif // _IGESData_GlobalSection_HeaderFile