include/opencascade/IGESData_DefSwitch.hxx

0001 // Created on: 1992-04-06
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESData_DefSwitch_HeaderFile
0018 #define _IGESData_DefSwitch_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <IGESData_DefType.hxx>
0025
0026 //! description of a directory component which can be either
0027 //! undefined (let Void), defined as a Reference to an entity,
0028 //! or as a Rank, integer value addressing a builtin table
0029 //! The entity reference is not included here, only reference
0030 //! status is kept (because entity type must be adapted)
0031 class IGESData_DefSwitch
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! creates a DefSwitch as Void
0038   Standard_EXPORT IGESData_DefSwitch();
0039
0040   //! sets DefSwitch to "Void" status (in file : Integer = 0)
0041   Standard_EXPORT void SetVoid();
0042
0043   //! sets DefSwitch to "Reference" Status (in file : Integer < 0)
0044   Standard_EXPORT void SetReference();
0045
0046   //! sets DefSwitch to "Rank" with a Value (in file : Integer > 0)
0047   Standard_EXPORT void SetRank (const Standard_Integer val);
0048
0049   //! returns DefType status (Void,Reference,Rank)
0050   Standard_EXPORT IGESData_DefType DefType() const;
0051
0052   //! returns Value as Integer (sensefull for a Rank)
0053   Standard_EXPORT Standard_Integer Value() const;
0054
0055 private:
0056
0057   Standard_Integer theval;
0058
0059 };
0060
0061 #endif // _IGESData_DefSwitch_HeaderFile