src/StepData/StepData_FieldList.hxx

   1 // Created on: 1997-04-01
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1997-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 _StepData_FieldList_HeaderFile
  18 #define _StepData_FieldList_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 class StepData_Field;
  25 class Interface_EntityIterator;
  26
  27
  28 //! Describes a list of fields, in a general way
  29 //! This basic class is for a null size list
  30 //! Subclasses are for 1, N (fixed) or Dynamic sizes
  31 class StepData_FieldList
  32 {
  33 public:
  34
  35   DEFINE_STANDARD_ALLOC
  36
  37   //! Destructor is virtual
  38   Standard_EXPORT virtual ~StepData_FieldList();
  39
  40   //! Creates a FieldList of 0 Field
  41   Standard_EXPORT StepData_FieldList();
  42
  43   //! Returns the count of fields. Here, returns 0
  44   Standard_EXPORT virtual Standard_Integer NbFields() const;
  45
  46   //! Returns the field n0 <num> between 1 and NbFields (read only)
  47   Standard_EXPORT virtual const StepData_Field& Field (const Standard_Integer num) const;
  48
  49   //! Returns the field n0 <num> between 1 and NbFields, in order to
  50   //! modify its content
  51   Standard_EXPORT virtual StepData_Field& CField (const Standard_Integer num);
  52
  53   //! Fills an iterator with the entities shared by <me>
  54   Standard_EXPORT void FillShared (Interface_EntityIterator& iter) const;
  55 };
  56
  57 #endif // _StepData_FieldList_HeaderFile