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     QByteArray myTextAsBytes;
  86     StdParam() {
  87       isVariable = false;
  88     }
  89     const char* text() const {
  90       ((QByteArray&) myTextAsBytes) = myText.toLatin1(); return myTextAsBytes.constData();
  91     }
  92   };
  93
  94   typedef QList<StdParam>      ListOfStdParams;
  95   typedef QList<QWidget*>      ListOfWidgets;
  96
  97   SMESH::SMESH_Hypothesis_var  hypothesis() const;
  98   SMESH::SMESH_Hypothesis_var  initParamsHypothesis(const bool strict=false) const;
  99   bool                         hasInitParamsHypothesis() const;
 100   const ListOfWidgets&         widgets() const;
 101   ListOfWidgets&               changeWidgets();
 102   QtxDialog*                   dlg() const;
 103   QString                      getVariableName(const char* methodName) const;
 104
 105   virtual QFrame*              buildFrame() = 0;
 106           QFrame*              buildStdFrame();
 107   virtual void                 retrieveParams() const = 0;
 108   virtual QString              storeParams() const = 0;
 109   virtual bool                 stdParams( ListOfStdParams& ) const;
 110   bool                         getStdParamFromDlg( ListOfStdParams& ) const;
 111   virtual QStringList          getVariablesFromDlg() const;
 112   static  QString              stdParamValues( const ListOfStdParams& );
 113   virtual void                 attuneStdWidget( QWidget*, const int ) const;
 114   virtual QWidget*             getCustomWidget( const StdParam&,
 115                                                 QWidget*, const int ) const;
 116   virtual bool                 getParamFromCustomWidget( StdParam&, QWidget* ) const;
 117   virtual void                 valueChanged( QWidget* );
 118   virtual QString              caption() const;
 119   virtual QPixmap              icon() const;
 120   virtual QString              type() const;
 121
 122 protected slots:
 123   virtual void                 onValueChanged();
 124
 125 private slots:
 126   virtual void                 onDialogFinished( int );
 127
 128 private:
 129   void                         editHypothesis( SMESH::SMESH_Hypothesis_ptr, const QString&, QWidget*, QObject* obj, const QString& );
 130
 131 private:
 132   SMESH::SMESH_Hypothesis_var  myHypo, myInitParamsHypo;
 133   QString                      myHypName;
 134   QString                      myHypType;
 135   ListOfWidgets                myParamWidgets;
 136   bool                         myIsCreate;
 137   QtxDialog*                   myDlg;
 138   QString                      myShapeEntry;
 139   QString                      myMainShapeEntry;
 140 };
 141
 142 class SMESHGUI_HypothesisDlg : public QtxDialog
 143 {
 144   Q_OBJECT
 145
 146 public:
 147   SMESHGUI_HypothesisDlg( SMESHGUI_GenericHypothesisCreator*, QWidget* );
 148   virtual ~SMESHGUI_HypothesisDlg();
 149
 150   void setHIcon( const QPixmap& );
 151   void setCustomFrame( QFrame* );
 152   void setType( const QString& );
 153
 154 protected slots:
 155   virtual void accept();
 156   virtual void reject();
 157   void onHelp();
 158
 159 private:
 160   SMESHGUI_GenericHypothesisCreator* myCreator;
 161   QLabel *myIconLabel, *myTypeLabel;
 162   QString myHelpFileName;
 163 };
 164
 165 /*!
 166  * \brief Class containing information about hypothesis
 167 */
 168 class HypothesisData
 169 {
 170 public:
 171   HypothesisData( const QString&, const QString&, const QString&,
 172                   const QString&, const QString&, const QString&,
 173                   const QList<int>&, const bool,
 174                   const QStringList&, const QStringList&,
 175                   const QStringList&, const QStringList&,
 176                   const bool=true, const bool supportSub=false );
 177
 178   QString TypeName;        //!< hypothesis type name
 179   QString PluginName;      //!< plugin name
 180   QString ServerLibName;   //!< server library name
 181   QString ClientLibName;   //!< client library name
 182   QString Label;           //!< label
 183   QString IconId;          //!< icon identifier
 184   QList<int> Dim;          //!< list of supported dimensions (see SMESH::Dimension enumeration)
 185   bool IsAux;              //!< TRUE if given hypothesis is auxiliary one, FALSE otherwise
 186   bool IsNeedGeometry;     //!< TRUE if the algorithm works with shapes only, FALSE otherwise
 187   bool IsSupportSubmeshes; //!< TRUE if the algo building all-dim elems supports submeshes
 188
 189   // for algorithm only: dependencies algo <-> algo and algo -> hypos
 190   QStringList NeededHypos;  //!< list of obligatory hypotheses
 191   QStringList OptionalHypos;//!< list of optional hypotheses
 192   QStringList InputTypes;   //!< list of element types required as a prerequisite
 193   QStringList OutputTypes;  //!< list of types of generated elements
 194 };
 195
 196 /*!
 197  * \brief Class containing set of hypotheses
 198  *
 199  * Actually it contains list of hypo types
 200  */
 201 class HypothesesSet
 202 {
 203 public:
 204   HypothesesSet( const QString& );
 205   HypothesesSet( const QString&, const QStringList&, const QStringList& );
 206
 207   QString name() const;
 208   void set( bool, const QStringList& );
 209   int count( bool ) const;
 210
 211   void setIsCustom( bool );
 212   bool getIsCustom() const;
 213   int maxDim() const;
 214
 215   bool isAlgo() const;
 216
 217   //this method sets internal index to -1, thus before any data access it is necessary to call next()
 218   void init( bool );
 219
 220   bool more() const;
 221   void next();
 222   QString current() const;
 223
 224 private:
 225   QStringList* list(bool) const;
 226   QStringList* list() const;
 227
 228 private:
 229   QString     myHypoSetName;
 230   QStringList myHypoList, myAlgoList;
 231   bool myIsAlgo, myIsCustom;
 232   int myIndex;
 233 };
 234
 235 #endif // SMESHGUI_HYPOTHESES_H