1 // Copyright (C) 2014-2020 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 #include "ParametersPlugin_Parameter.h"
24 #include <Locale_Convert.h>
26 #include <ModelAPI_AttributeString.h>
27 #include <ModelAPI_ResultParameter.h>
28 #include <ModelAPI_AttributeDouble.h>
29 #include <ModelAPI_AttributeRefList.h>
30 #include <ModelAPI_Tools.h>
31 #include <ModelAPI_Session.h>
32 #include <ModelAPI_Validator.h>
33 #include <ModelAPI_Events.h>
38 ParametersPlugin_Parameter::ParametersPlugin_Parameter()
42 ParametersPlugin_Parameter::~ParametersPlugin_Parameter()
46 void ParametersPlugin_Parameter::initAttributes()
48 data()->addAttribute(VARIABLE_ID(), ModelAPI_AttributeString::typeId());
49 data()->addAttribute(EXPRESSION_ID(), ModelAPI_AttributeString::typeId());
51 data()->addAttribute(COMMENT_ID(), ModelAPI_AttributeString::typeId());
52 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), COMMENT_ID());
54 data()->addAttribute(EXPRESSION_ERROR_ID(), ModelAPI_AttributeString::typeId());
55 data()->string(EXPRESSION_ERROR_ID())->setIsArgument(false);
56 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), EXPRESSION_ERROR_ID());
58 data()->addAttribute(ARGUMENTS_ID(), ModelAPI_AttributeRefList::typeId());
59 data()->reflist(ARGUMENTS_ID())->setIsArgument(false);
60 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), ARGUMENTS_ID());
63 bool ParametersPlugin_Parameter::isInHistory()
68 void ParametersPlugin_Parameter::attributeChanged(const std::string& theID)
70 if (theID == EXPRESSION_ID())
73 data()->execState(ModelAPI_StateMustBeUpdated);
76 void ParametersPlugin_Parameter::updateName()
78 std::wstring aName = string(VARIABLE_ID())->isUValue() ?
79 Locale::Convert::toWString(string(VARIABLE_ID())->valueU()) :
80 Locale::Convert::toWString(string(VARIABLE_ID())->value());
81 data()->setName(aName);
83 ResultParameterPtr aParam = document()->createParameter(data());
84 std::wstring anOldName = aParam->data()->name();
85 aParam->data()->setName(aName);
89 // #2474 : if parameter name now hides/shows the higher level parameter name,
90 // update the depended expressions
91 DocumentPtr aRootDoc = ModelAPI_Session::get()->moduleDocument();
92 if (aParam->document() != aRootDoc) {
93 std::list<std::wstring> aNames; // collect names in the root document that must be checked
94 aNames.push_back(aName);
95 if (anOldName != aName) {
96 aNames.push_back(anOldName);
98 std::list<std::wstring>::iterator aNIter = aNames.begin();
99 for (; aNIter != aNames.end(); aNIter++) {
101 ResultParameterPtr aRootParam;
103 std::dynamic_pointer_cast<ModelAPI_Feature>(string(VARIABLE_ID())->owner());
104 if (ModelAPI_Tools::findVariable(aThis, *aNIter, aValue, aRootParam, aRootDoc)) {
105 std::set<std::shared_ptr<ModelAPI_Attribute> > anAttributes =
106 aRootParam->data()->refsToMe();
107 std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator anAttributeIt =
108 anAttributes.cbegin();
109 for (; anAttributeIt != anAttributes.cend(); ++anAttributeIt) {
110 const AttributePtr& anAttribute = *anAttributeIt;
111 ModelAPI_AttributeEvalMessage::send(anAttribute, NULL);
118 bool ParametersPlugin_Parameter::updateExpression()
120 std::wstring anExpression = string(EXPRESSION_ID())->isUValue() ?
121 Locale::Convert::toWString(string(EXPRESSION_ID())->valueU()) :
122 Locale::Convert::toWString(string(EXPRESSION_ID())->value());
124 std::string outErrorMessage;
125 double aValue = evaluate(anExpression, outErrorMessage);
127 data()->string(EXPRESSION_ERROR_ID())->setValue(outErrorMessage);
128 if (!outErrorMessage.empty())
131 ResultParameterPtr aParam = document()->createParameter(data());
132 AttributeDoublePtr aValueAttribute = aParam->data()->real(ModelAPI_ResultParameter::VALUE());
133 aValueAttribute->setValue(aValue);
139 void ParametersPlugin_Parameter::execute()
142 if (!updateExpression())
143 setError("Expression error.", false);
146 double ParametersPlugin_Parameter::evaluate(const std::wstring& /*theExpression*/,
147 std::string& theError)
149 FeaturePtr aMyPtr = std::dynamic_pointer_cast<ModelAPI_Feature>(data()->owner());
150 std::shared_ptr<ModelAPI_ParameterEvalMessage> aProcessMessage =
151 ModelAPI_ParameterEvalMessage::send(aMyPtr, this);
154 if (aProcessMessage->isProcessed()) {
155 const std::list<ResultParameterPtr>& aParamsList = aProcessMessage->params();
156 aResult = aProcessMessage->result();
157 theError = aProcessMessage->error();
158 // compare the list of parameters to store if changed
159 AttributeRefListPtr aParams = reflist(ARGUMENTS_ID());
160 bool aDifferent = aParams->size() != (int)aParamsList.size();
162 std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
163 std::list<ObjectPtr> anOldList = aParams->list();
164 std::list<ObjectPtr>::const_iterator anOldIter = anOldList.begin();
165 for(; !aDifferent && aNewIter != aParamsList.end(); aNewIter++, anOldIter++) {
166 if (*aNewIter != *anOldIter)
172 std::list<ResultParameterPtr>::const_iterator aNewIter = aParamsList.begin();
173 for(; aNewIter != aParamsList.end(); aNewIter++) {
174 aParams->append(*aNewIter);
177 } else { // error: python interpreter is not active
178 theError = "Python interpreter is not available";
183 bool ParametersPlugin_Parameter::isPreviewNeeded() const