0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / IGESAppli / IGESAppli_LevelFunction.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_LevelFunction_HeaderFile
18 #define _IGESAppli_LevelFunction_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <IGESData_IGESEntity.hxx>
25 class TCollection_HAsciiString;
26
27
28 class IGESAppli_LevelFunction;
29 DEFINE_STANDARD_HANDLE(IGESAppli_LevelFunction, IGESData_IGESEntity)
30
31 //! defines LevelFunction, Type <406> Form <3>
32 //! in package IGESAppli
33 //! Used to transfer the meaning or intended use of a level
34 //! in the sending system
35 class IGESAppli_LevelFunction : public IGESData_IGESEntity
36 {
37
38 public:
39
40   
41   Standard_EXPORT IGESAppli_LevelFunction();
42   
43   //! This method is used to set the fields of the class
44   //! LevelFunction
45   //! - nbPropVal    : Number of Properties, always = 2
46   //! - aCode        : Function Description code
47   //! default = 0
48   //! - aFuncDescrip : Function Description
49   //! default = null string
50   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Standard_Integer aCode, const Handle(TCollection_HAsciiString)& aFuncDescrip);
51   
52   //! is always 2
53   Standard_EXPORT Standard_Integer NbPropertyValues() const;
54   
55   //! returns the function description code . Default = 0
56   Standard_EXPORT Standard_Integer FuncDescriptionCode() const;
57   
58   //! returns the function description
59   //! Default = null string
60   Standard_EXPORT Handle(TCollection_HAsciiString) FuncDescription() const;
61
62
63
64
65   DEFINE_STANDARD_RTTIEXT(IGESAppli_LevelFunction,IGESData_IGESEntity)
66
67 protected:
68
69
70
71
72 private:
73
74
75   Standard_Integer theNbPropertyValues;
76   Standard_Integer theFuncDescripCode;
77   Handle(TCollection_HAsciiString) theFuncDescrip;
78
79
80 };
81
82
83
84
85
86
87
88 #endif // _IGESAppli_LevelFunction_HeaderFile