src/ParametersPlugin/ParametersPlugin_Parameter.cpp

   1 // Copyright (C) 2014-2023  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/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include <pyconfig.h>
  21
  22 #include "ParametersPlugin_Parameter.h"
  23
  24 #include <Locale_Convert.h>
  25
  26 #include <ModelAPI_AttributeString.h>
  27 #include <ModelAPI_ResultParameter.h>
  28 #include <ModelAPI_AttributeDouble.h>
  29 #include <ModelAPI_AttributeRefList.h>
  30 #include <ModelAPI_Tools.h>
  31 #include <ModelAPI_Session.h>
  32 #include <ModelAPI_Validator.h>
  33 #include <ModelAPI_Events.h>
  34
  35 #include <string>
  36 #include <sstream>
  37
  38 ParametersPlugin_Parameter::ParametersPlugin_Parameter()
  39 {
  40 }
  41
  42 ParametersPlugin_Parameter::~ParametersPlugin_Parameter()
  43 {
  44 }
  45
  46 void ParametersPlugin_Parameter::initAttributes()
  47 {
  48   data()->addAttribute(VARIABLE_ID(), ModelAPI_AttributeString::typeId());
  49   data()->addAttribute(EXPRESSION_ID(), ModelAPI_AttributeString::typeId());
  50
  51   data()->addAttribute(COMMENT_ID(), ModelAPI_AttributeString::typeId());
  52   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), COMMENT_ID());
  53
  54   data()->addAttribute(EXPRESSION_ERROR_ID(), ModelAPI_AttributeString::typeId());
  55   data()->string(EXPRESSION_ERROR_ID())->setIsArgument(false);
  56   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), EXPRESSION_ERROR_ID());
  57
  58   data()->addAttribute(ARGUMENTS_ID(), ModelAPI_AttributeRefList::typeId());
  59   data()->reflist(ARGUMENTS_ID())->setIsArgument(false);
  60   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), ARGUMENTS_ID());
  61 }
  62
  63 bool ParametersPlugin_Parameter::isInHistory()
  64 {
  65   return false;
  66 }
  67
  68 void ParametersPlugin_Parameter::attributeChanged(const std::string& theID)
  69 {
  70   if (theID == EXPRESSION_ID())
  71     updateExpression();
  72
  73   data()->execState(ModelAPI_StateMustBeUpdated);
  74 }
  75
  76 void ParametersPlugin_Parameter::updateName()
  77 {
  78   std::wstring aName = string(VARIABLE_ID())->isUValue() ?
  79       Locale::Convert::toWString(string(VARIABLE_ID())->valueU()) :
  80       Locale::Convert::toWString(string(VARIABLE_ID())->value());
  81   data()->setName(aName);
  82
  83   ResultParameterPtr aParam = document()->createParameter(data());
  84   std::wstring anOldName = aParam->data()->name();
  85   aParam->data()->setName(aName);
  86   setResult(aParam);
  87
  88
  89   // #2474 : if parameter name now hides/shows the higher level parameter name,
  90   // update the depended expressions
  91   DocumentPtr aRootDoc = ModelAPI_Session::get()->moduleDocument();
  92   if (aParam->document() != aRootDoc) {
  93     std::list<std::wstring> aNames; // collect names in the root document that must be checked
  94     aNames.push_back(aName);
  95     if (anOldName != aName) {
  96       aNames.push_back(anOldName);
  97     }
  98     std::list<std::wstring>::iterator aNIter = aNames.begin();
  99     for (; aNIter != aNames.end(); aNIter++) {
 100       double aValue;
 101       ResultParameterPtr aRootParam;
 102       FeaturePtr aThis =
 103         std::dynamic_pointer_cast<ModelAPI_Feature>(string(VARIABLE_ID())->owner());
 104       if (ModelAPI_Tools::findVariable(aThis, *aNIter, aValue, aRootParam, aRootDoc)) {
 105         std::set<std::shared_ptr<ModelAPI_Attribute> > anAttributes =
 106           aRootParam->data()->refsToMe();
 107         std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator anAttributeIt =
 108           anAttributes.cbegin();
 109         for (; anAttributeIt != anAttributes.cend(); ++anAttributeIt) {
 110           const AttributePtr& anAttribute = *anAttributeIt;
 111           ModelAPI_AttributeEvalMessage::send(anAttribute, NULL);
 112         }
 113       }
 114     }
 115   }
 116 }
 117
 118 bool ParametersPlugin_Parameter::updateExpression()
 119 {
 120   std::wstring anExpression = string(EXPRESSION_ID())->isUValue() ?
 121       Locale::Convert::toWString(string(EXPRESSION_ID())->valueU()) :
 122       Locale::Convert::toWString(string(EXPRESSION_ID())->value());
 123
 124   std::string outErrorMessage;
 125   double aValue = evaluate(anExpression, outErrorMessage);
 126
 127   data()->string(EXPRESSION_ERROR_ID())->setValue(outErrorMessage);
 128   if (!outErrorMessage.empty())
 129     return false;
 130
 131   ResultParameterPtr aParam = document()->createParameter(data());
 132   AttributeDoublePtr aValueAttribute = aParam->data()->real(ModelAPI_ResultParameter::VALUE());
 133   aValueAttribute->setValue(aValue);
 134   setResult(aParam);
 135
 136   return true;
 137 }
 138
 139 void ParametersPlugin_Parameter::execute()
 140 {
 141   updateName();
 142   if (!updateExpression())
 143     setError("Expression error.", false);
 144 }
 145
 146 double ParametersPlugin_Parameter::evaluate(const std::wstring& /*theExpression*/,
 147                                             std::string& theError)
 148 {
 149   FeaturePtr aMyPtr = std::dynamic_pointer_cast<ModelAPI_Feature>(data()->owner());
 150   std::shared_ptr<ModelAPI_ParameterEvalMessage> aProcessMessage =
 151     ModelAPI_ParameterEvalMessage::send(aMyPtr, this);
 152
 153   double aResult = 0;
 154   if (aProcessMessage->isProcessed()) {
 155     const std::list<ResultParameterPtr>& aParamsList = aProcessMessage->params();
 156     aResult = aProcessMessage->result();
 157     theError = aProcessMessage->error();
 158     // compare the list of parameters to store if changed
 159     AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
 160     bool aDifferent = aParams->size() != (int)aParamsList.size();
 161     if (!aDifferent) {
 162       std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
 163       std::list<ObjectPtr> anOldList = aParams->list();
 164       std::list<ObjectPtr>::const_iterator anOldIter = anOldList.begin();
 165       for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
 166         if (*aNewIter != *anOldIter)
 167           aDifferent = true;
 168       }
 169     }
 170     if (aDifferent) {
 171       aParams->clear();
 172       std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
 173       for(; aNewIter != aParamsList.end(); aNewIter++) {
 174         aParams->append(*aNewIter);
 175       }
 176     }
 177   } else { // error: python interpreter is not active
 178     theError = "Python interpreter is not available";
 179   }
 180   return aResult;
 181 }
 182
 183 bool ParametersPlugin_Parameter::isPreviewNeeded() const
 184 {
 185   return true;
 186 }