include/opencascade/IGESBasic_ExternalRefFileIndex.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
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_ExternalRefFileIndex_HeaderFile
0018 #define _IGESBasic_ExternalRefFileIndex_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TCollection_HAsciiString.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class TCollection_HAsciiString;
0028
0029 //! defines ExternalRefFileIndex, Type <402> Form <12>
0030 //! in package IGESBasic
0031 //! Contains a list of the symbolic names used by the
0032 //! referencing files and the DE pointers to the
0033 //! corresponding definitions within the referenced file
0034 class IGESBasic_ExternalRefFileIndex : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESBasic_ExternalRefFileIndex();
0039
0040   //! This method is used to set the fields of the class
0041   //! ExternalRefFileIndex
0042   //! - aNameArray  : External Reference Entity symbolic names
0043   //! - allEntities : External Reference Entities
0044   //! raises exception if array lengths are not equal
0045   //! if size of aNameArray is not equal to size of allEntities
0046   Standard_EXPORT void Init(
0047     const occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>>& aNameArray,
0048     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&      allEntities);
0049
0050   //! returns number of index entries
0051   Standard_EXPORT int NbEntries() const;
0052
0053   //! returns the External Reference Entity symbolic name
0054   //! raises exception if Index <= 0 or Index > NbEntries()
0055   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name(const int Index) const;
0056
0057   //! returns the internal entity
0058   //! raises exception if Index <= 0 or Index > NbEntries()
0059   Standard_EXPORT occ::handle<IGESData_IGESEntity> Entity(const int Index) const;
0060
0061   DEFINE_STANDARD_RTTIEXT(IGESBasic_ExternalRefFileIndex, IGESData_IGESEntity)
0062
0063 private:
0064   occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>> theNames;
0065   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>      theEntities;
0066 };
0067
0068 #endif // _IGESBasic_ExternalRefFileIndex_HeaderFile