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   data()->addAttribute(COMMENT_ID(), ModelAPI_AttributeString::typeId());
  38
  39   data()->addAttribute(EXPRESSION_ERROR_ID(), ModelAPI_AttributeString::typeId());
  40   data()->string(EXPRESSION_ERROR_ID())->setIsArgument(false);
  41   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), EXPRESSION_ERROR_ID());
  42
  43   data()->addAttribute(ARGUMENTS_ID(), ModelAPI_AttributeRefList::typeId());
  44   data()->reflist(ARGUMENTS_ID())->setIsArgument(false);
  45   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), ARGUMENTS_ID());
  46 }
  47
  48 bool ParametersPlugin_Parameter::isInHistory()
  49 {
  50   return false;
  51 }
  52
  53 void ParametersPlugin_Parameter::attributeChanged(const std::string& theID)
  54 {
  55   if (theID == EXPRESSION_ID())
  56     updateExpression();
  57
  58   data()->execState(ModelAPI_StateMustBeUpdated);
  59 }
  60
  61 void ParametersPlugin_Parameter::updateName()
  62 {
  63   std::string aName = string(VARIABLE_ID())->value();
  64   data()->setName(aName);
  65
  66   ResultParameterPtr aParam = document()->createParameter(data());
  67   aParam->data()->setName(aName);
  68   setResult(aParam);
  69 }
  70
  71 bool ParametersPlugin_Parameter::updateExpression()
  72 {
  73   std::string anExpression = string(EXPRESSION_ID())->value();
  74
  75   std::string outErrorMessage;
  76   double aValue = evaluate(anExpression, outErrorMessage);
  77
  78   data()->string(EXPRESSION_ERROR_ID())->setValue(outErrorMessage);
  79   if (!outErrorMessage.empty())
  80     return false;
  81
  82   ResultParameterPtr aParam = document()->createParameter(data());
  83   AttributeDoublePtr aValueAttribute = aParam->data()->real(ModelAPI_ResultParameter::VALUE());
  84   aValueAttribute->setValue(aValue);
  85   setResult(aParam);
  86   return true;
  87 }
  88
  89 void ParametersPlugin_Parameter::execute()
  90 {
  91   updateName();
  92   if (!updateExpression())
  93     setError("Expression error.", false);
  94 }
  95
  96 double ParametersPlugin_Parameter::evaluate(const std::string& theExpression, std::string& theError)
  97 {
  98   std::list<std::string> anExprParams = myInterp->compile(theExpression);
  99   // find expression's params in the model
 100   std::list<std::string> aContext;
 101   std::list<std::string>::iterator it = anExprParams.begin();
 102   std::list<ResultParameterPtr> aParamsList;
 103   for ( ; it != anExprParams.end(); it++) {
 104     std::string& aVariableName = *it;
 105
 106     // Parameter with the same name should be searched in the parent document.
 107     // For the PartSet assume that the parameter is absent.
 108     // Currently there is no way to get parent document, so we get PartSet for all.
 109     DocumentPtr aDocument = document();
 110     if (data()->name() == aVariableName) {
 111       if (aDocument == ModelAPI_Session::get()->moduleDocument())
 112         continue;
 113       aDocument = ModelAPI_Session::get()->moduleDocument();
 114     }
 115
 116     double aValue;
 117     ResultParameterPtr aParamRes;
 118     if (!ModelAPI_Tools::findVariable(aVariableName, aValue, aParamRes, aDocument)) continue;
 119     aParamsList.push_back(aParamRes);
 120
 121     std::ostringstream sstream;
 122     sstream << aValue;
 123     std::string aParamValue = sstream.str();
 124     aContext.push_back(*it + "=" + aParamValue);
 125   }
 126   // compare the list of parameters to store if changed
 127   AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
 128   bool aDifferent = aParams->size() != aParamsList.size();
 129   if (!aDifferent) {
 130     std::list<ResultParameterPtr>::iterator aNewIter = aParamsList.begin();
 131     std::list<ObjectPtr> anOldList = aParams->list();
 132     std::list<ObjectPtr>::iterator anOldIter = anOldList.begin();
 133     for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
 134       if (*aNewIter != *anOldIter)
 135         aDifferent = true;
 136     }
 137   }
 138   if (aDifferent) {
 139     aParams->clear();
 140     std::list<ResultParameterPtr>::iterator aNewIter = aParamsList.begin();
 141     for(; aNewIter != aParamsList.end(); aNewIter++) {
 142       aParams->append(*aNewIter);
 143     }
 144   }
 145
 146   myInterp->extendLocalContext(aContext);
 147   double result = myInterp->evaluate(theExpression, theError);
 148   myInterp->clearLocalContext();
 149   return result;
 150 }
 151
 152 bool ParametersPlugin_Parameter::isPreviewNeeded() const
 153 {
 154   return true;
 155 }