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
0027 class Interface_ParamList;
0028 DEFINE_STANDARD_HANDLE(Interface_ParamList, Standard_Transient)
0029
0030
0031 class Interface_ParamList : public Standard_Transient
0032 {
0033
0034 public:
0035
0036
0037   //! Creates an vector with size of memory block equal to theIncrement
0038   Standard_EXPORT Interface_ParamList(const Standard_Integer theIncrement = 256);
0039
0040   //! Returns the number of elements of <me>.
0041     Standard_Integer Length() const;
0042
0043   //! Returns the lower bound.
0044   //! Warning
0045     Standard_Integer Lower() const;
0046
0047   //! Returns the upper bound.
0048   //! Warning
0049     Standard_Integer Upper() const;
0050
0051   //! Assigns the value <Value> to the <Index>-th item of this array.
0052   Standard_EXPORT void SetValue (const Standard_Integer Index, const Interface_FileParameter& Value);
0053
0054   //! Return the value of  the  <Index>th element of the
0055   //! array.
0056   Standard_EXPORT const Interface_FileParameter& Value (const Standard_Integer Index) const;
0057 const Interface_FileParameter& operator () (const Standard_Integer Index) const
0058 {
0059   return Value(Index);
0060 }
0061
0062   //! return the value  of the <Index>th element  of the
0063   //! array.
0064   Standard_EXPORT Interface_FileParameter& ChangeValue (const Standard_Integer Index);
0065 Interface_FileParameter& operator () (const Standard_Integer Index)
0066 {
0067   return ChangeValue(Index);
0068 }
0069
0070   Standard_EXPORT void Clear();
0071
0072
0073
0074
0075   DEFINE_STANDARD_RTTIEXT(Interface_ParamList,Standard_Transient)
0076
0077 protected:
0078
0079
0080
0081
0082 private:
0083
0084
0085   Interface_VectorOfFileParameter myVector;
0086
0087
0088 };
0089
0090
0091 #include <Interface_ParamList.lxx>
0092
0093
0094
0095
0096
0097 #endif // _Interface_ParamList_HeaderFile