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
  11 #include <ModelAPI_AttributeString.h>
  12 #include <ModelAPI_ResultParameter.h>
  13 #include <ModelAPI_AttributeDouble.h>
  14 #include <ModelAPI_AttributeRefList.h>
  15 #include <ModelAPI_Tools.h>
  16 #include <ModelAPI_Session.h>
  17 #include <ModelAPI_Validator.h>
  18 #include <ModelAPI_Events.h>
  19
  20 #include <string>
  21 #include <sstream>
  22
  23 ParametersPlugin_Parameter::ParametersPlugin_Parameter()
  24 {
  25 }
  26
  27 ParametersPlugin_Parameter::~ParametersPlugin_Parameter()
  28 {
  29 }
  30
  31 void ParametersPlugin_Parameter::initAttributes()
  32 {
  33   data()->addAttribute(VARIABLE_ID(), ModelAPI_AttributeString::typeId());
  34   data()->addAttribute(EXPRESSION_ID(), ModelAPI_AttributeString::typeId());
  35
  36   data()->addAttribute(COMMENT_ID(), ModelAPI_AttributeString::typeId());
  37   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), COMMENT_ID());
  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   FeaturePtr aMyPtr = std::dynamic_pointer_cast<ModelAPI_Feature>(data()->owner());
  99   std::shared_ptr<ModelAPI_ParameterEvalMessage> aProcessMessage =
 100     ModelAPI_ParameterEvalMessage::send(aMyPtr, this);
 101
 102   double aResult = 0;
 103   if (aProcessMessage->isProcessed()) {
 104     const std::list<ResultParameterPtr>& aParamsList = aProcessMessage->params();
 105     aResult = aProcessMessage->result();
 106     theError = aProcessMessage->error();
 107     // compare the list of parameters to store if changed
 108     AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
 109     bool aDifferent = aParams->size() != aParamsList.size();
 110     if (!aDifferent) {
 111       std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
 112       std::list<ObjectPtr> anOldList = aParams->list();
 113       std::list<ObjectPtr>::const_iterator anOldIter = anOldList.begin();
 114       for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
 115         if (*aNewIter != *anOldIter)
 116           aDifferent = true;
 117       }
 118     }
 119     if (aDifferent) {
 120       aParams->clear();
 121       std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
 122       for(; aNewIter != aParamsList.end(); aNewIter++) {
 123         aParams->append(*aNewIter);
 124       }
 125     }
 126   } else { // error: python interpreter is not active
 127     theError = "Python interpreter is not available";
 128   }
 129   return aResult;
 130 }
 131
 132 bool ParametersPlugin_Parameter::isPreviewNeeded() const
 133 {
 134   return true;
 135 }