1 // Created on: 1993-01-09
2 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _IGESBasic_SubfigureDef_HeaderFile
18 #define _IGESBasic_SubfigureDef_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <Standard_Integer.hxx>
24 #include <IGESData_HArray1OfIGESEntity.hxx>
25 #include <IGESData_IGESEntity.hxx>
26 class TCollection_HAsciiString;
27 class Standard_Transient;
30 class IGESBasic_SubfigureDef;
31 DEFINE_STANDARD_HANDLE(IGESBasic_SubfigureDef, IGESData_IGESEntity)
33 //! defines SubfigureDef, Type <308> Form <0>
34 //! in package IGESBasic
35 //! This Entity permits a single definition of a detail to
36 //! be utilized in multiple instances in the creation of
38 class IGESBasic_SubfigureDef : public IGESData_IGESEntity
44 Standard_EXPORT IGESBasic_SubfigureDef();
46 //! This method is used to set the fields of the class
48 //! - aDepth : It indicates the amount of nesting
49 //! - aName : the subfigure name
50 //! - allAssocEntities : the associated entities
51 Standard_EXPORT void Init (const Standard_Integer aDepth, const Handle(TCollection_HAsciiString)& aName, const Handle(IGESData_HArray1OfIGESEntity)& allAssocEntities);
53 //! returns depth of the Subfigure
54 //! if theDepth = 0 - No reference to any subfigure instance.
55 Standard_EXPORT Standard_Integer Depth() const;
57 //! returns the name of Subfigure
58 Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
60 //! returns number of entities. Is greater than or equal to zero.
61 Standard_EXPORT Standard_Integer NbEntities() const;
63 //! returns the specific entity as indicated by Index
64 //! raises exception if Index <= 0 or Index > NbEntities()
65 Standard_EXPORT Handle(IGESData_IGESEntity) AssociatedEntity (const Standard_Integer Index) const;
67 //! returns the specific entity as indicated by Index
68 //! raises exception if Index <= 0 or Index > NbEntities()
69 Standard_EXPORT Handle(Standard_Transient) Value (const Standard_Integer Index) const;
74 DEFINE_STANDARD_RTTIEXT(IGESBasic_SubfigureDef,IGESData_IGESEntity)
84 Standard_Integer theDepth;
85 Handle(TCollection_HAsciiString) theName;
86 Handle(IGESData_HArray1OfIGESEntity) theAssocEntities;
97 #endif // _IGESBasic_SubfigureDef_HeaderFile