include/opencascade/DNaming_SelectionDriver.hxx

0001 // Created on: 2009-05-05
0002 // Created by: Sergey ZARITCHNY <sergey.zaritchny@opencascade.com>
0003 // Copyright (c) 2009-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 _DNaming_SelectionDriver_HeaderFile
0017 #define _DNaming_SelectionDriver_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TFunction_Driver.hxx>
0022 #include <Standard_Integer.hxx>
0023 class TFunction_Logbook;
0024
0025 class DNaming_SelectionDriver;
0026 DEFINE_STANDARD_HANDLE(DNaming_SelectionDriver, TFunction_Driver)
0027
0028 class DNaming_SelectionDriver : public TFunction_Driver
0029 {
0030
0031 public:
0032   //! Constructor
0033   //! validation
0034   //! ==========
0035   Standard_EXPORT DNaming_SelectionDriver();
0036
0037   //! Validates labels of a function in <log>.
0038   //! In regeneration mode this method must be called (by the
0039   //! solver) even if the function is not executed, to build
0040   //! the valid label scope.
0041   //! execution of function
0042   //! ======================
0043   Standard_EXPORT virtual void Validate(Handle(TFunction_Logbook)& theLog) const Standard_OVERRIDE;
0044
0045   //! Analyse in <log> if the loaded function must be executed
0046   //! (i.e.arguments are modified) or not.
0047   //! If the Function label itself is modified, the function must
0048   //! be executed.
0049   Standard_EXPORT virtual Standard_Boolean MustExecute(
0050     const Handle(TFunction_Logbook)& theLog) const Standard_OVERRIDE;
0051
0052   //! Execute the function and push in <log> the impacted
0053   //! labels (see method SetImpacted).
0054   Standard_EXPORT virtual Standard_Integer Execute(Handle(TFunction_Logbook)& theLog) const
0055     Standard_OVERRIDE;
0056
0057   DEFINE_STANDARD_RTTIEXT(DNaming_SelectionDriver, TFunction_Driver)
0058
0059 protected:
0060 private:
0061 };
0062
0063 #endif // _DNaming_SelectionDriver_HeaderFile