ParametersAPI_Parameter.h

// Copyright (C) 2014-2023  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 SRC_PARAMETERSAPI_PARAMETERSAPI_PARAMETER_H_
#define SRC_PARAMETERSAPI_PARAMETERSAPI_PARAMETER_H_
 
//--------------------------------------------------------------------------------------
#include "ParametersAPI.h"
 
#include <ParametersPlugin_Parameter.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
//--------------------------------------------------------------------------------------
class ModelHighAPI_Double;
//--------------------------------------------------------------------------------------
class ParametersAPI_Parameter : public ModelHighAPI_Interface
{
public:
  PARAMETERSAPI_EXPORT
  explicit ParametersAPI_Parameter(const std::shared_ptr<ModelAPI_Feature> & theFeature);
  PARAMETERSAPI_EXPORT
  explicit ParametersAPI_Parameter(const  std::shared_ptr<ModelAPI_Feature> & theFeature,
                                   const std::string & theName,
                                   const std::string & theExpression,
                                   const std::wstring & theComment = std::wstring());
  PARAMETERSAPI_EXPORT
  virtual ~ParametersAPI_Parameter();
 
  INTERFACE_3(ParametersPlugin_Parameter::ID(),
              name, ParametersPlugin_Parameter::VARIABLE_ID(),
              ModelAPI_AttributeString, ,
              expression, ParametersPlugin_Parameter::EXPRESSION_ID(),
              ModelAPI_AttributeString, ,
              comment, ParametersPlugin_Parameter::COMMENT_ID(),
              ModelAPI_AttributeString, 
  )
 
  
  PARAMETERSAPI_EXPORT void setValue(const double theValue);
  PARAMETERSAPI_EXPORT double value();
 
  PARAMETERSAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 
};
 
typedef std::shared_ptr<ParametersAPI_Parameter> ParameterPtr;
 
PARAMETERSAPI_EXPORT
ParameterPtr addParameter(const std::shared_ptr<ModelAPI_Document> & thePart,
                          const std::string & theName,
                          const std::string & theExpression,
                          const std::wstring & theComment = std::wstring());
 
PARAMETERSAPI_EXPORT
void removeParameter(const std::shared_ptr<ModelAPI_Document> & thePart,
                     const ParameterPtr & theParameter);
 
//--------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------
#endif /* SRC_PARAMETERSAPI_PARAMETERSAPI_PARAMETER_H_ */