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 "SALOMEDS.idl"
  28
  29 module ADAPT{
  30
  31     typedef sequence<string    > string_array ;
  32         struct MgAdaptHypothesisData
  33         {
  34                 string myFileInDir, myMeshFileIn, myInMeshName, myMeshFileBackground, myOutMeshName,
  35                         myMeshFileOut,  myFileOutDir, myFileSizeMapDir, myFieldName;
  36                 boolean    fromMedFile;
  37                 boolean    myPublish, myMeshOutMed;
  38                 boolean    myUseLocalMap, myUseBackgroundMap, myUseConstantValue;
  39                 double  myConstantValue;
  40                 long     myRank, myTimeStep;
  41                 boolean    myUseNoTimeStep, myUseLastTimeStep, myUseChosenTimeStep;
  42                 string myWorkingDir, myLogFile;
  43                 boolean    myPrintLogInFile, myKeepFiles, myRemoveLogOnSuccess;
  44                 long   myVerboseLevel;
  45
  46         };
  47
  48
  49     interface MG_ADAPT : Engines::EngineComponent
  50     {
  51
  52                 void setData( in MgAdaptHypothesisData data);
  53
  54                 void setMedFileIn(in string MedFileIn );
  55                 string getMedFileIn();
  56
  57                 void setMedFileOut(in string MedFileOut);
  58                 string getMedFileOut();
  59
  60                 void setMeshName(in string s);
  61                 string getMeshName();
  62
  63                 void setMeshNameOut(in string s);
  64                 string getMeshNameOut();
  65
  66                 void setMeshOutMed(in boolean b);
  67                 boolean getMeshOutMed();
  68
  69                 void setPublish(in boolean b);
  70                 boolean getPublish();
  71
  72                 void setFieldName(in string s);
  73                 string getFieldName();
  74
  75                 void setTimeStep(in long s);
  76                 long getTimeStep() ;
  77
  78                 void setRankTimeStep(in long s, in long f);
  79                 long getRank();
  80
  81                 void setLogFile(in string f);
  82                 string getLogFile();
  83
  84                 void setVerbosityLevel(in long f);
  85                 long getVerbosityLevel();
  86
  87                 void setRemoveOnSuccess(in boolean f);
  88                 boolean getRemoveOnSuccess();
  89
  90                 MgAdaptHypothesisData getData();
  91
  92                 void setUseLocalMap(in boolean f);
  93                 boolean getUseLocalMap();
  94
  95                 void setUseBackgroundMap(in boolean f);
  96                 boolean getUseBackgroundMap();
  97
  98                 void setUseConstantValue(in boolean f);
  99                 boolean getUseConstantValue();
 100
 101                 void setConstantValue(in double f);
 102                 double getConstantValue() ;
 103
 104                 void setSizeMapFile(in string f);
 105                 string getSizeMapFile();
 106
 107                 void setFromMedFile(in boolean f);
 108                 boolean isFromMedFile();
 109
 110                 void setKeepWorkingFiles(in boolean f);
 111                 boolean getKeepWorkingFiles();
 112
 113                 void setPrintLogInFile(in boolean f);
 114                 boolean getPrintLogInFile();
 115
 116                 void setWorkingDir(in string f);
 117                 string getWorkingDir() ;
 118
 119
 120                 boolean setAll();
 121                 string getCommandToRun() ;
 122                 long compute(inout string errStr);
 123                 string getFileName() ;
 124                 string getExeName();
 125                 void copyMgAdaptHypothesisData(in  MgAdaptHypothesisData f ) ;
 126
 127                 void checkDirPath(in string  f);
 128
 129
 130
 131                 boolean hasOptionDefined( in string optionName ) ;
 132                 void setOptionValue(in  string optionName,
 133                                                         in  string optionValue) raises (SALOME::SALOME_Exception);
 134                 string getOptionValue(in  string optionName,
 135                                                                    in boolean  isDefault) raises (SALOME::SALOME_Exception);
 136                 string_array getCustomOptionValuesStrVec() ;
 137                 string_array getOptionValuesStrVec() ;
 138     };
 139
 140
 141 };
 142 #endif // MG_ADAPT_IDL