include/opencascade/Interface_ParamList.hxx

0001 // Created on: 2008-01-21
0002 // Created by: Galina KULIKOVA
0003 // Copyright (c) 2008-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _Interface_ParamList_HeaderFile
0017 #define _Interface_ParamList_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <Interface_VectorOfFileParameter.hxx>
0022 #include <Standard_Transient.hxx>
0023 #include <Standard_Integer.hxx>
0024 class Interface_FileParameter;
0025
0026 class Interface_ParamList;
0027 DEFINE_STANDARD_HANDLE(Interface_ParamList, Standard_Transient)
0028
0029 class Interface_ParamList : public Standard_Transient
0030 {
0031
0032 public:
0033   //! Creates an vector with size of memory block equal to theIncrement
0034   Standard_EXPORT Interface_ParamList(const Standard_Integer theIncrement = 256);
0035
0036   //! Returns the number of elements of <me>.
0037   Standard_Integer Length() const;
0038
0039   //! Returns the lower bound.
0040   //! Warning
0041   Standard_Integer Lower() const;
0042
0043   //! Returns the upper bound.
0044   //! Warning
0045   Standard_Integer Upper() const;
0046
0047   //! Assigns the value <Value> to the <Index>-th item of this array.
0048   Standard_EXPORT void SetValue(const Standard_Integer Index, const Interface_FileParameter& Value);
0049
0050   //! Return the value of  the  <Index>th element of the
0051   //! array.
0052   Standard_EXPORT const Interface_FileParameter& Value(const Standard_Integer Index) const;
0053
0054   const Interface_FileParameter& operator()(const Standard_Integer Index) const
0055   {
0056     return Value(Index);
0057   }
0058
0059   //! return the value  of the <Index>th element  of the
0060   //! array.
0061   Standard_EXPORT Interface_FileParameter& ChangeValue(const Standard_Integer Index);
0062
0063   Interface_FileParameter& operator()(const Standard_Integer Index) { return ChangeValue(Index); }
0064
0065   Standard_EXPORT void Clear();
0066
0067   DEFINE_STANDARD_RTTIEXT(Interface_ParamList, Standard_Transient)
0068
0069 protected:
0070 private:
0071   Interface_VectorOfFileParameter myVector;
0072 };
0073
0074 #include <Interface_ParamList.lxx>
0075
0076 #endif // _Interface_ParamList_HeaderFile