0024157: Parallelization of assembly part of BO
[occt.git] / src / IFSelect / IFSelect_IntParam.cdl
CommitLineData
b311480e 1-- Created on: 1992-11-30
2-- Created by: Christian CAILLET
3-- Copyright (c) 1992-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23class IntParam from IFSelect inherits TShared
24
25 ---Purpose : This class simply allows to access an Integer value through a
26 -- Handle, as a String can be (by using HString).
27 -- Hence, this value can be accessed : read and modified, without
28 -- passing through the specific object which detains it. Thus,
29 -- parameters of a Selection or a Dispatch (according its type)
30 -- can be controlled directly from the ShareOut which contains them
31 --
32 -- Additionnaly, an IntParam can be bound to a Static.
33 -- Remember that for a String, binding is immediate, because the
34 -- string value of a Static is a HAsciiString, it then suffices
35 -- to get its Handle.
36 -- For an Integer, an IntParam can designate (by its name) a
37 -- Static : each time its value is required or set, the Static
38 -- is aknowledged
39
40uses Integer, CString, AsciiString
41
42is
43
44 Create returns mutable IntParam;
45 ---Purpose : Creates an IntParam. Initial value is set to zer
46
47 SetStaticName (me : mutable; statname : CString);
48 ---Purpose : Commands this IntParam to be bound to a Static
49 -- Hence, Value will return the value if this Static if it is set
50 -- Else, Value works on the locally stored value
51 -- SetValue also will set the value of the Static
52 -- This works only for a present static of type integer or enum
53 -- Else, it is ignored
54 --
55 -- If <statname> is empty, disconnects the IntParam from Static
56
57 StaticName (me) returns CString;
58 ---Purpose : Returns the name of static parameter to which this IntParam
59 -- is bound, empty if none
60
61 Value (me) returns Integer is static;
62 ---Purpose : Reads Integer Value of the IntParam. If a StaticName is
63 -- defined and the Static is set, looks in priority the value
64 -- of the static
65
66 SetValue (me : mutable; val : Integer) is static;
67 ---Purpose : Sets a new Integer Value for the IntParam. If a StaticName is
68 -- defined and the Static is set, also sets the value of the static
69
70fields
71
72 theval : Integer;
73 thestn : AsciiString;
74
75end IntParam;