src/ModelAPI/ModelAPI_ResultField.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 ModelAPI_ResultField_H_
  22 #define ModelAPI_ResultField_H_
  23
  24 #include "ModelAPI_Result.h"
  25 #include <GeomAPI_Shape.h>
  26 #include <memory>
  27 #include <string>
  28
  29 /**\class ModelAPI_ResultField
  30  * \ingroup DataModel
  31  * \brief The fields result.
  32  *
  33  * Provides a compound of selected elements, without storage, one the fly.
  34  */
  35 class ModelAPI_ResultField : public ModelAPI_Result
  36 {
  37 public:
  38
  39   class ModelAPI_FieldStep : public ModelAPI_Entity
  40   {
  41   public:
  42     virtual ModelAPI_ResultField* field() const = 0;
  43
  44     virtual int id() const = 0;
  45   };
  46
  47   MODELAPI_EXPORT virtual ~ModelAPI_ResultField();
  48   /// Returns the group identifier of this result
  49   MODELAPI_EXPORT virtual std::string groupName();
  50
  51   /// Returns the group identifier of this result
  52   inline static std::string group()
  53   {
  54     static std::string MY_GROUP = "Fields";
  55     return MY_GROUP;
  56   }
  57
  58   /// default color for a result body
  59   inline static const std::string& DEFAULT_COLOR()
  60   {
  61     static const std::string RESULT_GROUP_COLOR("150,150,180");
  62     return RESULT_GROUP_COLOR;
  63   }
  64
  65   /// Returns number of steps
  66   virtual int stepsSize() const = 0;
  67
  68   /// Returns a text line by its number
  69   /// \param theLine a number of line
  70   virtual std::string textLine(int theLine) const = 0;
  71
  72   /// Returns step object
  73   /// \param theId an id of the object
  74   virtual ModelAPI_FieldStep* step(int theId) const = 0;
  75 };
  76
  77 //! Pointer on feature object
  78 typedef std::shared_ptr<ModelAPI_ResultField> ResultFieldPtr;
  79 typedef std::shared_ptr<ModelAPI_ResultField::ModelAPI_FieldStep> FieldStepPtr;
  80
  81 #endif