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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #include <pyconfig.h>
  21
  22 #include "ParametersPlugin_Parameter.h"
  23
  24 #include <ModelAPI_AttributeString.h>
  25 #include <ModelAPI_ResultParameter.h>
  26 #include <ModelAPI_AttributeDouble.h>
  27 #include <ModelAPI_AttributeRefList.h>
  28 #include <ModelAPI_Tools.h>
  29 #include <ModelAPI_Session.h>
  30 #include <ModelAPI_Validator.h>
  31 #include <ModelAPI_Events.h>
  32
  33 #include <string>
  34 #include <sstream>
  35
  36 ParametersPlugin_Parameter::ParametersPlugin_Parameter()
  37 {
  38 }
  39
  40 ParametersPlugin_Parameter::~ParametersPlugin_Parameter()
  41 {
  42 }
  43
  44 void ParametersPlugin_Parameter::initAttributes()
  45 {
  46   data()->addAttribute(VARIABLE_ID(), ModelAPI_AttributeString::typeId());
  47   data()->addAttribute(EXPRESSION_ID(), ModelAPI_AttributeString::typeId());
  48
  49   data()->addAttribute(COMMENT_ID(), ModelAPI_AttributeString::typeId());
  50   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), COMMENT_ID());
  51
  52   data()->addAttribute(EXPRESSION_ERROR_ID(), ModelAPI_AttributeString::typeId());
  53   data()->string(EXPRESSION_ERROR_ID())->setIsArgument(false);
  54   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), EXPRESSION_ERROR_ID());
  55
  56   data()->addAttribute(ARGUMENTS_ID(), ModelAPI_AttributeRefList::typeId());
  57   data()->reflist(ARGUMENTS_ID())->setIsArgument(false);
  58   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), ARGUMENTS_ID());
  59 }
  60
  61 bool ParametersPlugin_Parameter::isInHistory()
  62 {
  63   return false;
  64 }
  65
  66 void ParametersPlugin_Parameter::attributeChanged(const std::string& theID)
  67 {
  68   if (theID == EXPRESSION_ID())
  69     updateExpression();
  70
  71   data()->execState(ModelAPI_StateMustBeUpdated);
  72 }
  73
  74 void ParametersPlugin_Parameter::updateName()
  75 {
  76   std::string aName = string(VARIABLE_ID())->value();
  77   data()->setName(aName);
  78
  79   ResultParameterPtr aParam = document()->createParameter(data());
  80   aParam->data()->setName(aName);
  81   setResult(aParam);
  82 }
  83
  84 bool ParametersPlugin_Parameter::updateExpression()
  85 {
  86   std::string anExpression = string(EXPRESSION_ID())->value();
  87
  88   std::string outErrorMessage;
  89   double aValue = evaluate(anExpression, outErrorMessage);
  90
  91   data()->string(EXPRESSION_ERROR_ID())->setValue(outErrorMessage);
  92   if (!outErrorMessage.empty())
  93     return false;
  94
  95   ResultParameterPtr aParam = document()->createParameter(data());
  96   AttributeDoublePtr aValueAttribute = aParam->data()->real(ModelAPI_ResultParameter::VALUE());
  97   aValueAttribute->setValue(aValue);
  98   setResult(aParam);
  99   return true;
 100 }
 101
 102 void ParametersPlugin_Parameter::execute()
 103 {
 104   updateName();
 105   if (!updateExpression())
 106     setError("Expression error.", false);
 107 }
 108
 109 double ParametersPlugin_Parameter::evaluate(const std::string& theExpression, std::string& theError)
 110 {
 111   FeaturePtr aMyPtr = std::dynamic_pointer_cast<ModelAPI_Feature>(data()->owner());
 112   std::shared_ptr<ModelAPI_ParameterEvalMessage> aProcessMessage =
 113     ModelAPI_ParameterEvalMessage::send(aMyPtr, this);
 114
 115   double aResult = 0;
 116   if (aProcessMessage->isProcessed()) {
 117     const std::list<ResultParameterPtr>& aParamsList = aProcessMessage->params();
 118     aResult = aProcessMessage->result();
 119     theError = aProcessMessage->error();
 120     // compare the list of parameters to store if changed
 121     AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
 122     bool aDifferent = aParams->size() != aParamsList.size();
 123     if (!aDifferent) {
 124       std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
 125       std::list<ObjectPtr> anOldList = aParams->list();
 126       std::list<ObjectPtr>::const_iterator anOldIter = anOldList.begin();
 127       for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
 128         if (*aNewIter != *anOldIter)
 129           aDifferent = true;
 130       }
 131     }
 132     if (aDifferent) {
 133       aParams->clear();
 134       std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
 135       for(; aNewIter != aParamsList.end(); aNewIter++) {
 136         aParams->append(*aNewIter);
 137       }
 138     }
 139   } else { // error: python interpreter is not active
 140     theError = "Python interpreter is not available";
 141   }
 142   return aResult;
 143 }
 144
 145 bool ParametersPlugin_Parameter::isPreviewNeeded() const
 146 {
 147   return true;
 148 }