idl/MG_ADAPT.idl

   1 // Copyright (C) 2011-2020  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/
  18 //
  19 // File   : MG_ADAPT.hxx
  20 //
  21 #ifndef MG_ADAPT_IDL
  22 #define MG_ADAPT_IDL
  23
  24
  25 #include "SALOME_Component.idl"
  26 #include "SALOME_Exception.idl"
  27 #include "SALOME_GenericObj.idl"
  28 #include "SALOMEDS.idl"
  29 #include "SMESH_Mesh.idl"
  30
  31 module SMESH{
  32
  33     typedef sequence<string> str_array ;
  34         struct MgAdaptHypothesisData
  35         {
  36                 string myFileInDir, myMeshFileIn, myInMeshName, myMeshFileBackground, myOutMeshName,
  37                         myMeshFileOut,  myFileOutDir, myFileSizeMapDir, myFieldName;
  38                 boolean    fromMedFile;
  39                 boolean    myPublish, myMeshOutMed;
  40                 boolean    myUseLocalMap, myUseBackgroundMap, myUseConstantValue;
  41                 double  myConstantValue;
  42                 long     myRank, myTimeStep;
  43                 boolean    myUseNoTimeStep, myUseLastTimeStep, myUseChosenTimeStep;
  44                 string myWorkingDir, myLogFile;
  45                 boolean    myPrintLogInFile, myKeepFiles, myRemoveLogOnSuccess;
  46                 long   myVerboseLevel;
  47
  48         };
  49
  50
  51     interface MG_ADAPT : SALOME::GenericObj
  52     {
  53                 //MG_ADAPT CreateMG_ADAPT(in PortableServer::POA_var poa);
  54                 void setData( inout MgAdaptHypothesisData data);
  55
  56                 void setMedFileIn(in string MedFileIn );
  57                 string getMedFileIn();
  58
  59                 void setMedFileOut(in string MedFileOut);
  60                 string getMedFileOut();
  61
  62                 void setMeshName(in string s);
  63                 string getMeshName();
  64
  65                 void setMeshNameOut(in string s);
  66                 string getMeshNameOut();
  67
  68                 void setMeshOutMed(in boolean b);
  69                 boolean getMeshOutMed();
  70
  71                 void setPublish(in boolean b);
  72                 boolean getPublish();
  73
  74                 void setFieldName(in string s);
  75                 string getFieldName();
  76
  77                 void setTimeStep(in long s);
  78                 long getTimeStep() ;
  79
  80                 void setRankTimeStep(in long s, in long f);
  81                 long getRank();
  82
  83                 void setTimeStepRankLast();
  84                 void setNoTimeStep();
  85
  86                 void setLogFile(in string f);
  87                 string getLogFile();
  88
  89                 void setVerbosityLevel(in long f);
  90                 long getVerbosityLevel();
  91
  92                 void setRemoveOnSuccess(in boolean f);
  93                 boolean getRemoveOnSuccess();
  94
  95                 MgAdaptHypothesisData getData();
  96
  97                 void setUseLocalMap(in boolean f);
  98                 boolean getUseLocalMap();
  99
 100                 void setUseBackgroundMap(in boolean f);
 101                 boolean getUseBackgroundMap();
 102
 103                 void setUseConstantValue(in boolean f);
 104                 boolean getUseConstantValue();
 105
 106                 void setConstantValue(in double f);
 107                 double getConstantValue() ;
 108
 109                 void setSizeMapFile(in string f);
 110                 string getSizeMapFile();
 111
 112                 void setFromMedFile(in boolean f);
 113                 boolean isFromMedFile();
 114
 115                 void setKeepWorkingFiles(in boolean f);
 116                 boolean getKeepWorkingFiles();
 117
 118                 void setPrintLogInFile(in boolean f);
 119                 boolean getPrintLogInFile();
 120
 121                 void setWorkingDir(in string f);
 122                 string getWorkingDir() ;
 123
 124
 125                 boolean setAll();
 126                 string getCommandToRun() ;
 127                 //long compute(out string errStr);
 128                 long compute();
 129                 string getErrMsg();
 130                 string getFileName() ;
 131                 string getExeName();
 132                 void copyMgAdaptHypothesisData(in  MgAdaptHypothesisData f ) ;
 133
 134                 //void checkDirPath(inout string  f);
 135
 136
 137
 138                 boolean hasOptionDefined( in string optionName ) ;
 139                 void setOptionValue(in  string optionName,
 140                                                         in  string optionValue) raises (SALOME::SALOME_Exception);
 141                 string getOptionValue(in  string optionName,
 142                                                                    inout boolean  isDefault) raises (SALOME::SALOME_Exception);
 143                 str_array getCustomOptionValuesStrVec() ;
 144                 str_array getOptionValuesStrVec() ;
 145     };
 146
 147
 148 };
 149 #endif // MG_ADAPT_IDL