src/SMESHGUI/SMESHGUI_Hypotheses.h

   1 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 // SMESH SMESHGUI : GUI for SMESH component
  24 // File   : SMESHGUI_Hypotheses.h
  25 // Author : Julia DOROVSKIKH, Open CASCADE S.A.S.
  26 //
  27 #ifndef SMESHGUI_HYPOTHESES_H
  28 #define SMESHGUI_HYPOTHESES_H
  29
  30 // SMESH includes
  31 #include "SMESH_SMESHGUI.hxx"
  32 #include "SMESHGUI_HypothesesUtils.h"
  33
  34 // Qt includes
  35 #include <QtxDialog.h>
  36 #include <QVariant>
  37
  38 // IDL includes
  39 #include <SALOMEconfig.h>
  40 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  41
  42 class QEventLoop;
  43
  44 /*!
  45  * \brief Auxiliary class for creation of hypotheses
  46 */
  47 class SMESHGUI_EXPORT SMESHGUI_GenericHypothesisCreator : public QObject
  48 {
  49   Q_OBJECT
  50
  51 public:
  52   SMESHGUI_GenericHypothesisCreator( const QString& );
  53   virtual ~SMESHGUI_GenericHypothesisCreator();
  54
  55   void                         create( SMESH::SMESH_Hypothesis_ptr,
  56                                        const QString&, QWidget*, QObject*, const QString& );
  57   void                         create( bool, const QString&, QWidget*, QObject*, const QString& );
  58   void                         edit( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*, QObject*, const QString& );
  59   void                         setInitParamsHypothesis(SMESH::SMESH_Hypothesis_ptr);
  60
  61   virtual bool                 checkParams( QString& ) const;
  62   virtual void                 onReject();
  63   virtual QString              helpPage() const;
  64
  65   QString                      hypType() const;
  66   QString                      hypName() const;
  67   bool                         isCreation() const;
  68
  69   QString                      getShapeEntry() const { return myShapeEntry; }
  70   void                         setShapeEntry( const QString& theEntry );
  71
  72   QString                      getMainShapeEntry() const { return myMainShapeEntry; }
  73   void                         setMainShapeEntry( const QString& theEntry ) { myMainShapeEntry = theEntry; }
  74
  75 signals:
  76   void                         finished( int );
  77
  78 protected:
  79   struct StdParam
  80   {
  81     QString   myName;
  82     QVariant  myValue;
  83     bool      isVariable;
  84     QString   myText;
  85     StdParam(){
  86       isVariable = false;
  87     }
  88     const char* text() const { return myText.toLatin1().constData(); }
  89   };
  90
  91   typedef QList<StdParam>      ListOfStdParams;
  92   typedef QList<QWidget*>      ListOfWidgets;
  93
  94   SMESH::SMESH_Hypothesis_var  hypothesis() const;
  95   SMESH::SMESH_Hypothesis_var  initParamsHypothesis(const bool strict=false) const;
  96   bool                         hasInitParamsHypothesis() const;
  97   const ListOfWidgets&         widgets() const;
  98   ListOfWidgets&               changeWidgets();
  99   QtxDialog*                   dlg() const;
 100   QString                      getVariableName(const char* methodName) const;
 101
 102   virtual QFrame*              buildFrame() = 0;
 103           QFrame*              buildStdFrame();
 104   virtual void                 retrieveParams() const = 0;
 105   virtual QString              storeParams() const = 0;
 106   virtual bool                 stdParams( ListOfStdParams& ) const;
 107   bool                         getStdParamFromDlg( ListOfStdParams& ) const;
 108   virtual QStringList          getVariablesFromDlg() const;
 109   static  QString              stdParamValues( const ListOfStdParams& );
 110   virtual void                 attuneStdWidget( QWidget*, const int ) const;
 111   virtual QWidget*             getCustomWidget( const StdParam&,
 112                                                 QWidget*, const int ) const;
 113   virtual bool                 getParamFromCustomWidget( StdParam&, QWidget* ) const;
 114   virtual void                 valueChanged( QWidget* );
 115   virtual QString              caption() const;
 116   virtual QPixmap              icon() const;
 117   virtual QString              type() const;
 118
 119 protected slots:
 120   virtual void                 onValueChanged();
 121
 122 private slots:
 123   virtual void                 onDialogFinished( int );
 124
 125 private:
 126   void                         editHypothesis( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*, QObject* obj, const QString& );
 127
 128 private:
 129   SMESH::SMESH_Hypothesis_var  myHypo, myInitParamsHypo;
 130   QString                      myHypName;
 131   QString                      myHypType;
 132   ListOfWidgets                myParamWidgets;
 133   bool                         myIsCreate;
 134   QtxDialog*                   myDlg;
 135   QString                      myShapeEntry;
 136   QString                      myMainShapeEntry;
 137 };
 138
 139 class SMESHGUI_HypothesisDlg : public QtxDialog
 140 {
 141   Q_OBJECT
 142
 143 public:
 144   SMESHGUI_HypothesisDlg( SMESHGUI_GenericHypothesisCreator*, QWidget* );
 145   virtual ~SMESHGUI_HypothesisDlg();
 146
 147   void setHIcon( const QPixmap& );
 148   void setCustomFrame( QFrame* );
 149   void setType( const QString& );
 150
 151 protected slots:
 152   virtual void accept();
 153   virtual void reject();
 154   void onHelp();
 155
 156 private:
 157   SMESHGUI_GenericHypothesisCreator* myCreator;
 158   QLabel *myIconLabel, *myTypeLabel;
 159   QString myHelpFileName;
 160 };
 161
 162 /*!
 163  * \brief Class containing information about hypothesis
 164 */
 165 class HypothesisData
 166 {
 167 public:
 168   HypothesisData( const QString&, const QString&, const QString&,
 169                   const QString&, const QString&, const QString&,
 170                   const QList<int>&, const bool,
 171                   const QStringList&, const QStringList&,
 172                   const QStringList&, const QStringList&,
 173                   const bool=true, const bool supportSub=false );
 174
 175   QString TypeName;        //!< hypothesis type name
 176   QString PluginName;      //!< plugin name
 177   QString ServerLibName;   //!< server library name
 178   QString ClientLibName;   //!< client library name
 179   QString Label;           //!< label
 180   QString IconId;          //!< icon identifier
 181   QList<int> Dim;          //!< list of supported dimensions (see SMESH::Dimension enumeration)
 182   bool IsAux;              //!< TRUE if given hypothesis is auxiliary one, FALSE otherwise
 183   bool IsNeedGeometry;     //!< TRUE if the algorithm works with shapes only, FALSE otherwise
 184   bool IsSupportSubmeshes; //!< TRUE if the algo building all-dim elems supports submeshes
 185
 186   // for algorithm only: dependencies algo <-> algo and algo -> hypos
 187   QStringList NeededHypos;  //!< list of obligatory hypotheses
 188   QStringList OptionalHypos;//!< list of optional hypotheses
 189   QStringList InputTypes;   //!< list of element types required as a prerequisite
 190   QStringList OutputTypes;  //!< list of types of generated elements
 191 };
 192
 193 /*!
 194  * \brief Class containing set of hypotheses
 195  *
 196  * Actually it contains list of hypo types
 197  */
 198 class HypothesesSet
 199 {
 200 public:
 201   HypothesesSet( const QString& );
 202   HypothesesSet( const QString&, const QStringList&, const QStringList& );
 203
 204   QString name() const;
 205   void set( bool, const QStringList& );
 206   int count( bool ) const;
 207
 208   void setIsCustom( bool );
 209   bool getIsCustom() const;
 210   int maxDim() const;
 211
 212   bool isAlgo() const;
 213
 214   //this method sets internal index to -1, thus before any data access it is necessary to call next()
 215   void init( bool );
 216
 217   bool more() const;
 218   void next();
 219   QString current() const;
 220
 221 private:
 222   QStringList* list(bool) const;
 223   QStringList* list() const;
 224
 225 private:
 226   QString     myHypoSetName;
 227   QStringList myHypoList, myAlgoList;
 228   bool myIsAlgo, myIsCustom;
 229   int myIndex;
 230 };
 231
 232 #endif // SMESHGUI_HYPOTHESES_H