FeaturesAPI_Pipe.h

// Copyright (C) 2014-2026  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 FeaturesAPI_Pipe_H_
#define FeaturesAPI_Pipe_H_
 
#include "FeaturesAPI.h"
 
#include <FeaturesPlugin_Pipe.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Dumper;
class ModelHighAPI_Selection;
 
class FeaturesAPI_Pipe: public ModelHighAPI_Interface
{
public:
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
                            const ModelHighAPI_Selection& thePath);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
                            const ModelHighAPI_Selection& thePath,
                            const ModelHighAPI_Selection& theBiNoramal);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
                            const ModelHighAPI_Selection& thePath,
                            const std::list<ModelHighAPI_Selection>& theLocations);
 
  FEATURESAPI_EXPORT
  virtual ~FeaturesAPI_Pipe();
 
  INTERFACE_5(FeaturesPlugin_Pipe::ID(),
              baseObjects, FeaturesPlugin_Pipe::BASE_OBJECTS_ID(),
              ModelAPI_AttributeSelectionList, ,
              path, FeaturesPlugin_Pipe::PATH_OBJECT_ID(),
              ModelAPI_AttributeSelection, ,
              creationMethod, FeaturesPlugin_Pipe::CREATION_METHOD(),
              ModelAPI_AttributeString, ,
              biNormal, FeaturesPlugin_Pipe::BINORMAL_ID(),
              ModelAPI_AttributeSelection, ,
              locations, FeaturesPlugin_Pipe::LOCATIONS_ID(),
              ModelAPI_AttributeSelectionList, )
 
  
  FEATURESAPI_EXPORT
  void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
 
  FEATURESAPI_EXPORT
  void setPath(const ModelHighAPI_Selection& thePath);
 
  FEATURESAPI_EXPORT
  void setByBasePath(const std::list<ModelHighAPI_Selection>& theBaseObjects,
                     const ModelHighAPI_Selection& thePath);
 
  FEATURESAPI_EXPORT
  void setByBasePathBiNormal(const std::list<ModelHighAPI_Selection>& theBaseObjects,
                             const ModelHighAPI_Selection& thePath,
                             const ModelHighAPI_Selection& theBiNoramal);
 
  FEATURESAPI_EXPORT
  void setByBasePathLocations(const std::list<ModelHighAPI_Selection>& theBaseObjects,
                              const ModelHighAPI_Selection& thePath,
                              const std::list<ModelHighAPI_Selection>& theLocations);
 
  FEATURESAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<FeaturesAPI_Pipe> PipePtr;
 
FEATURESAPI_EXPORT
PipePtr addPipe(const std::shared_ptr<ModelAPI_Document>& thePart,
                const std::list<ModelHighAPI_Selection>& theBaseObjects,
                const ModelHighAPI_Selection& thePath);
 
FEATURESAPI_EXPORT
PipePtr addPipe(const std::shared_ptr<ModelAPI_Document>& thePart,
                const std::list<ModelHighAPI_Selection>& theBaseObjects,
                const ModelHighAPI_Selection& thePath,
                const ModelHighAPI_Selection& theBiNoramal);
 
FEATURESAPI_EXPORT
PipePtr addPipe(const std::shared_ptr<ModelAPI_Document>& thePart,
                const std::list<ModelHighAPI_Selection>& theBaseObjects,
                const ModelHighAPI_Selection& thePath,
                const std::list<ModelHighAPI_Selection>& theLocations);
 
#endif // FeaturesAPI_Pipe_H_