src/ParametersPlugin/ParametersPlugin_Parameter.cpp

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