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