ParametersPlugin_Parameter.h

// Copyright (C) 2014-2025  CEA, EDF
//
// 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
//
 
#ifndef PARAMETERSPLUGIN_PARAMETER_H_
#define PARAMETERSPLUGIN_PARAMETER_H_
 
#include "ParametersPlugin.h"
#include <ModelAPI_Feature.h>
 
#include <memory>
 
class ParametersPlugin_Parameter : public ModelAPI_Feature
{
 public:
  virtual ~ParametersPlugin_Parameter();
 
  inline static const std::string& ID()
  {
    static const std::string MY_PARAMETER_ID("Parameter");
    return MY_PARAMETER_ID;
  }
  inline static const std::string& VARIABLE_ID()
  {
    static const std::string MY_VARIABLE_ID("variable");
    return MY_VARIABLE_ID;
  }
  inline static const std::string& EXPRESSION_ID()
  {
    static const std::string MY_EXPRESSION_ID("expression");
    return MY_EXPRESSION_ID;
  }
  inline static const std::string& EXPRESSION_ERROR_ID()
  {
    static const std::string MY_EXPRESSION_ERROR_ID("ExpressionError");
    return MY_EXPRESSION_ERROR_ID;
  }
  inline static const std::string& ARGUMENTS_ID()
  {
    static const std::string MY_ARGUMENTS_ID("arguments");
    return MY_ARGUMENTS_ID;
  }
 
  inline static const std::string& COMMENT_ID()
  {
    static const std::string MY_COMMENT_ID("comment");
    return MY_COMMENT_ID;
  }
 
  PARAMETERSPLUGIN_EXPORT virtual const std::string& getKind()
  {
    static std::string MY_KIND = ParametersPlugin_Parameter::ID();
    return MY_KIND;
  }
 
  PARAMETERSPLUGIN_EXPORT virtual bool isPreviewNeeded() const;
 
  PARAMETERSPLUGIN_EXPORT virtual void execute();
 
  PARAMETERSPLUGIN_EXPORT virtual void initAttributes();
 
  PARAMETERSPLUGIN_EXPORT virtual bool isInHistory();
 
  PARAMETERSPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 
  ParametersPlugin_Parameter();
 
 protected:
  double evaluate(const std::wstring& theExpression, std::string& theError);
  void updateName();
  bool updateExpression();
};
 
#endif