src/Selector/Selector_NameGenerator.h

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