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 //! associates an index and a constraint for an object.
0027 //! This couple is used by AppDef_TheVariational when performing approximations.
0028 class AppParCurves_ConstraintCouple
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   //! returns an indefinite ConstraintCouple.
0034   Standard_EXPORT AppParCurves_ConstraintCouple();
0035
0036   //! Create a couple the object <Index> will have the
0037   //! constraint <Cons>.
0038   Standard_EXPORT AppParCurves_ConstraintCouple(const int                     TheIndex,
0039                                                 const AppParCurves_Constraint Cons);
0040
0041   //! returns the index of the constraint object.
0042   Standard_EXPORT int Index() const;
0043
0044   //! returns the constraint of the object.
0045   Standard_EXPORT AppParCurves_Constraint Constraint() const;
0046
0047   //! Changes the index of the constraint object.
0048   Standard_EXPORT void SetIndex(const int TheIndex);
0049
0050   //! Changes the constraint of the object.
0051   Standard_EXPORT void SetConstraint(const AppParCurves_Constraint Cons);
0052
0053 private:
0054   int                     myIndex;
0055   AppParCurves_Constraint myConstraint;
0056 };
0057
0058 #endif // _AppParCurves_ConstraintCouple_HeaderFile