ModelHighAPI_Folder.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 SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
#define SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
 
//--------------------------------------------------------------------------------------
#include <ModelHighAPI_Interface.h>
 
#include <ModelAPI_Folder.h>
 
#include <memory>
//--------------------------------------------------------------------------------------
class ModelAPI_AttributeReference;
class ModelAPI_Document;
class ModelHighAPI_Reference;
//--------------------------------------------------------------------------------------
class ModelHighAPI_Folder : public ModelHighAPI_Interface
{
public:
  MODELHIGHAPI_EXPORT
  explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder>& theFolder);
  MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
 
  static std::string ID() { return ModelAPI_Folder::ID(); }
  virtual std::string getID() { return ID(); }
  const std::shared_ptr<ModelAPI_Folder>& folder() const {return myFolder;}
 
  std::shared_ptr<ModelAPI_AttributeReference> firstFeature() const
  { return myFirstFeature; }
 
  std::shared_ptr<ModelAPI_AttributeReference> lastFeature() const
  { return myLastFeature; }
 
  MODELHIGHAPI_EXPORT
  void setName(const std::wstring& theName);
 
  MODELHIGHAPI_EXPORT
  std::wstring name() const;
 
  //MODELHIGHAPI_EXPORT void execute();
 
 
  MODELHIGHAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 
protected:
  bool initialize();
 
private:
  std::shared_ptr<ModelAPI_Folder> myFolder;
 
  std::shared_ptr<ModelAPI_AttributeReference> myFirstFeature;
  std::shared_ptr<ModelAPI_AttributeReference> myLastFeature;
};
 
//--------------------------------------------------------------------------------------
MODELHIGHAPI_EXPORT
std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
 
MODELHIGHAPI_EXPORT
std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc,
                                               const ModelHighAPI_Reference& theFirstFeature,
                                               const ModelHighAPI_Reference& theLastFeature);
MODELHIGHAPI_EXPORT
void removeFolder(std::shared_ptr<ModelHighAPI_Folder>& theFolder);
//--------------------------------------------------------------------------------------
#endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */