0027104: DownCast() cannot return null for mismatched handle
[occt.git] / src / IGESAppli / IGESAppli_NodalResults.hxx
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-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 under
9 // the terms of the GNU Lesser General Public License 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 #ifndef _IGESAppli_NodalResults_HeaderFile
18 #define _IGESAppli_NodalResults_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <Standard_Real.hxx>
25 #include <TColStd_HArray1OfInteger.hxx>
26 #include <IGESAppli_HArray1OfNode.hxx>
27 #include <TColStd_HArray2OfReal.hxx>
28 #include <IGESData_IGESEntity.hxx>
29 class IGESDimen_GeneralNote;
30 class Standard_DimensionMismatch;
31 class Standard_OutOfRange;
32 class IGESAppli_Node;
33
34
35 class IGESAppli_NodalResults;
36 DEFINE_STANDARD_HANDLE(IGESAppli_NodalResults, IGESData_IGESEntity)
37
38 //! defines NodalResults, Type <146>
39 //! in package IGESAppli
40 //! Used to store the Analysis Data results per FEM Node
41 class IGESAppli_NodalResults : public IGESData_IGESEntity
42 {
43
44 public:
45
46   
47   Standard_EXPORT IGESAppli_NodalResults();
48   
49   //! This method is used to set the fields of the class
50   //! NodalResults
51   //! - aNote              : General Note that describes the
52   //! analysis case
53   //! - aNumber            : Analysis Subcase number
54   //! - aTime              : Analysis time
55   //! - allNodeIdentifiers : Node identifiers for the nodes
56   //! - allNodes           : List of FEM Node Entities
57   //! - allData            : Values of the Finite Element analysis
58   //! result data
59   //! raises exception if Lengths of allNodeIdentifiers, allNodes and
60   //! allData (Cols) are not same
61   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Standard_Integer aNumber, const Standard_Real aTime, const Handle(TColStd_HArray1OfInteger)& allNodeIdentifiers, const Handle(IGESAppli_HArray1OfNode)& allNodes, const Handle(TColStd_HArray2OfReal)& allData);
62   
63   //! Changes the FormNumber (which indicates Type of Result)
64   //! Error if not in range [0-34]
65   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
66   
67   //! returns the General Note Entity that describes the analysis case
68   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
69   
70   //! returns zero if there is no subcase
71   Standard_EXPORT Standard_Integer SubCaseNumber() const;
72   
73   //! returns the Analysis time value for this subcase. It is the time
74   //! at which transient analysis results occur in the mathematical
75   //! FEM model.
76   Standard_EXPORT Standard_Real Time() const;
77   
78   //! returns number of real values in array V for a FEM node
79   Standard_EXPORT Standard_Integer NbData() const;
80   
81   //! returns number of FEM nodes for which data is to be read.
82   Standard_EXPORT Standard_Integer NbNodes() const;
83   
84   //! returns FEM node number identifier for the (Index)th node
85   //! raises exception if Index <= 0 or Index > NbNodes
86   Standard_EXPORT Standard_Integer NodeIdentifier (const Standard_Integer Index) const;
87   
88   //! returns the node as specified by the Index
89   //! raises exception if Index <= 0 or Index > NbNodes
90   Standard_EXPORT Handle(IGESAppli_Node) Node (const Standard_Integer Index) const;
91   
92   //! returns the finite element analysis result value
93   //! raises exception if (NodeNum <= 0 or NodeNum > NbNodes()) or
94   //! if (DataNum <=0 or DataNum > NbData())
95   Standard_EXPORT Standard_Real Data (const Standard_Integer NodeNum, const Standard_Integer DataNum) const;
96
97
98
99
100   DEFINE_STANDARD_RTTIEXT(IGESAppli_NodalResults,IGESData_IGESEntity)
101
102 protected:
103
104
105
106
107 private:
108
109
110   Handle(IGESDimen_GeneralNote) theNote;
111   Standard_Integer theSubCaseNum;
112   Standard_Real theTime;
113   Handle(TColStd_HArray1OfInteger) theNodeIdentifiers;
114   Handle(IGESAppli_HArray1OfNode) theNodes;
115   Handle(TColStd_HArray2OfReal) theData;
116
117
118 };
119
120
121
122
123
124
125
126 #endif // _IGESAppli_NodalResults_HeaderFile