0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / IGESAppli / IGESAppli_FiniteElement.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_FiniteElement_HeaderFile
18 #define _IGESAppli_FiniteElement_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <IGESAppli_HArray1OfNode.hxx>
25 #include <IGESData_IGESEntity.hxx>
26 class TCollection_HAsciiString;
27 class Standard_OutOfRange;
28 class IGESAppli_Node;
29
30
31 class IGESAppli_FiniteElement;
32 DEFINE_STANDARD_HANDLE(IGESAppli_FiniteElement, IGESData_IGESEntity)
33
34 //! defines FiniteElement, Type <136> Form <0>
35 //! in package IGESAppli
36 //! Used to define a finite element with the help of an
37 //! element topology.
38 class IGESAppli_FiniteElement : public IGESData_IGESEntity
39 {
40
41 public:
42
43   
44   Standard_EXPORT IGESAppli_FiniteElement();
45   
46   //! This method is used to set the fields of the class
47   //! FiniteElement
48   //! - aType    : Indicates the topology type
49   //! - allNodes : List of Nodes defining the element
50   //! - aName    : Element type name
51   Standard_EXPORT void Init (const Standard_Integer aType, const Handle(IGESAppli_HArray1OfNode)& allNodes, const Handle(TCollection_HAsciiString)& aName);
52   
53   //! returns Topology type
54   Standard_EXPORT Standard_Integer Topology() const;
55   
56   //! returns the number of nodes defining the element
57   Standard_EXPORT Standard_Integer NbNodes() const;
58   
59   //! returns Node defining element entity
60   //! raises exception if Index <= 0 or Index > NbNodes()
61   Standard_EXPORT Handle(IGESAppli_Node) Node (const Standard_Integer Index) const;
62   
63   //! returns Element Type Name
64   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
65
66
67
68
69   DEFINE_STANDARD_RTTIEXT(IGESAppli_FiniteElement,IGESData_IGESEntity)
70
71 protected:
72
73
74
75
76 private:
77
78
79   Standard_Integer theTopology;
80   Handle(IGESAppli_HArray1OfNode) theNodes;
81   Handle(TCollection_HAsciiString) theName;
82
83
84 };
85
86
87
88
89
90
91
92 #endif // _IGESAppli_FiniteElement_HeaderFile