include/opencascade/StepData_FieldListN.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_FieldListN_HeaderFile
0018 #define _StepData_FieldListN_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <StepData_Field.hxx>
0025 #include <NCollection_Array1.hxx>
0026 #include <StepData_FieldList.hxx>
0027 class StepData_Field;
0028
0029 //! Describes a list of fields, in a general way
0030 //! This basic class is for a null size list
0031 //! Subclasses are for 1, N (fixed) or Dynamic sizes
0032 class StepData_FieldListN : public StepData_FieldList
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Creates a FieldListN of <nb> Fields
0038   Standard_EXPORT StepData_FieldListN(const int nb);
0039
0040   //! Returns the count of fields. Here, returns starting <nb>
0041   Standard_EXPORT int NbFields() const override;
0042
0043   //! Returns the field n0 <num> between 1 and NbFields (read only)
0044   Standard_EXPORT const StepData_Field& Field(const int num) const override;
0045
0046   //! Returns the field n0 <num> between 1 and NbFields, in order to
0047   //! modify its content
0048   Standard_EXPORT StepData_Field& CField(const int num) override;
0049
0050 private:
0051   NCollection_Array1<StepData_Field> thefields;
0052 };
0053
0054 #endif // _StepData_FieldListN_HeaderFile