0024057: Eliminate compiler warning C4100 in MSVC++ with warning level 4
[occt.git] / src / IGESAppli / IGESAppli_LineWidening.cdl
1 -- Created on: 1993-01-11
2 -- Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
3 -- Copyright (c) 1993-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
21
22 class LineWidening from IGESAppli  inherits IGESEntity
23
24         ---Purpose: defines LineWidening, Type <406> Form <5>
25         --          in package IGESAppli
26         --          Defines the characteristics of entities when they are
27         --          used to define locations of items.
28
29 uses  Integer, Real  -- no one specific type
30
31 is
32
33         Create returns mutable LineWidening;
34
35         -- Specific Methods pertaining to the class
36
37         Init (me          : mutable;
38               nbPropVal   : Integer;
39               aWidth      : Real;
40               aCornering  : Integer;
41               aExtnFlag   : Integer;
42               aJustifFlag : Integer;
43               aExtnVal    : Real);
44         ---Purpose : This method is used to set the fields of the class
45         --           LineWidening
46         --       - nbPropVal   : Number of property values = 5
47         --       - aWidth      : Width of metalization
48         --       - aCornering  : Cornering codes
49         --                       0 = rounded
50         --                       1 = squared
51         --       - aExtnFlag   : Extension Flag
52         --                       0 = No Extension
53         --                       1 = One-half width extension
54         --                       2 = Extn set by ExtnVal
55         --       - aJustifFlag : Justification flag
56         --                       0 = Center justified
57         --                       1 = left justified
58         --                       2 = right justified
59         --       - aExtnVal    : Extension value if aExtnFlag = 2
60
61
62         NbPropertyValues (me) returns Integer;
63         ---Purpose : returns the number of property values
64         -- is always 5
65
66         WidthOfMetalization (me) returns Real;
67         ---Purpose : returns the width of metallization
68
69         CorneringCode (me) returns Integer;
70         ---Purpose : returns the cornering code
71         --           0 = Rounded  /   1 = Squared
72
73         ExtensionFlag (me) returns Integer;
74         ---Purpose : returns the extension flag
75         -- 0 = No extension
76         -- 1 = One-half width extension
77         -- 2 = Extension set by theExtnVal
78
79         JustificationFlag (me) returns Integer;
80         ---Purpose : returns the justification flag
81         -- 0 = Centre justified
82         -- 1 = Left justified
83         -- 2 = Right justified
84
85         ExtensionValue (me) returns Real;
86         ---Purpose : returns the Extension Value
87         -- Present only if theExtnFlag = 2
88
89 fields
90
91 --
92 -- Class    : IGESAppli_LineWidening
93 --
94 -- Purpose  : Declaration of variables specific to the definition
95 --            of the Class LineWidening.
96 --
97 -- Reminder : A LineWidening instance is defined by :
98 --            - Number of property values (Should be 5)
99 --            - Width of metalization
100 --            - Cornering codes
101 --            - Extension Flag
102 --            - Justification flag
103 --            - Extension value if theExtensionFlag = 2
104
105         theNbPropertyValues  : Integer;
106         theWidth             : Real;
107         theCorneringCode     : Integer;
108         theExtensionFlag     : Integer;
109         theJustificationFlag : Integer;
110         theExtensionValue    : Real;
111
112 end LineWidening;