src/IGESDefs/IGESDefs_MacroDef.hxx

   1 // Created on: 1993-01-13
   2 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
   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 _IGESDefs_MacroDef_HeaderFile
  18 #define _IGESDefs_MacroDef_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <Standard_Integer.hxx>
  23 #include <Interface_HArray1OfHAsciiString.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 class TCollection_HAsciiString;
  26
  27
  28 class IGESDefs_MacroDef;
  29 DEFINE_STANDARD_HANDLE(IGESDefs_MacroDef, IGESData_IGESEntity)
  30
  31 //! defines IGES Macro Definition Entity, Type <306> Form <0>
  32 //! in package IGESDefs
  33 //! This Class specifies the action of a specific MACRO.
  34 //! After specification MACRO can be used as necessary
  35 //! by means of MACRO class instance entity.
  36 class IGESDefs_MacroDef : public IGESData_IGESEntity
  37 {
  38
  39 public:
  40
  41
  42   Standard_EXPORT IGESDefs_MacroDef();
  43
  44   //! This method is used to set the fields of the class
  45   //! MacroDef
  46   //! - macro          : MACRO
  47   //! - entityTypeID   : Entity Type ID
  48   //! - langStatements : Language Statements
  49   //! - endMacro       : END MACRO
  50   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& macro, const Standard_Integer entityTypeID, const Handle(Interface_HArray1OfHAsciiString)& langStatements, const Handle(TCollection_HAsciiString)& endMacro);
  51
  52   //! returns the number of language statements
  53   Standard_EXPORT Standard_Integer NbStatements() const;
  54
  55   //! returns the MACRO(Literal)
  56   Standard_EXPORT Handle(TCollection_HAsciiString) MACRO() const;
  57
  58   //! returns the Entity Type ID
  59   Standard_EXPORT Standard_Integer EntityTypeID() const;
  60
  61   Standard_EXPORT Handle(TCollection_HAsciiString) LanguageStatement (const Standard_Integer StatNum) const;
  62
  63   //! returns the ENDM(Literal)
  64   Standard_EXPORT Handle(TCollection_HAsciiString) ENDMACRO() const;
  65
  66
  67
  68
  69   DEFINE_STANDARD_RTTIEXT(IGESDefs_MacroDef,IGESData_IGESEntity)
  70
  71 protected:
  72
  73
  74
  75
  76 private:
  77
  78
  79   Handle(TCollection_HAsciiString) theMACRO;
  80   Standard_Integer theEntityTypeID;
  81   Handle(Interface_HArray1OfHAsciiString) theLangStatements;
  82   Handle(TCollection_HAsciiString) theENDMACRO;
  83
  84
  85 };
  86
  87
  88
  89
  90
  91
  92
  93 #endif // _IGESDefs_MacroDef_HeaderFile