include/opencascade/DEIGES_ConfigurationNode.hxx

0001 // Copyright (c) 2022 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _DEIGES_ConfigurationNode_HeaderFile
0015 #define _DEIGES_ConfigurationNode_HeaderFile
0016
0017 #include <DEIGES_Parameters.hxx>
0018 #include <DE_ShapeFixConfigurationNode.hxx>
0019 #include <UnitsMethods_LengthUnit.hxx>
0020
0021 //! The purpose of this class is to configure the transfer process for IGES format
0022 //! Stores the necessary settings for DEIGES_Provider.
0023 //! Configures and creates special provider to transfer IGES files.
0024 //!
0025 //! Nodes grouped by Vendor name and Format type.
0026 //! The Vendor name is "OCC"
0027 //! The Format type is "IGES"
0028 //! The supported CAD extensions are ".igs", ".iges"
0029 //! The import process is supported.
0030 //! The export process is supported.
0031 class DEIGES_ConfigurationNode : public DE_ShapeFixConfigurationNode
0032 {
0033   DEFINE_STANDARD_RTTIEXT(DEIGES_ConfigurationNode, DE_ShapeFixConfigurationNode)
0034 public:
0035   //! Initializes all fields by default
0036   Standard_EXPORT DEIGES_ConfigurationNode();
0037
0038   //! Copies values of all fields
0039   //! @param[in] theNode object to copy
0040   Standard_EXPORT DEIGES_ConfigurationNode(const Handle(DEIGES_ConfigurationNode)& theNode);
0041
0042   //! Updates values according the resource
0043   //! @param[in] theResource input resource to use
0044   //! @return true if theResource loading has ended correctly
0045   Standard_EXPORT virtual bool Load(const Handle(DE_ConfigurationContext)& theResource)
0046     Standard_OVERRIDE;
0047
0048   //! Writes configuration to the string
0049   //! @return result resource string
0050   Standard_EXPORT virtual TCollection_AsciiString Save() const Standard_OVERRIDE;
0051
0052   //! Copies values of all fields
0053   //! @return new object with the same field values
0054   Standard_EXPORT virtual Handle(DE_ConfigurationNode) Copy() const Standard_OVERRIDE;
0055
0056   //! Creates new provider for the own format
0057   //! @return new created provider
0058   Standard_EXPORT virtual Handle(DE_Provider) BuildProvider() Standard_OVERRIDE;
0059
0060 public:
0061   //! Checks the import supporting
0062   //! @return true if import is supported
0063   Standard_EXPORT virtual bool IsImportSupported() const Standard_OVERRIDE;
0064
0065   //! Checks the export supporting
0066   //! @return true if export is supported
0067   Standard_EXPORT virtual bool IsExportSupported() const Standard_OVERRIDE;
0068
0069   //! Gets CAD format name of associated provider
0070   //! @return provider CAD format
0071   Standard_EXPORT virtual TCollection_AsciiString GetFormat() const Standard_OVERRIDE;
0072
0073   //! Gets provider's vendor name of associated provider
0074   //! @return provider's vendor name
0075   Standard_EXPORT virtual TCollection_AsciiString GetVendor() const Standard_OVERRIDE;
0076
0077   //! Gets list of supported file extensions
0078   //! @return list of extensions
0079   Standard_EXPORT virtual TColStd_ListOfAsciiString GetExtensions() const Standard_OVERRIDE;
0080
0081   //! Checks the file content to verify a format
0082   //! @param[in] theBuffer read stream buffer to check content
0083   //! @return Standard_True if file is supported by a current provider
0084   Standard_EXPORT virtual bool CheckContent(const Handle(NCollection_Buffer)& theBuffer) const
0085     Standard_OVERRIDE;
0086
0087 public:
0088   DEIGES_Parameters InternalParameters;
0089 };
0090
0091 #endif // _DEIGES_ConfigurationNode_HeaderFile