include/opencascade/AppParCurves_ConstraintCouple.hxx

0001 // Created on: 1993-02-24
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _AppParCurves_ConstraintCouple_HeaderFile
0018 #define _AppParCurves_ConstraintCouple_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <AppParCurves_Constraint.hxx>
0025
0026
0027 //! associates an index and a constraint for an object.
0028 //! This couple is used by AppDef_TheVariational when performing approximations.
0029 class AppParCurves_ConstraintCouple
0030 {
0031 public:
0032
0033   DEFINE_STANDARD_ALLOC
0034
0035
0036   //! returns an indefinite ConstraintCouple.
0037   Standard_EXPORT AppParCurves_ConstraintCouple();
0038
0039   //! Create a couple the object <Index> will have the
0040   //! constraint <Cons>.
0041   Standard_EXPORT AppParCurves_ConstraintCouple(const Standard_Integer TheIndex, const AppParCurves_Constraint Cons);
0042
0043   //! returns the index of the constraint object.
0044   Standard_EXPORT Standard_Integer Index() const;
0045
0046   //! returns the constraint of the object.
0047   Standard_EXPORT AppParCurves_Constraint Constraint() const;
0048
0049   //! Changes the index of the constraint object.
0050   Standard_EXPORT void SetIndex (const Standard_Integer TheIndex);
0051
0052   //! Changes the constraint of the object.
0053   Standard_EXPORT void SetConstraint (const AppParCurves_Constraint Cons);
0054
0055
0056
0057
0058 protected:
0059
0060
0061
0062
0063
0064 private:
0065
0066
0067
0068   Standard_Integer myIndex;
0069   AppParCurves_Constraint myConstraint;
0070
0071
0072 };
0073
0074
0075
0076
0077
0078
0079
0080 #endif // _AppParCurves_ConstraintCouple_HeaderFile