src/CollectionPlugin/CollectionPlugin_GroupMerge.h

   1 // Copyright (C) 2014-2020  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 COLLECTIONPLUGIN_GROUPMERGE_H_
  21 #define COLLECTIONPLUGIN_GROUPMERGE_H_
  22
  23 #include "CollectionPlugin.h"
  24 #include "CollectionPlugin_GroupOperation.h"
  25 #include "ModelAPI_ResultGroup.h"
  26
  27 /**\class CollectionPlugin_GroupMerge
  28  * \ingroup Plugins
  29  * \brief Merge several groups of same or different shape type,
  30  * \the validator being used for the shape type.
  31  */
  32 class CollectionPlugin_GroupMerge: public CollectionPlugin_GroupOperation
  33 {
  34 public:
  35   /// attribute name of selected entities list
  36   inline static const std::string& LIST_ID()
  37   {
  38     static const std::string MY_GROUP_LIST_ID("group_list");
  39     return MY_GROUP_LIST_ID;
  40   }
  41
  42
  43   /// Creates a new group result if needed
  44   COLLECTIONPLUGIN_EXPORT void execute(ResultGroupPtr & aGroup);
  45
  46   /// Request for initialization of data model of the feature: adding all attributes
  47   COLLECTIONPLUGIN_EXPORT virtual void initAttributes();
  48
  49   /// Use plugin manager for features creation
  50   CollectionPlugin_GroupMerge() = default;
  51
  52 };
  53
  54 #endif