src/IGESBasic/IGESBasic_ExternalReferenceFile.cdl

   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 class ExternalReferenceFile from IGESBasic  inherits IGESEntity
  18
  19         ---Purpose: defines ExternalReferenceFile, Type <406> Form <12>
  20         --          in package IGESBasic
  21         --          References definitions residing in another file
  22
  23 uses
  24
  25         HAsciiString from TCollection,
  26         HArray1OfHAsciiString from Interface
  27
  28 raises OutOfRange
  29
  30 is
  31
  32         Create returns ExternalReferenceFile;
  33
  34         -- Specific Methods pertaining to the class
  35
  36         Init (me : mutable; aNameArray : HArray1OfHAsciiString);
  37         ---Purpose : This method is used to set the fields of the class
  38         --           ExternalReferenceFile
  39         --       - aNameArray : External Reference File Names
  40
  41         NbListEntries (me) returns Integer;
  42         ---Purpose : returns number of External Reference File Names
  43
  44         Name (me; Index : Integer) returns HAsciiString from TCollection
  45         raises OutOfRange;
  46         ---Purpose : returns External Reference File Name
  47         -- raises exception if Index <= 0 or Index > NbListEntries()
  48
  49 fields
  50
  51 --
  52 -- Class    : IGESBasic_ExternalReferenceFile
  53 --
  54 -- Purpose  : Declaration of variables specific to the definition
  55 --            of the Class ExternalReferenceFile.
  56 --
  57 -- Reminder : A ExternalReferenceFile instance is defined by :
  58 --            - External Reference File Names
  59
  60         theNames : HArray1OfHAsciiString;
  61
  62 end ExternalReferenceFile;