src/IGESBasic/IGESBasic_Hierarchy.hxx

   1 // Created on: 1993-01-09
   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 _IGESBasic_Hierarchy_HeaderFile
  18 #define _IGESBasic_Hierarchy_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25
  26
  27 class IGESBasic_Hierarchy;
  28 DEFINE_STANDARD_HANDLE(IGESBasic_Hierarchy, IGESData_IGESEntity)
  29
  30 //! defines Hierarchy, Type <406> Form <10>
  31 //! in package IGESBasic
  32 //! Provides ability to control the hierarchy of each
  33 //! directory entry attribute.
  34 class IGESBasic_Hierarchy : public IGESData_IGESEntity
  35 {
  36
  37 public:
  38
  39
  40   Standard_EXPORT IGESBasic_Hierarchy();
  41
  42   //! This method is used to set the fields of the class
  43   //! Hierarchy
  44   //! - nbPropVal     : Number of Property values = 6
  45   //! - aLineFont     : indicates the line font
  46   //! - aView         : indicates the view
  47   //! - aEntityLevel  : indicates the entity level
  48   //! - aBlankStatus  : indicates the blank status
  49   //! - aLineWt       : indicates the line weight
  50   //! - aColorNum     : indicates the color num
  51   //! aLineFont, aView, aEntityLevel, aBlankStatus, aLineWt and
  52   //! aColorNum can take 0 or 1.
  53   //! 0 : The directory entry attribute will apply to entities
  54   //! physically subordinate to this entity.
  55   //! 1 : The directory entry attribute of this entity will not
  56   //! apply to physically subordinate entities.
  57   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Standard_Integer aLineFont, const Standard_Integer aView, const Standard_Integer anEntityLevel, const Standard_Integer aBlankStatus, const Standard_Integer aLineWt, const Standard_Integer aColorNum);
  58
  59   //! returns the number of property values, which should be 6
  60   Standard_EXPORT Standard_Integer NbPropertyValues() const;
  61
  62   //! returns the line font
  63   Standard_EXPORT Standard_Integer NewLineFont() const;
  64
  65   //! returns the view
  66   Standard_EXPORT Standard_Integer NewView() const;
  67
  68   //! returns the entity level
  69   Standard_EXPORT Standard_Integer NewEntityLevel() const;
  70
  71   //! returns the blank status
  72   Standard_EXPORT Standard_Integer NewBlankStatus() const;
  73
  74   //! returns the line weight
  75   Standard_EXPORT Standard_Integer NewLineWeight() const;
  76
  77   //! returns the color number
  78   Standard_EXPORT Standard_Integer NewColorNum() const;
  79
  80
  81
  82
  83   DEFINE_STANDARD_RTTIEXT(IGESBasic_Hierarchy,IGESData_IGESEntity)
  84
  85 protected:
  86
  87
  88
  89
  90 private:
  91
  92
  93   Standard_Integer theNbPropertyValues;
  94   Standard_Integer theLineFont;
  95   Standard_Integer theView;
  96   Standard_Integer theEntityLevel;
  97   Standard_Integer theBlankStatus;
  98   Standard_Integer theLineWeight;
  99   Standard_Integer theColorNum;
 100
 101
 102 };
 103
 104
 105
 106
 107
 108
 109
 110 #endif // _IGESBasic_Hierarchy_HeaderFile