0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IGESData / IGESData_DefSwitch.hxx
1 // Created on: 1992-04-06
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-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 _IGESData_DefSwitch_HeaderFile
18 #define _IGESData_DefSwitch_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Integer.hxx>
25 #include <IGESData_DefType.hxx>
26
27
28 //! description of a directory component which can be either
29 //! undefined (let Void), defined as a Reference to an entity,
30 //! or as a Rank, integer value adressing a builtin table
31 //! The entity reference is not included here, only reference
32 //! status is kept (because entity type must be adapted)
33 class IGESData_DefSwitch 
34 {
35 public:
36
37   DEFINE_STANDARD_ALLOC
38
39   
40   //! creates a DefSwitch as Void
41   Standard_EXPORT IGESData_DefSwitch();
42   
43   //! sets DefSwitch to "Void" status (in file : Integer = 0)
44   Standard_EXPORT void SetVoid();
45   
46   //! sets DefSwitch to "Reference" Status (in file : Integer < 0)
47   Standard_EXPORT void SetReference();
48   
49   //! sets DefSwitch to "Rank" with a Value (in file : Integer > 0)
50   Standard_EXPORT void SetRank (const Standard_Integer val);
51   
52   //! returns DefType status (Void,Reference,Rank)
53   Standard_EXPORT IGESData_DefType DefType() const;
54   
55   //! returns Value as Integer (sensefull for a Rank)
56   Standard_EXPORT Standard_Integer Value() const;
57
58
59
60
61 protected:
62
63
64
65
66
67 private:
68
69
70
71   Standard_Integer theval;
72
73
74 };
75
76
77
78
79
80
81
82 #endif // _IGESData_DefSwitch_HeaderFile