X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FExchangeAPI%2FExchangeAPI_Export.h;h=6cfddfd8f65d13500e2b984bb59d85dc39a4dff5;hb=b7f954c1e5b9da1fc425908ac4edfebb513ebf23;hp=02429cc81c86190a765969e317caf4396a57c06a;hpb=c040abb8ae7ecff3c1b7d0dd97a9bf88972df93c;p=modules%2Fshaper.git diff --git a/src/ExchangeAPI/ExchangeAPI_Export.h b/src/ExchangeAPI/ExchangeAPI_Export.h index 02429cc81..6cfddfd8f 100644 --- a/src/ExchangeAPI/ExchangeAPI_Export.h +++ b/src/ExchangeAPI/ExchangeAPI_Export.h @@ -1,8 +1,21 @@ -// Name : ExchangeAPI_Export.h -// Purpose: +// Copyright (C) 2014-2019 CEA/DEN, EDF R&D +// +// 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 // -// History: -// 07/06/16 - Sergey POKHODENKO - Creation of the file #ifndef SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_ #define SRC_EXCHANGEAPI_EXCHANGEAPI_EXPORT_H_ @@ -20,57 +33,95 @@ //-------------------------------------------------------------------------------------- class ModelHighAPI_Selection; //-------------------------------------------------------------------------------------- -/**\class ExchangeAPI_Export - * \ingroup CPPHighAPI - * \brief Interface for Export feature - */ -class ExchangeAPI_Export : public ModelHighAPI_Interface + + +/// \class ExchangeAPI_Export +/// \ingroup CPPHighAPI +/// \brief Interface for Export feature. +class ExchangeAPI_Export: public ModelHighAPI_Interface { public: - /// Constructor without values - EXCHANGEAPI_EXPORT - explicit ExchangeAPI_Export(const std::shared_ptr & theFeature); - /// Constructor with values + /// Constructor without values. EXCHANGEAPI_EXPORT - ExchangeAPI_Export(const std::shared_ptr & theFeature, - const std::string & theFilePath, - const std::string & theFileFormat, - const std::list & theSelectionList); - /// Destructor + explicit ExchangeAPI_Export(const std::shared_ptr& theFeature); + + /// Constructor with values for XAO export. EXCHANGEAPI_EXPORT - virtual ~ExchangeAPI_Export(); + explicit ExchangeAPI_Export(const std::shared_ptr& theFeature, + const std::string & theFilePath, + const std::string & theAuthor = std::string(), + const std::string & theGeometryName = std::string()); - INTERFACE_3(ExchangePlugin_ExportFeature::ID(), - filePath, ExchangePlugin_ExportFeature::FILE_PATH_ID(), String, /** File path */, - fileFormat, ExchangePlugin_ExportFeature::FILE_FORMAT_ID(), String, /** File format */, - selectionList, ExchangePlugin_ExportFeature::SELECTION_LIST_ID(), SelectionList, /** Selection list */ - ) + /// Constructor with values for XAO of selected result export. + EXCHANGEAPI_EXPORT + explicit ExchangeAPI_Export(const std::shared_ptr& theFeature, + const std::string & theFilePath, + const ModelHighAPI_Selection& theResult, + const std::string & theAuthor, + const std::string & theGeometryName = std::string()); - /// Set file path (without execute) + /// Constructor with values for export in other formats than XAO. EXCHANGEAPI_EXPORT - void setFilePath(const std::string & theFilePath); + explicit ExchangeAPI_Export(const std::shared_ptr& theFeature, + const std::string & theFilePath, + const std::list & theSelectionList, + const std::string & theFileFormat = std::string()); - /// Set file format (without execute) + /// Destructor. EXCHANGEAPI_EXPORT - void setFileFormat(const std::string & theFileFormat); + virtual ~ExchangeAPI_Export(); + INTERFACE_7(ExchangePlugin_ExportFeature::ID(), + exportType, ExchangePlugin_ExportFeature::EXPORT_TYPE_ID(), + ModelAPI_AttributeString, /** ExportType */, + filePath, ExchangePlugin_ExportFeature::FILE_PATH_ID(), + ModelAPI_AttributeString, /** file path */, + xaoFilePath, ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID(), + ModelAPI_AttributeString, /** xao_file_path */, + fileFormat, ExchangePlugin_ExportFeature::FILE_FORMAT_ID(), + ModelAPI_AttributeString, /** file format */, + selectionList, ExchangePlugin_ExportFeature::SELECTION_LIST_ID(), + ModelAPI_AttributeString, /** selection list */, + xaoAuthor, ExchangePlugin_ExportFeature::XAO_AUTHOR_ID(), + ModelAPI_AttributeString, /** xao author */, + xaoGeometryName, ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID(), + ModelAPI_AttributeString, /** xao geometry name */) - /// Set selection list (without execute) + /// Dump wrapped feature EXCHANGEAPI_EXPORT - void setSelectionList(const std::list & theSelectionList); + virtual void dump(ModelHighAPI_Dumper& theDumper) const; }; -//! Pointer on Export object +/// Pointer on Export object typedef std::shared_ptr ExportPtr; /**\ingroup CPPHighAPI - * \brief Create Export feature + * \brief Export to file */ EXCHANGEAPI_EXPORT ExportPtr exportToFile(const std::shared_ptr & thePart, - const std::string & theFilePath, - const std::string & theFileFormat, - const std::list & theSelectionList); + const std::string & theFilePath, + const std::list & theSelectionList, + const std::string & theFileFormat = std::string()); + +/**\ingroup CPPHighAPI + * \brief Exports to XAO file all results of the current document + */ +EXCHANGEAPI_EXPORT +ExportPtr exportToXAO(const std::shared_ptr & thePart, + const std::string & theFilePath, + const std::string & theAuthor = std::string(), + const std::string & theGeometryName = std::string()); + +/**\ingroup CPPHighAPI +* \brief Exports to XAO file the selected result with groups parts related to it only. +*/ +EXCHANGEAPI_EXPORT +ExportPtr exportToXAO(const std::shared_ptr & thePart, + const std::string & theFilePath, + const ModelHighAPI_Selection& theSelectedShape, + const std::string & theAuthor = std::string(), + const std::string & theGeometryName = std::string()); //-------------------------------------------------------------------------------------- //--------------------------------------------------------------------------------------