src/IGESBasic/IGESBasic_ExternalRefFileIndex.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   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.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESBasic_ExternalRefFileIndex_HeaderFile
  18 #define _IGESBasic_ExternalRefFileIndex_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <Interface_HArray1OfHAsciiString.hxx>
  23 #include <IGESData_HArray1OfIGESEntity.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 #include <Standard_Integer.hxx>
  26 class TCollection_HAsciiString;
  27
  28
  29 class IGESBasic_ExternalRefFileIndex;
  30 DEFINE_STANDARD_HANDLE(IGESBasic_ExternalRefFileIndex, IGESData_IGESEntity)
  31
  32 //! defines ExternalRefFileIndex, Type <402> Form <12>
  33 //! in package IGESBasic
  34 //! Contains a list of the symbolic names used by the
  35 //! referencing files and the DE pointers to the
  36 //! corresponding definitions within the referenced file
  37 class IGESBasic_ExternalRefFileIndex : public IGESData_IGESEntity
  38 {
  39
  40 public:
  41
  42
  43   Standard_EXPORT IGESBasic_ExternalRefFileIndex();
  44
  45   //! This method is used to set the fields of the class
  46   //! ExternalRefFileIndex
  47   //! - aNameArray  : External Reference Entity symbolic names
  48   //! - allEntities : External Reference Entities
  49   //! raises exception if array lengths are not equal
  50   //! if size of aNameArray is not equal to size of allEntities
  51   Standard_EXPORT void Init (const Handle(Interface_HArray1OfHAsciiString)& aNameArray, const Handle(IGESData_HArray1OfIGESEntity)& allEntities);
  52
  53   //! returns number of index entries
  54   Standard_EXPORT Standard_Integer NbEntries() const;
  55
  56   //! returns the External Reference Entity symbolic name
  57   //! raises exception if Index <= 0 or Index > NbEntries()
  58   Standard_EXPORT Handle(TCollection_HAsciiString) Name (const Standard_Integer Index) const;
  59
  60   //! returns the internal entity
  61   //! raises exception if Index <= 0 or Index > NbEntries()
  62   Standard_EXPORT Handle(IGESData_IGESEntity) Entity (const Standard_Integer Index) const;
  63
  64
  65
  66
  67   DEFINE_STANDARD_RTTIEXT(IGESBasic_ExternalRefFileIndex,IGESData_IGESEntity)
  68
  69 protected:
  70
  71
  72
  73
  74 private:
  75
  76
  77   Handle(Interface_HArray1OfHAsciiString) theNames;
  78   Handle(IGESData_HArray1OfIGESEntity) theEntities;
  79
  80
  81 };
  82
  83
  84
  85
  86
  87
  88
  89 #endif // _IGESBasic_ExternalRefFileIndex_HeaderFile