src/FeaturesPlugin/FeaturesPlugin_ImportResult.h

   1 // Copyright (C) 2017-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 FeaturesPlugin_ImportResult_H_
  21 #define FeaturesPlugin_ImportResult_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <ModelAPI_CompositeFeature.h>
  26 #include <ModelAPI_AttributeValidator.h>
  27
  28 /// \class FeaturesPlugin_ImportResult
  29 /// \ingroup Plugins
  30 /// \brief The Import Result feature allows the user to import one or several results
  31 ///        from another Part.
  32
  33 class FeaturesPlugin_ImportResult : public ModelAPI_CompositeFeature
  34 {
  35 public:
  36   /// Feature kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("ImportResult");
  40     return MY_ID;
  41   }
  42   /// All features (list of references)
  43   inline static const std::string& FEATURES_ID()
  44   {
  45     static const std::string MY_FEATURES_ID("Features");
  46     return MY_FEATURES_ID;
  47   }
  48
  49   /// \return the kind of a feature.
  50   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  51   {
  52     static std::string MY_KIND = FeaturesPlugin_ImportResult::ID();
  53     return MY_KIND;
  54   }
  55
  56   /// Selection list attribute that contains all copied shapes selection.
  57   inline static const std::string& OBJECTS()
  58   {
  59     static const std::string MY_OBJECTS("objects");
  60     return MY_OBJECTS;
  61   }
  62
  63   /// Performs the algorithm and stores results it in the data structure.
  64   FEATURESPLUGIN_EXPORT virtual void execute();
  65
  66   /// Request for initialization of data model of the feature: adding all attributes.
  67   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  68
  69   /// Appends a feature
  70   FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
  71
  72   /// \return the number of sub-elements.
  73   FEATURESPLUGIN_EXPORT virtual int numberOfSubs(bool forTree = false) const;
  74
  75   /// \return the sub-feature by zero-base index.
  76   FEATURESPLUGIN_EXPORT virtual
  77     std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex, bool forTree = false);
  78
  79   /// \return the sub-feature unique identifier in this composite feature by zero-base index.
  80   FEATURESPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
  81
  82   /// \return true if feature or result belong to this composite feature as subs.
  83   FEATURESPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
  84
  85   /// This method to inform that sub-feature is removed and must be removed from the internal data
  86   /// structures of the owner (the remove from the document will be done outside just after).
  87   FEATURESPLUGIN_EXPORT virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
  88
  89   /// Use plugin manager for features creation.
  90   FeaturesPlugin_ImportResult() {}
  91 };
  92
  93 /// \class FeaturesPlugin_ValidatorImportResults
  94 /// \ingroup Validators
  95 /// \brief A validator for selection of objects that may be imported:
  96 ///        from another part, result bodies.
  97 class FeaturesPlugin_ValidatorImportResults : public ModelAPI_AttributeValidator
  98 {
  99 public:
 100   //! \return True if selection is valid.
 101   //! \param[in] theAttribute the checked attribute.
 102   //! \param[in] theArguments arguments of the attribute.
 103   //! \param[out] theError error message.
 104   virtual bool isValid(const AttributePtr& theAttribute,
 105     const std::list<std::string>& theArguments, Events_InfoMessage& theError) const;
 106 };
 107
 108 #endif