include/opencascade/DNaming_CylinderDriver.hxx

0001 // Created on: 2009-05-04
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_CylinderDriver_HeaderFile
0017 #define _DNaming_CylinderDriver_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <TFunction_Driver.hxx>
0023 #include <Standard_Integer.hxx>
0024 class TFunction_Logbook;
0025 class TDF_Label;
0026 class BRepPrimAPI_MakeCylinder;
0027
0028 //! Computes Cylinder function
0029 class DNaming_CylinderDriver : public TFunction_Driver
0030 {
0031
0032 public:
0033   //! Constructor
0034   //! validation
0035   //! ==========
0036   Standard_EXPORT DNaming_CylinderDriver();
0037
0038   //! Validates labels of a function in <log>.
0039   //! In regeneration mode this method must be called (by the
0040   //! solver) even if the function is not executed, to build
0041   //! the valid label scope.
0042   //! execution of function
0043   //! ======================
0044   Standard_EXPORT void Validate(const occ::handle<TFunction_Logbook>& theLog) const override;
0045
0046   //! Analyse in <log> if the loaded function must be executed
0047   //! (i.e.arguments are modified) or not.
0048   //! If the Function label itself is modified, the function must
0049   //! be executed.
0050   Standard_EXPORT bool MustExecute(const occ::handle<TFunction_Logbook>& theLog) const override;
0051
0052   //! Execute the function and push in <log> the impacted
0053   //! labels (see method SetImpacted).
0054   Standard_EXPORT int Execute(occ::handle<TFunction_Logbook>& theLog) const override;
0055
0056   DEFINE_STANDARD_RTTIEXT(DNaming_CylinderDriver, TFunction_Driver)
0057
0058 private:
0059   Standard_EXPORT void LoadNamingDS(const TDF_Label&          theResultLabel,
0060                                     BRepPrimAPI_MakeCylinder& mkCyl) const;
0061 };
0062
0063 #endif // _DNaming_CylinderDriver_HeaderFile