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 <Interface_HArray1OfHAsciiString.hxx>
0023 #include <IGESData_HArray1OfIGESEntity.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 #include <Standard_Integer.hxx>
0026 class TCollection_HAsciiString;
0027
0028
0029 class IGESBasic_ExternalRefFileIndex;
0030 DEFINE_STANDARD_HANDLE(IGESBasic_ExternalRefFileIndex, IGESData_IGESEntity)
0031
0032 //! defines ExternalRefFileIndex, Type <402> Form <12>
0033 //! in package IGESBasic
0034 //! Contains a list of the symbolic names used by the
0035 //! referencing files and the DE pointers to the
0036 //! corresponding definitions within the referenced file
0037 class IGESBasic_ExternalRefFileIndex : public IGESData_IGESEntity
0038 {
0039
0040 public:
0041
0042
0043   Standard_EXPORT IGESBasic_ExternalRefFileIndex();
0044
0045   //! This method is used to set the fields of the class
0046   //! ExternalRefFileIndex
0047   //! - aNameArray  : External Reference Entity symbolic names
0048   //! - allEntities : External Reference Entities
0049   //! raises exception if array lengths are not equal
0050   //! if size of aNameArray is not equal to size of allEntities
0051   Standard_EXPORT void Init (const Handle(Interface_HArray1OfHAsciiString)& aNameArray, const Handle(IGESData_HArray1OfIGESEntity)& allEntities);
0052
0053   //! returns number of index entries
0054   Standard_EXPORT Standard_Integer NbEntries() const;
0055
0056   //! returns the External Reference Entity symbolic name
0057   //! raises exception if Index <= 0 or Index > NbEntries()
0058   Standard_EXPORT Handle(TCollection_HAsciiString) Name (const Standard_Integer Index) const;
0059
0060   //! returns the internal entity
0061   //! raises exception if Index <= 0 or Index > NbEntries()
0062   Standard_EXPORT Handle(IGESData_IGESEntity) Entity (const Standard_Integer Index) const;
0063
0064
0065
0066
0067   DEFINE_STANDARD_RTTIEXT(IGESBasic_ExternalRefFileIndex,IGESData_IGESEntity)
0068
0069 protected:
0070
0071
0072
0073
0074 private:
0075
0076
0077   Handle(Interface_HArray1OfHAsciiString) theNames;
0078   Handle(IGESData_HArray1OfIGESEntity) theEntities;
0079
0080
0081 };
0082
0083
0084
0085
0086
0087
0088
0089 #endif // _IGESBasic_ExternalRefFileIndex_HeaderFile