0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / AppDef / AppDef_SmoothCriterion.hxx
1 // Created on: 1997-09-11
2 // Created by: Philippe MANGIN
3 // Copyright (c) 1997-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 _AppDef_SmoothCriterion_HeaderFile
18 #define _AppDef_SmoothCriterion_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <MMgt_TShared.hxx>
24 #include <TColStd_HArray1OfReal.hxx>
25 #include <Standard_Real.hxx>
26 #include <FEmTool_HAssemblyTable.hxx>
27 #include <TColStd_HArray2OfInteger.hxx>
28 #include <Standard_Integer.hxx>
29 #include <math_Vector.hxx>
30 #include <TColStd_Array1OfReal.hxx>
31 class Standard_NotImplemented;
32 class Standard_DomainError;
33 class FEmTool_Curve;
34 class math_Matrix;
35
36
37 class AppDef_SmoothCriterion;
38 DEFINE_STANDARD_HANDLE(AppDef_SmoothCriterion, MMgt_TShared)
39
40 //! defined criterion to smooth  points in  curve
41 class AppDef_SmoothCriterion : public MMgt_TShared
42 {
43
44 public:
45
46   
47   Standard_EXPORT virtual void SetParameters (const Handle(TColStd_HArray1OfReal)& Parameters) = 0;
48   
49   Standard_EXPORT virtual void SetCurve (const Handle(FEmTool_Curve)& C) = 0;
50   
51   Standard_EXPORT virtual void GetCurve (Handle(FEmTool_Curve)& C) const = 0;
52   
53   Standard_EXPORT virtual void SetEstimation (const Standard_Real E1, const Standard_Real E2, const Standard_Real E3) = 0;
54   
55   Standard_EXPORT virtual Standard_Real& EstLength() = 0;
56   
57   Standard_EXPORT virtual void GetEstimation (Standard_Real& E1, Standard_Real& E2, Standard_Real& E3) const = 0;
58   
59   Standard_EXPORT virtual Handle(FEmTool_HAssemblyTable) AssemblyTable() const = 0;
60   
61   Standard_EXPORT virtual Handle(TColStd_HArray2OfInteger) DependenceTable() const = 0;
62   
63   Standard_EXPORT virtual Standard_Integer QualityValues (const Standard_Real J1min, const Standard_Real J2min, const Standard_Real J3min, Standard_Real& J1, Standard_Real& J2, Standard_Real& J3) = 0;
64   
65   Standard_EXPORT virtual void ErrorValues (Standard_Real& MaxError, Standard_Real& QuadraticError, Standard_Real& AverageError) = 0;
66   
67   Standard_EXPORT virtual void Hessian (const Standard_Integer Element, const Standard_Integer Dimension1, const Standard_Integer Dimension2, math_Matrix& H) = 0;
68   
69   Standard_EXPORT virtual void Gradient (const Standard_Integer Element, const Standard_Integer Dimension, math_Vector& G) = 0;
70   
71   //! Convert the assembly Vector in an Curve;
72   Standard_EXPORT virtual void InputVector (const math_Vector& X, const Handle(FEmTool_HAssemblyTable)& AssTable) = 0;
73   
74   Standard_EXPORT virtual void SetWeight (const Standard_Real QuadraticWeight, const Standard_Real QualityWeight, const Standard_Real percentJ1, const Standard_Real percentJ2, const Standard_Real percentJ3) = 0;
75   
76   Standard_EXPORT virtual void GetWeight (Standard_Real& QuadraticWeight, Standard_Real& QualityWeight) const = 0;
77   
78   Standard_EXPORT virtual void SetWeight (const TColStd_Array1OfReal& Weight) = 0;
79
80
81
82
83   DEFINE_STANDARD_RTTIEXT(AppDef_SmoothCriterion,MMgt_TShared)
84
85 protected:
86
87
88
89
90 private:
91
92
93
94
95 };
96
97
98
99
100
101
102
103 #endif // _AppDef_SmoothCriterion_HeaderFile