include/opencascade/IGESDefs_MacroDef.hxx

0001 // Created on: 1993-01-13
0002 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
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 _IGESDefs_MacroDef_HeaderFile
0018 #define _IGESDefs_MacroDef_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <TCollection_HAsciiString.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <IGESData_IGESEntity.hxx>
0027 class TCollection_HAsciiString;
0028
0029 //! defines IGES Macro Definition Entity, Type <306> Form <0>
0030 //! in package IGESDefs
0031 //! This Class specifies the action of a specific MACRO.
0032 //! After specification MACRO can be used as necessary
0033 //! by means of MACRO class instance entity.
0034 class IGESDefs_MacroDef : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESDefs_MacroDef();
0039
0040   //! This method is used to set the fields of the class
0041   //! MacroDef
0042   //! - macro          : MACRO
0043   //! - entityTypeID   : Entity Type ID
0044   //! - langStatements : Language Statements
0045   //! - endMacro       : END MACRO
0046   Standard_EXPORT void Init(
0047     const occ::handle<TCollection_HAsciiString>&                                   macro,
0048     const int                                                                      entityTypeID,
0049     const occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>>& langStatements,
0050     const occ::handle<TCollection_HAsciiString>&                                   endMacro);
0051
0052   //! returns the number of language statements
0053   Standard_EXPORT int NbStatements() const;
0054
0055   //! returns the MACRO(Literal)
0056   Standard_EXPORT occ::handle<TCollection_HAsciiString> MACRO() const;
0057
0058   //! returns the Entity Type ID
0059   Standard_EXPORT int EntityTypeID() const;
0060
0061   Standard_EXPORT occ::handle<TCollection_HAsciiString> LanguageStatement(const int StatNum) const;
0062
0063   //! returns the ENDM(Literal)
0064   Standard_EXPORT occ::handle<TCollection_HAsciiString> ENDMACRO() const;
0065
0066   DEFINE_STANDARD_RTTIEXT(IGESDefs_MacroDef, IGESData_IGESEntity)
0067
0068 private:
0069   occ::handle<TCollection_HAsciiString>                                   theMACRO;
0070   int                                                                     theEntityTypeID;
0071   occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>> theLangStatements;
0072   occ::handle<TCollection_HAsciiString>                                   theENDMACRO;
0073 };
0074
0075 #endif // _IGESDefs_MacroDef_HeaderFile