0024428: Implementation of LGPL license
[occt.git] / src / AppParCurves / AppParCurves_ConstraintCouple.cdl
1 -- Created on: 1993-02-24
2 -- Created by: Laurent PAINNOT
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
9 -- under the terms of the GNU Lesser General Public 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 class ConstraintCouple from AppParCurves
18             ---Purpose: associates an index and a constraint for an object.
19             -- This couple is used by AppDef_TheVariational when performing approximations.
20 uses Constraint from AppParCurves
21
22 is 
23
24     Create returns ConstraintCouple;
25         ---Purpose: returns an indefinite ConstraintCouple.
26
27     Create(TheIndex: Integer; Cons: Constraint)
28         ---Purpose: Create a couple the object <Index> will have the 
29         --          constraint <Cons>.
30
31     returns ConstraintCouple;
32
33
34     Index(me)
35         ---Purpose: returns the index of the constraint object.
36
37     returns Integer
38     is static;
39     
40
41     Constraint(me) 
42         ---Purpose: returns the constraint of the object.
43
44     returns Constraint
45     is static;
46     
47
48     SetIndex(me: in out; TheIndex: Integer)
49         ---Purpose: Changes the index of the constraint object.
50     
51     is static;
52     
53     
54     SetConstraint(me: in out; Cons: Constraint)
55         ---Purpose: Changes the constraint of the object.
56     
57     is static;
58     
59     
60 fields
61
62 myIndex:      Integer;
63 myConstraint: Constraint from AppParCurves;
64
65 end ConstraintCouple;