include/opencascade/StepData_FieldList.hxx

0001 // Created on: 1997-04-01
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1997-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 _StepData_FieldList_HeaderFile
0018 #define _StepData_FieldList_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 class StepData_Field;
0025 class Interface_EntityIterator;
0026
0027
0028 //! Describes a list of fields, in a general way
0029 //! This basic class is for a null size list
0030 //! Subclasses are for 1, N (fixed) or Dynamic sizes
0031 class StepData_FieldList
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Destructor is virtual
0038   Standard_EXPORT virtual ~StepData_FieldList();
0039
0040   //! Creates a FieldList of 0 Field
0041   Standard_EXPORT StepData_FieldList();
0042
0043   //! Returns the count of fields. Here, returns 0
0044   Standard_EXPORT virtual Standard_Integer NbFields() const;
0045
0046   //! Returns the field n0 <num> between 1 and NbFields (read only)
0047   Standard_EXPORT virtual const StepData_Field& Field (const Standard_Integer num) const;
0048
0049   //! Returns the field n0 <num> between 1 and NbFields, in order to
0050   //! modify its content
0051   Standard_EXPORT virtual StepData_Field& CField (const Standard_Integer num);
0052
0053   //! Fills an iterator with the entities shared by <me>
0054   Standard_EXPORT void FillShared (Interface_EntityIterator& iter) const;
0055 };
0056
0057 #endif // _StepData_FieldList_HeaderFile