Salome HOME
Issue #761 - Check and error for unique parameter name
[modules/shaper.git] / 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(ARGUMENTS_ID(), ModelAPI_AttributeRefList::typeId());
38   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), ARGUMENTS_ID());
39 }
40
41 bool ParametersPlugin_Parameter::isInHistory()
42 {
43   return false;
44 }
45
46 void ParametersPlugin_Parameter::attributeChanged(const std::string& theID)
47 {
48   if (theID == EXPRESSION_ID())
49     updateExpression();
50 }
51
52 void ParametersPlugin_Parameter::updateName()
53 {
54   std::string aName = string(VARIABLE_ID())->value();
55   data()->setName(aName);
56
57   ResultParameterPtr aParam = document()->createParameter(data());
58   aParam->data()->setName(aName);
59   setResult(aParam);
60 }
61
62 void ParametersPlugin_Parameter::updateExpression()
63 {
64   std::string anExpression = string(EXPRESSION_ID())->value();
65   if(anExpression.empty()) {
66     // clear error/result if the expression is empty
67     setError("", false);
68     return;
69   }
70   std::string outErrorMessage;
71   double aValue = evaluate(anExpression, outErrorMessage);
72   std::ostringstream sstream;
73   sstream << aValue;
74   std::string aParamValue = sstream.str();
75   // Error
76   if (!outErrorMessage.empty()) {
77     std::string aStateMsg("Error: " + outErrorMessage);
78     data()->execState(ModelAPI_StateExecFailed);
79     setError(aStateMsg, false);
80   } else {
81     static const std::string anEmptyMsg(""); // it is checked in the validator by the empty message
82     setError(anEmptyMsg, false);
83     data()->execState(ModelAPI_StateDone);
84   }
85
86   ResultParameterPtr aParam = document()->createParameter(data());
87   AttributeDoublePtr aValueAttribute = aParam->data()->real(ModelAPI_ResultParameter::VALUE());
88   aValueAttribute->setValue(aValue);
89   setResult(aParam);
90 }
91
92 void ParametersPlugin_Parameter::execute()
93 {
94   updateName();
95   updateExpression();
96 }
97
98 double ParametersPlugin_Parameter::evaluate(const std::string& theExpression, std::string& theError)
99 {
100   std::list<std::string> anExprParams = myInterp->compile(theExpression);
101   // find expression's params in the model
102   std::list<std::string> aContext;
103   std::list<std::string>::iterator it = anExprParams.begin();
104   std::list<ResultParameterPtr> aParamsList;
105   for ( ; it != anExprParams.end(); it++) {
106     double aValue;
107     ResultParameterPtr aParamRes;
108     if (!ModelAPI_Tools::findVariable(*it, aValue, aParamRes)) continue;
109     aParamsList.push_back(aParamRes);
110
111     std::ostringstream sstream;
112     sstream << aValue;
113     std::string aParamValue = sstream.str();
114     aContext.push_back(*it + "=" + aParamValue);
115   }
116   // compare the list of parameters to store if changed
117   AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
118   bool aDifferent = aParams->size() != aParamsList.size();
119   if (!aDifferent) {
120     std::list<ResultParameterPtr>::iterator aNewIter = aParamsList.begin();
121     std::list<ObjectPtr> anOldList = aParams->list();
122     std::list<ObjectPtr>::iterator anOldIter = anOldList.begin();
123     for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
124       if (*aNewIter != *anOldIter)
125         aDifferent = true;
126     }
127   }
128   if (aDifferent) {
129     aParams->clear();
130     std::list<ResultParameterPtr>::iterator aNewIter = aParamsList.begin();
131     for(; aNewIter != aParamsList.end(); aNewIter++) {
132       aParams->append(*aNewIter);
133     }
134   }
135
136   myInterp->extendLocalContext(aContext);
137   double result = myInterp->evaluate(theExpression, theError);
138   myInterp->clearLocalContext();
139   return result;
140 }
141
142 bool ParametersPlugin_Parameter::isPreviewNeeded() const
143 {
144   return false;
145 }