ModelAPI_ResultField.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef ModelAPI_ResultField_H_
#define ModelAPI_ResultField_H_
 
#include "ModelAPI_Result.h"
#include <GeomAPI_Shape.h>
#include <memory>
#include <string>
 
class ModelAPI_ResultField : public ModelAPI_Result
{
public:
 
  class ModelAPI_FieldStep : public ModelAPI_Object
  {
  public:
    virtual ModelAPI_ResultField* field() const = 0;
 
    virtual int id() const = 0;
 
    inline static std::string group()
    {
      static std::string MY_GROUP = "FieldRersultStep";
      return MY_GROUP;
    }
 
    virtual std::string groupName() { return group(); }
 
    virtual void initAttributes() {}
 
    virtual bool isDisabled() { return false; }
 
    virtual bool isDisplayed() { return myIsDisplayed; }
 
    MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
 
    MODELAPI_EXPORT virtual std::wstring name() = 0;
 
  protected:
    MODELAPI_EXPORT virtual void init() {}
 
  private:
    bool myIsDisplayed;
  };
 
  MODELAPI_EXPORT virtual ~ModelAPI_ResultField();
  MODELAPI_EXPORT virtual std::string groupName();
 
  inline static std::string group()
  {
    static std::string MY_GROUP = "Fields";
    return MY_GROUP;
  }
 
  inline static const std::string& DEFAULT_COLOR()
  {
    static const std::string RESULT_GROUP_COLOR("150,150,180");
    return RESULT_GROUP_COLOR;
  }
 
  virtual int stepsSize() const = 0;
 
  virtual std::string textLine(int theLine) const = 0;
 
  virtual std::shared_ptr<ModelAPI_ResultField::ModelAPI_FieldStep> step(int theId) const = 0;
 
  MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
 
  MODELAPI_EXPORT virtual void updateSteps() = 0;
};
 
typedef std::shared_ptr<ModelAPI_ResultField> ResultFieldPtr;
typedef std::shared_ptr<ModelAPI_ResultField::ModelAPI_FieldStep> FieldStepPtr;
 
#endif