1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : GEOM_BaseDriver.hxx
24 // Created : Thu Jun 6 15:27:50 2013
25 // Author : Edward AGAPOV (eap)
27 #ifndef __GEOM_BaseDriver_HXX__
28 #define __GEOM_BaseDriver_HXX__
30 #include "GEOM_Function.hxx"
32 #include <TFunction_Driver.hxx>
33 #include <TFunction_Logbook.hxx>
34 #include <TopAbs_ShapeEnum.hxx>
35 #include <TopAbs_State.hxx>
36 #include <TColStd_HSequenceOfTransient.hxx>
37 #include <TColStd_HArray1OfInteger.hxx>
39 #include <Basics_OCCTVersion.hxx>
45 #if OCC_VERSION_MAJOR < 7
46 #define LOGBOOK TFunction_Logbook
48 #define LOGBOOK Handle(TFunction_Logbook)
56 Standard_EXPORT void Set(const char* nm) { name = nm; }
58 Standard_EXPORT void Set(const char* nm, const T& value) { name = nm; (*this)<<value; }
60 template <class T> Standard_EXPORT GEOM_Param & operator<<( const T &anything )
62 std::ostringstream str;
67 Standard_EXPORT GEOM_Param & operator<<( const Handle(GEOM_Function)& fun );
68 Standard_EXPORT GEOM_Param & operator<<( const Handle(Standard_Transient)& fun );
69 Standard_EXPORT GEOM_Param & operator<<( const Handle(TColStd_HSequenceOfTransient)& funs );
70 Standard_EXPORT GEOM_Param & operator<<( const Handle(TColStd_HArray1OfInteger)& vals );
71 Standard_EXPORT GEOM_Param & operator<<( TopAbs_ShapeEnum type );
72 Standard_EXPORT GEOM_Param & operator<<( TopAbs_State state );
76 class GEOM_BaseDriver : public TFunction_Driver
79 // Returns document id
80 Standard_EXPORT int GetDocID() const;
82 // Returns a name of creation operation and names and values of creation parameters
83 // (Use AddParam() methods declared below to fill params vector while implementing
84 // this method in derived drivers)
85 Standard_EXPORT virtual
86 bool GetCreationInformation(std::string& theOperationName,
87 std::vector<GEOM_Param>& params) = 0;
89 // Adds GEOM_Param to params and sets its name
90 // This method is safer than resizing the params vector and accessing to its items
91 Standard_EXPORT GEOM_Param& AddParam(std::vector<GEOM_Param>& params,
94 // Adds GEOM_Param to params vector and sets its name and value
95 // This method is safer than resizing the params vector and accessing to its items
97 Standard_EXPORT GEOM_Param& AddParam(std::vector<GEOM_Param>& params,
100 const char* dfltValue = 0)
103 p.Set( name, value );
104 if ( dfltValue && p.value.empty() )
106 params.push_back( p );
107 return params.back();
110 OCCT_DEFINE_STANDARD_RTTIEXT(GEOM_BaseDriver,TFunction_Driver)
113 DEFINE_STANDARD_HANDLE (GEOM_BaseDriver,TFunction_Driver);