src/Selector/Selector_NameGenerator.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 Selector_NameGenerator_H_
  21 #define Selector_NameGenerator_H_
  22
  23 #include "Selector.h"
  24
  25 #include <TDF_Label.hxx>
  26
  27 /**\class Selector_NameGenerator
  28  * \ingroup DataModel
  29  * \brief An interface for generation of the naming name basing on the current selection and
  30  * document information. This requires higher-level data access, so, the caller of "name" method
  31  * of Selector must implement this helper-class abstract methods.
  32  */
  33 class Selector_NameGenerator
  34 {
  35 public:
  36   /// empty constructor, nothing to add
  37   Selector_NameGenerator() {};
  38
  39   /// This method returns the context name by the label of the sub-selected shape
  40   virtual std::wstring contextName(const TDF_Label theSelectionLab) = 0;
  41
  42   /// This method restores by the context and value name the context label and
  43   /// sub-label where the value is. Returns true if it is valid.
  44   virtual bool restoreContext(std::wstring theName,
  45     TDF_Label& theContext, TDF_Label& theValue) = 0;
  46
  47   /// Returns true if the first result is older than the second one in the tree of features
  48   virtual bool isLater(const TDF_Label theResult1, const TDF_Label theResult2) const = 0;
  49 };
  50
  51 #endif