include/opencascade/IGESBasic_SubfigureDef.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_SubfigureDef_HeaderFile
0018 #define _IGESBasic_SubfigureDef_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 class TCollection_HAsciiString;
0027 class Standard_Transient;
0028
0029 //! defines SubfigureDef, Type <308> Form <0>
0030 //! in package IGESBasic
0031 //! This Entity permits a single definition of a detail to
0032 //! be utilized in multiple instances in the creation of
0033 //! the whole picture
0034 class IGESBasic_SubfigureDef : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESBasic_SubfigureDef();
0039
0040   //! This method is used to set the fields of the class
0041   //! SubfigureDef
0042   //! - aDepth           : It indicates the amount of nesting
0043   //! - aName            : the subfigure name
0044   //! - allAssocEntities : the associated entities
0045   Standard_EXPORT void Init(
0046     const int                                                                 aDepth,
0047     const occ::handle<TCollection_HAsciiString>&                              aName,
0048     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>& allAssocEntities);
0049
0050   //! returns depth of the Subfigure
0051   //! if theDepth = 0 - No reference to any subfigure instance.
0052   Standard_EXPORT int Depth() const;
0053
0054   //! returns the name of Subfigure
0055   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name() const;
0056
0057   //! returns number of entities. Is greater than or equal to zero.
0058   Standard_EXPORT int NbEntities() const;
0059
0060   //! returns the specific entity as indicated by Index
0061   //! raises exception if Index <= 0 or Index > NbEntities()
0062   Standard_EXPORT occ::handle<IGESData_IGESEntity> AssociatedEntity(const int Index) const;
0063
0064   //! returns the specific entity as indicated by Index
0065   //! raises exception if Index <= 0 or Index > NbEntities()
0066   Standard_EXPORT occ::handle<Standard_Transient> Value(const int Index) const;
0067
0068   DEFINE_STANDARD_RTTIEXT(IGESBasic_SubfigureDef, IGESData_IGESEntity)
0069
0070 private:
0071   int                                                                theDepth;
0072   occ::handle<TCollection_HAsciiString>                              theName;
0073   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>> theAssocEntities;
0074 };
0075
0076 #endif // _IGESBasic_SubfigureDef_HeaderFile