X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FParametersAPI%2FParametersAPI_Parameter.h;h=6d444d9f6c4c054a133a17205c2248b494d914ab;hb=384c819a1edf4b726e3a523c1ffd2b5e6b16a4c0;hp=52626709991851da67991ae802f52753e06707fd;hpb=483750cc09178e5fa392706e5d73820b1fe5ecfb;p=modules%2Fshaper.git diff --git a/src/ParametersAPI/ParametersAPI_Parameter.h b/src/ParametersAPI/ParametersAPI_Parameter.h index 526267099..6d444d9f6 100644 --- a/src/ParametersAPI/ParametersAPI_Parameter.h +++ b/src/ParametersAPI/ParametersAPI_Parameter.h @@ -1,8 +1,22 @@ -// Name : ParametersAPI_Parameter.h -// Purpose: +// Copyright (C) 2014-2017 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or +// email : webmaster.salome@opencascade.com // -// History: -// 16/06/16 - Sergey POKHODENKO - Creation of the file #ifndef SRC_PARAMETERSAPI_PARAMETERSAPI_PARAMETER_H_ #define SRC_PARAMETERSAPI_PARAMETERSAPI_PARAMETER_H_ @@ -38,11 +52,19 @@ public: virtual ~ParametersAPI_Parameter(); INTERFACE_3(ParametersPlugin_Parameter::ID(), - name, ParametersPlugin_Parameter::VARIABLE_ID(), ModelAPI_AttributeString, /** Name */, - expression, ParametersPlugin_Parameter::EXPRESSION_ID(), ModelAPI_AttributeString, /** Expression */, - comment, ParametersPlugin_Parameter::COMMENT_ID(), ModelAPI_AttributeString, /** Comment */ + name, ParametersPlugin_Parameter::VARIABLE_ID(), + ModelAPI_AttributeString, /** Name */, + expression, ParametersPlugin_Parameter::EXPRESSION_ID(), + ModelAPI_AttributeString, /** Expression */, + comment, ParametersPlugin_Parameter::COMMENT_ID(), + ModelAPI_AttributeString, /** Comment */ ) + /// Just sets the numeric value to the parameter (it resets the previous expression) + PARAMETERSAPI_EXPORT void setValue(const double theValue); + /// Returns the current value of the parameter: the expression result. + PARAMETERSAPI_EXPORT double value(); + /// Dump wrapped feature PARAMETERSAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const; @@ -61,6 +83,13 @@ ParameterPtr addParameter(const std::shared_ptr & thePart, const std::string & theExpression, const std::string & theComment = std::string()); +/**\ingroup CPPHighAPI + * \brief Remove Parameter feature and substitute it by the value in referred features + */ +PARAMETERSAPI_EXPORT +void removeParameter(const std::shared_ptr & thePart, + const ParameterPtr & theParameter); + //-------------------------------------------------------------------------------------- //-------------------------------------------------------------------------------------- #endif /* SRC_PARAMETERSAPI_PARAMETERSAPI_PARAMETER_H_ */