0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IGESDefs / IGESDefs_TabularData.hxx
1 // Created on: 1993-01-09
2 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
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_TabularData_HeaderFile
18 #define _IGESDefs_TabularData_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <TColStd_HArray1OfInteger.hxx>
25 #include <IGESData_IGESEntity.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <Standard_Real.hxx>
28 #include <TColStd_HArray1OfReal.hxx>
29 class IGESBasic_HArray1OfHArray1OfReal;
30 class Standard_DimensionMismatch;
31 class Standard_OutOfRange;
32
33
34 class IGESDefs_TabularData;
35 DEFINE_STANDARD_HANDLE(IGESDefs_TabularData, IGESData_IGESEntity)
36
37 //! Defines IGES Tabular Data, Type <406> Form <11>,
38 //! in package IGESDefs
39 //! This Class is used to provide a Structure to accommodate
40 //! point form data.
41 class IGESDefs_TabularData : public IGESData_IGESEntity
42 {
43
44 public:
45
46   
47   Standard_EXPORT IGESDefs_TabularData();
48   
49   //! This method is used to set the fields of the class
50   //! TabularData
51   //! - nbProps     : Number of property values
52   //! - propType    : Property Type
53   //! - typesInd    : Type of independent variables
54   //! - nbValuesInd : Number of values of independent variables
55   //! - valuesInd   : Values of independent variables
56   //! - valuesDep   : Values of dependent variables
57   //! raises exception if lengths of typeInd and nbValuesInd are not same
58   Standard_EXPORT void Init (const Standard_Integer nbProps, const Standard_Integer propType, const Handle(TColStd_HArray1OfInteger)& typesInd, const Handle(TColStd_HArray1OfInteger)& nbValuesInd, const Handle(IGESBasic_HArray1OfHArray1OfReal)& valuesInd, const Handle(IGESBasic_HArray1OfHArray1OfReal)& valuesDep);
59   
60   //! returns the number of property values (recorded)
61   Standard_EXPORT Standard_Integer NbPropertyValues() const;
62   
63   //! determines the number of property values required
64   Standard_EXPORT Standard_Integer ComputedNbPropertyValues() const;
65   
66   //! checks, and correct as necessary, the number of property
67   //! values. Returns True if corrected, False if already OK
68   Standard_EXPORT Standard_Boolean OwnCorrect();
69   
70   //! returns the property type
71   Standard_EXPORT Standard_Integer PropertyType() const;
72   
73   //! returns the number of dependent variables
74   Standard_EXPORT Standard_Integer NbDependents() const;
75   
76   //! returns the number of independent variables
77   Standard_EXPORT Standard_Integer NbIndependents() const;
78   
79   //! returns the type of the num'th independent variable
80   //! raises exception if num <= 0 or num > NbIndependents()
81   Standard_EXPORT Standard_Integer TypeOfIndependents (const Standard_Integer num) const;
82   
83   //! returns the number of different values of the num'th indep. variable
84   //! raises exception if num <= 0 or num > NbIndependents()
85   Standard_EXPORT Standard_Integer NbValues (const Standard_Integer num) const;
86   
87   Standard_EXPORT Standard_Real IndependentValue (const Standard_Integer variablenum, const Standard_Integer valuenum) const;
88   
89   Standard_EXPORT Handle(TColStd_HArray1OfReal) DependentValues (const Standard_Integer num) const;
90   
91   Standard_EXPORT Standard_Real DependentValue (const Standard_Integer variablenum, const Standard_Integer valuenum) const;
92
93
94
95
96   DEFINE_STANDARD_RTTIEXT(IGESDefs_TabularData,IGESData_IGESEntity)
97
98 protected:
99
100
101
102
103 private:
104
105
106   Standard_Integer theNbPropertyValues;
107   Standard_Integer thePropertyType;
108   Handle(TColStd_HArray1OfInteger) theTypeOfIndependentVariables;
109   Handle(TColStd_HArray1OfInteger) theNbValues;
110   Handle(IGESBasic_HArray1OfHArray1OfReal) theIndependentValues;
111   Handle(IGESBasic_HArray1OfHArray1OfReal) theDependentValues;
112
113
114 };
115
116
117
118
119
120
121
122 #endif // _IGESDefs_TabularData_HeaderFile