0024057: Eliminate compiler warning C4100 in MSVC++ with warning level 4
[occt.git] / src / IGESAppli / IGESAppli_NodalDisplAndRot.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 NodalDisplAndRot from IGESAppli  inherits IGESEntity
23
24         ---Purpose: defines NodalDisplAndRot, Type <138> Form <0>
25         --          in package IGESAppli
26         --          Used to communicate finite element post processing
27         --          data.
28
29 uses
30
31         GeneralNote           from IGESDimen,
32         Node                  from IGESAppli,
33         HArray1OfGeneralNote  from IGESDimen,
34         HArray1OfNode         from IGESAppli,
35         HArray1OfReal         from TColStd,
36         XYZ                   from gp,
37         HArray1OfInteger      from TColStd,
38         HArray1OfXYZ          from TColgp,
39         HArray1OfHArray1OfXYZ from IGESBasic
40
41 raises DimensionMismatch, OutOfRange
42
43 is
44
45         Create returns mutable NodalDisplAndRot;
46
47         -- Specific Methods pertaining to the class
48
49         Init (me             : mutable;
50               allNotes       : HArray1OfGeneralNote;
51               allIdentifiers : HArray1OfInteger;
52               allNodes       : HArray1OfNode;
53               allRotParams   : HArray1OfHArray1OfXYZ;
54               allTransParams : HArray1OfHArray1OfXYZ)
55         raises DimensionMismatch;
56         ---Purpose : This method is used to set the fields of the class
57         --           NodalDisplAndRot
58         --       - allNotes       : Used to store the general note describing
59         --                          the analysis cases
60         --       - allIdentifiers : Used to store the node number
61         --                          identifier for the nodes
62         --       - allNodes       : Used to store the nodes
63         --       - allRotParams   : Used to store the rotation for the nodes
64         --       - allTransParams : Used to store the incremental
65         --                          displacements for the nodes
66         -- raises exception if Lengths of allIdentifiers, allNodes,
67         -- allRotParams, and allTransParams are not same  
68         -- or if length of allNotes and size of each element of allRotParams
69         -- and allTransParam are not same
70
71         NbCases (me) returns Integer;
72         ---Purpose : returns the number of analysis cases
73
74         NbNodes (me) returns Integer;
75         ---Purpose : returns the number of nodes
76
77         Note (me; Index : Integer) returns GeneralNote
78         raises OutOfRange;
79         ---Purpose : returns the General Note that describes the Index analysis case
80         -- raises exception if Index <= 0 or Index > NbCases
81
82         NodeIdentifier (me; Index : Integer) returns Integer
83         raises OutOfRange;
84         ---Purpose : returns the node identifier as specified by the Index
85         -- raises exception if Index <= 0 or Index > NbNodes
86
87         Node (me; Index : Integer) returns Node
88         raises OutOfRange;
89         ---Purpose : returns the node as specified by the Index
90         -- raises exception if Index <= 0 or Index > NbNodes
91
92         TranslationParameter (me; NodeNum, CaseNum : Integer) returns XYZ
93         raises OutOfRange;
94         ---Purpose : returns the Translational Parameters for the particular Index
95         -- Exception raised if NodeNum <= 0 or NodeNum > NbNodes()
96         -- or CaseNum <= 0 or CaseNum > NbCases()
97
98         RotationalParameter (me; NodeNum, CaseNum : Integer) returns XYZ
99         raises OutOfRange;
100         ---Purpose : returns the Rotational Parameters for Index
101         -- Exception raised if NodeNum <= 0 or NodeNum > NbNodes()
102         -- or CaseNum <= 0 or CaseNum > NbCases()
103
104 fields
105
106 --
107 -- Class    : IGESAppli_NodalDisplAndRot
108 --
109 -- Purpose  : Declaration of variables specific to the definition
110 --            of the Class NodalDisplAndRot.
111 --
112 -- Reminder : A NodalDisplAndRot instance is defined by :
113 --            - the general note describing the analysis cases
114 --            - the node number identifier for the nodes
115 --            - the nodes
116 --            - the incremental displacements and rotation for the nodes
117
118         theNotes           : HArray1OfGeneralNote;
119         theNodeIdentifiers : HArray1OfInteger;
120         theNodes           : HArray1OfNode;
121         theTransParam      : HArray1OfHArray1OfXYZ;
122         theRotParam        : HArray1OfHArray1OfXYZ;
123
124 end NodalDisplAndRot;