include/opencascade/Transfer_BinderOfTransientInteger.hxx

0001 // Created on: 1995-02-27
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1995-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 _Transfer_BinderOfTransientInteger_HeaderFile
0018 #define _Transfer_BinderOfTransientInteger_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <Transfer_SimpleBinderOfTransient.hxx>
0025
0026 //! This type of Binder allows to attach as result, besides a
0027 //! Transient Object, an Integer Value, which can be an Index
0028 //! in the Object if it defines a List, for instance
0029 //!
0030 //! This Binder is otherwise a kind of SimpleBinderOfTransient,
0031 //! i.e. its basic result (for iterators, etc) is the Transient
0032 class Transfer_BinderOfTransientInteger : public Transfer_SimpleBinderOfTransient
0033 {
0034
0035 public:
0036   //! Creates an empty BinderOfTransientInteger; Default value for
0037   //! the integer part is zero
0038   Standard_EXPORT Transfer_BinderOfTransientInteger();
0039
0040   //! Sets a value for the integer part
0041   Standard_EXPORT void SetInteger(const int value);
0042
0043   //! Returns the value set for the integer part
0044   Standard_EXPORT int Integer() const;
0045
0046   DEFINE_STANDARD_RTTIEXT(Transfer_BinderOfTransientInteger, Transfer_SimpleBinderOfTransient)
0047
0048 private:
0049   int theintval;
0050 };
0051
0052 #endif // _Transfer_BinderOfTransientInteger_HeaderFile