include/opencascade/IGESBasic_Hierarchy.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
0003 // Copyright (c) 1993-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 _IGESBasic_Hierarchy_HeaderFile
0018 #define _IGESBasic_Hierarchy_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024
0025 //! defines Hierarchy, Type <406> Form <10>
0026 //! in package IGESBasic
0027 //! Provides ability to control the hierarchy of each
0028 //! directory entry attribute.
0029 class IGESBasic_Hierarchy : public IGESData_IGESEntity
0030 {
0031
0032 public:
0033   Standard_EXPORT IGESBasic_Hierarchy();
0034
0035   //! This method is used to set the fields of the class
0036   //! Hierarchy
0037   //! - nbPropVal     : Number of Property values = 6
0038   //! - aLineFont     : indicates the line font
0039   //! - aView         : indicates the view
0040   //! - aEntityLevel  : indicates the entity level
0041   //! - aBlankStatus  : indicates the blank status
0042   //! - aLineWt       : indicates the line weight
0043   //! - aColorNum     : indicates the color num
0044   //! aLineFont, aView, aEntityLevel, aBlankStatus, aLineWt and
0045   //! aColorNum can take 0 or 1.
0046   //! 0 : The directory entry attribute will apply to entities
0047   //! physically subordinate to this entity.
0048   //! 1 : The directory entry attribute of this entity will not
0049   //! apply to physically subordinate entities.
0050   Standard_EXPORT void Init(const int nbPropVal,
0051                             const int aLineFont,
0052                             const int aView,
0053                             const int anEntityLevel,
0054                             const int aBlankStatus,
0055                             const int aLineWt,
0056                             const int aColorNum);
0057
0058   //! returns the number of property values, which should be 6
0059   Standard_EXPORT int NbPropertyValues() const;
0060
0061   //! returns the line font
0062   Standard_EXPORT int NewLineFont() const;
0063
0064   //! returns the view
0065   Standard_EXPORT int NewView() const;
0066
0067   //! returns the entity level
0068   Standard_EXPORT int NewEntityLevel() const;
0069
0070   //! returns the blank status
0071   Standard_EXPORT int NewBlankStatus() const;
0072
0073   //! returns the line weight
0074   Standard_EXPORT int NewLineWeight() const;
0075
0076   //! returns the color number
0077   Standard_EXPORT int NewColorNum() const;
0078
0079   DEFINE_STANDARD_RTTIEXT(IGESBasic_Hierarchy, IGESData_IGESEntity)
0080
0081 private:
0082   int theNbPropertyValues;
0083   int theLineFont;
0084   int theView;
0085   int theEntityLevel;
0086   int theBlankStatus;
0087   int theLineWeight;
0088   int theColorNum;
0089 };
0090
0091 #endif // _IGESBasic_Hierarchy_HeaderFile