include/opencascade/DNaming_Line3DDriver.hxx

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