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 <Interface_HArray1OfHAsciiString.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 class TCollection_HAsciiString;
0026
0027
0028 class IGESDefs_MacroDef;
0029 DEFINE_STANDARD_HANDLE(IGESDefs_MacroDef, IGESData_IGESEntity)
0030
0031 //! defines IGES Macro Definition Entity, Type <306> Form <0>
0032 //! in package IGESDefs
0033 //! This Class specifies the action of a specific MACRO.
0034 //! After specification MACRO can be used as necessary
0035 //! by means of MACRO class instance entity.
0036 class IGESDefs_MacroDef : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040
0041
0042   Standard_EXPORT IGESDefs_MacroDef();
0043
0044   //! This method is used to set the fields of the class
0045   //! MacroDef
0046   //! - macro          : MACRO
0047   //! - entityTypeID   : Entity Type ID
0048   //! - langStatements : Language Statements
0049   //! - endMacro       : END MACRO
0050   Standard_EXPORT void Init (const Handle(TCollection_HAsciiString)& macro, const Standard_Integer entityTypeID, const Handle(Interface_HArray1OfHAsciiString)& langStatements, const Handle(TCollection_HAsciiString)& endMacro);
0051
0052   //! returns the number of language statements
0053   Standard_EXPORT Standard_Integer NbStatements() const;
0054
0055   //! returns the MACRO(Literal)
0056   Standard_EXPORT Handle(TCollection_HAsciiString) MACRO() const;
0057
0058   //! returns the Entity Type ID
0059   Standard_EXPORT Standard_Integer EntityTypeID() const;
0060
0061   Standard_EXPORT Handle(TCollection_HAsciiString) LanguageStatement (const Standard_Integer StatNum) const;
0062
0063   //! returns the ENDM(Literal)
0064   Standard_EXPORT Handle(TCollection_HAsciiString) ENDMACRO() const;
0065
0066
0067
0068
0069   DEFINE_STANDARD_RTTIEXT(IGESDefs_MacroDef,IGESData_IGESEntity)
0070
0071 protected:
0072
0073
0074
0075
0076 private:
0077
0078
0079   Handle(TCollection_HAsciiString) theMACRO;
0080   Standard_Integer theEntityTypeID;
0081   Handle(Interface_HArray1OfHAsciiString) theLangStatements;
0082   Handle(TCollection_HAsciiString) theENDMACRO;
0083
0084
0085 };
0086
0087
0088
0089
0090
0091
0092
0093 #endif // _IGESDefs_MacroDef_HeaderFile