0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IGESDefs / IGESDefs_UnitsData.hxx
1 // Created on: 1993-01-13
2 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
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 _IGESDefs_UnitsData_HeaderFile
18 #define _IGESDefs_UnitsData_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Interface_HArray1OfHAsciiString.hxx>
24 #include <TColStd_HArray1OfReal.hxx>
25 #include <IGESData_IGESEntity.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Standard_Real.hxx>
28 class Standard_DimensionMismatch;
29 class Standard_OutOfRange;
30 class TCollection_HAsciiString;
31
32
33 class IGESDefs_UnitsData;
34 DEFINE_STANDARD_HANDLE(IGESDefs_UnitsData, IGESData_IGESEntity)
35
36 //! defines IGES UnitsData Entity, Type <316> Form <0>
37 //! in package IGESDefs
38 //! This class stores data about a model's fundamental units.
39 class IGESDefs_UnitsData : public IGESData_IGESEntity
40 {
41
42 public:
43
44   
45   Standard_EXPORT IGESDefs_UnitsData();
46   
47   //! This method is used to set the fields of the class
48   //! UnitsData
49   //! - unitTypes  : Types of the units being defined
50   //! - unitValues : Unit Values of the units
51   //! - unitScales : Multiplicative Scale Factors
52   //! raises exception if lengths of unitTypes, unitValues and
53   //! unitScale are not same
54   Standard_EXPORT void Init (const Handle(Interface_HArray1OfHAsciiString)& unitTypes, const Handle(Interface_HArray1OfHAsciiString)& unitValues, const Handle(TColStd_HArray1OfReal)& unitScales);
55   
56   //! returns the Number of units defined by this entity
57   Standard_EXPORT Standard_Integer NbUnits() const;
58   
59   //! returns the Type of the UnitNum'th unit being defined
60   //! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
61   Standard_EXPORT Handle(TCollection_HAsciiString) UnitType (const Standard_Integer UnitNum) const;
62   
63   //! returns the Units of the UnitNum'th unit being defined
64   //! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
65   Standard_EXPORT Handle(TCollection_HAsciiString) UnitValue (const Standard_Integer UnitNum) const;
66   
67   //! returns the multiplicative scale factor to be applied to the
68   //! UnitNum'th unit being defined
69   //! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
70   Standard_EXPORT Standard_Real ScaleFactor (const Standard_Integer UnitNum) const;
71
72
73
74
75   DEFINE_STANDARD_RTTIEXT(IGESDefs_UnitsData,IGESData_IGESEntity)
76
77 protected:
78
79
80
81
82 private:
83
84
85   Handle(Interface_HArray1OfHAsciiString) theUnitTypes;
86   Handle(Interface_HArray1OfHAsciiString) theUnitValues;
87   Handle(TColStd_HArray1OfReal) theUnitScales;
88
89
90 };
91
92
93
94
95
96
97
98 #endif // _IGESDefs_UnitsData_HeaderFile