src/ExchangePlugin/ExchangePlugin_ImportPart.h

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef EXCHANGEPLUGIN_IMPORTPART_H_
  21 #define EXCHANGEPLUGIN_IMPORTPART_H_
  22
  23 #include <ExchangePlugin.h>
  24 #include <ModelAPI_Feature.h>
  25
  26 /**
  27  * \class ExchangePlugin_ImportPart
  28  * \ingroup Plugins
  29  * \brief Feature for import the structure of Part into the current document.
  30  */
  31 class ExchangePlugin_ImportPart : public ModelAPI_Feature
  32 {
  33 public:
  34   /// Feature kind
  35   inline static const std::string& ID()
  36   {
  37     static const std::string MY_IMPORT_ID("ImportPart");
  38     return MY_IMPORT_ID;
  39   }
  40   /// attribute name of file path
  41   inline static const std::string& FILE_PATH_ID()
  42   {
  43     static const std::string MY_FILE_PATH_ID("file_path");
  44     return MY_FILE_PATH_ID;
  45   }
  46   /// attribute name of target part
  47   inline static const std::string& TARGET_PART_ID()
  48   {
  49     static const std::string MY_TARGET_PART_ID("target_part");
  50     return MY_TARGET_PART_ID;
  51   }
  52   /// attribute name of list of target parts
  53   inline static const std::string& TARGET_PARTS_LIST_ID()
  54   {
  55     static const std::string MY_TARGET_PARTS_LIST_ID("target_parts_list");
  56     return MY_TARGET_PARTS_LIST_ID;
  57   }
  58   /// Default constructor
  59   ExchangePlugin_ImportPart();
  60
  61   /// Returns the unique kind of a feature
  62   EXCHANGEPLUGIN_EXPORT virtual const std::string& getKind()
  63   {
  64     return ExchangePlugin_ImportPart::ID();
  65   }
  66
  67   /// Request for initialization of data model of the feature: adding all attributes
  68   EXCHANGEPLUGIN_EXPORT virtual void initAttributes();
  69
  70   /// Called on change of any argument-attribute of this object
  71   /// \param theID identifier of changed attribute
  72   EXCHANGEPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  73
  74   /// Computes or recomputes the results
  75   EXCHANGEPLUGIN_EXPORT virtual void execute();
  76
  77   /// Returns true if this feature is used as macro: creates other features and then removed.
  78   EXCHANGEPLUGIN_EXPORT virtual bool isMacro() const { return true; }
  79
  80   /// Reimplemented from ModelAPI_Feature::isPreviewNeeded(). Returns false.
  81   EXCHANGEPLUGIN_EXPORT virtual bool isPreviewNeeded() const { return false; }
  82 };
  83
  84 #endif /* EXCHANGEPLUGIN_IMPORTPART_H_ */