src/ParametersPlugin/ParametersPlugin_Parameter.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        ParametersPlugin_Parameter.cpp
   4 // Created:     23 MArch 2015
   5 // Author:      sbh
   6
   7 #include <pyconfig.h>
   8
   9 #include "ParametersPlugin_Parameter.h"
  10 #include <ParametersPlugin_PyInterp.h>
  11
  12 #include <ModelAPI_AttributeString.h>
  13 #include <ModelAPI_ResultParameter.h>
  14 #include <ModelAPI_AttributeDouble.h>
  15 #include <ModelAPI_AttributeRefList.h>
  16 #include <ModelAPI_Tools.h>
  17 #include <ModelAPI_Session.h>
  18 #include <ModelAPI_Validator.h>
  19
  20 #include <string>
  21 #include <sstream>
  22
  23 ParametersPlugin_Parameter::ParametersPlugin_Parameter()
  24 {
  25   myInterp = std::shared_ptr<ParametersPlugin_PyInterp>(new ParametersPlugin_PyInterp());
  26   myInterp->initialize();
  27 }
  28
  29 ParametersPlugin_Parameter::~ParametersPlugin_Parameter()
  30 {
  31 }
  32
  33 void ParametersPlugin_Parameter::initAttributes()
  34 {
  35   data()->addAttribute(VARIABLE_ID(), ModelAPI_AttributeString::typeId());
  36   data()->addAttribute(EXPRESSION_ID(), ModelAPI_AttributeString::typeId());
  37
  38   data()->addAttribute(EXPRESSION_ERROR_ID(), ModelAPI_AttributeString::typeId());
  39   data()->string(EXPRESSION_ERROR_ID())->setIsArgument(false);
  40   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), EXPRESSION_ERROR_ID());
  41
  42   data()->addAttribute(ARGUMENTS_ID(), ModelAPI_AttributeRefList::typeId());
  43   data()->reflist(ARGUMENTS_ID())->setIsArgument(false);
  44   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), ARGUMENTS_ID());
  45 }
  46
  47 bool ParametersPlugin_Parameter::isInHistory()
  48 {
  49   return false;
  50 }
  51
  52 void ParametersPlugin_Parameter::attributeChanged(const std::string& theID)
  53 {
  54   if (theID == EXPRESSION_ID())
  55     updateExpression();
  56 }
  57
  58 void ParametersPlugin_Parameter::updateName()
  59 {
  60   std::string aName = string(VARIABLE_ID())->value();
  61   data()->setName(aName);
  62
  63   ResultParameterPtr aParam = document()->createParameter(data());
  64   aParam->data()->setName(aName);
  65   setResult(aParam);
  66 }
  67
  68 void ParametersPlugin_Parameter::updateExpression()
  69 {
  70   std::string anExpression = string(EXPRESSION_ID())->value();
  71
  72   std::string outErrorMessage;
  73   double aValue = evaluate(anExpression, outErrorMessage);
  74
  75   data()->string(EXPRESSION_ERROR_ID())->setValue(outErrorMessage);
  76   if (!outErrorMessage.empty()) {
  77     setError("Expression error.", false);
  78     data()->execState(ModelAPI_StateExecFailed);
  79     return;
  80   }
  81
  82   ResultParameterPtr aParam = document()->createParameter(data());
  83   AttributeDoublePtr aValueAttribute = aParam->data()->real(ModelAPI_ResultParameter::VALUE());
  84   aValueAttribute->setValue(aValue);
  85   setResult(aParam);
  86
  87   setError("", false);
  88   data()->execState(ModelAPI_StateDone);
  89 }
  90
  91 void ParametersPlugin_Parameter::execute()
  92 {
  93   updateName();
  94   updateExpression();
  95 }
  96
  97 double ParametersPlugin_Parameter::evaluate(const std::string& theExpression, std::string& theError)
  98 {
  99   std::list<std::string> anExprParams = myInterp->compile(theExpression);
 100   // find expression's params in the model
 101   std::list<std::string> aContext;
 102   std::list<std::string>::iterator it = anExprParams.begin();
 103   std::list<ResultParameterPtr> aParamsList;
 104   for ( ; it != anExprParams.end(); it++) {
 105     std::string& aVariableName = *it;
 106
 107     // parameter with the same name should be searched in the parent document
 108     // currently there is no way to get parent document, so we get PartSet doc
 109     DocumentPtr aDocument = document();
 110     if (data()->name() == aVariableName)
 111       aDocument = ModelAPI_Session::get()->moduleDocument();
 112
 113     double aValue;
 114     ResultParameterPtr aParamRes;
 115     if (!ModelAPI_Tools::findVariable(aVariableName, aValue, aParamRes, aDocument)) continue;
 116     aParamsList.push_back(aParamRes);
 117
 118     std::ostringstream sstream;
 119     sstream << aValue;
 120     std::string aParamValue = sstream.str();
 121     aContext.push_back(*it + "=" + aParamValue);
 122   }
 123   // compare the list of parameters to store if changed
 124   AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
 125   bool aDifferent = aParams->size() != aParamsList.size();
 126   if (!aDifferent) {
 127     std::list<ResultParameterPtr>::iterator aNewIter = aParamsList.begin();
 128     std::list<ObjectPtr> anOldList = aParams->list();
 129     std::list<ObjectPtr>::iterator anOldIter = anOldList.begin();
 130     for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
 131       if (*aNewIter != *anOldIter)
 132         aDifferent = true;
 133     }
 134   }
 135   if (aDifferent) {
 136     aParams->clear();
 137     std::list<ResultParameterPtr>::iterator aNewIter = aParamsList.begin();
 138     for(; aNewIter != aParamsList.end(); aNewIter++) {
 139       aParams->append(*aNewIter);
 140     }
 141   }
 142
 143   myInterp->extendLocalContext(aContext);
 144   double result = myInterp->evaluate(theExpression, theError);
 145   myInterp->clearLocalContext();
 146   return result;
 147 }
 148
 149 bool ParametersPlugin_Parameter::isPreviewNeeded() const
 150 {
 151   return false;
 152 }