include/opencascade/STEPCAFControl_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 _STEPCAFControl_ConfigurationNode_HeaderFile
0015 #define _STEPCAFControl_ConfigurationNode_HeaderFile
0016
0017 #include <DE_ConfigurationNode.hxx>
0018 #include <STEPControl_StepModelType.hxx>
0019 #include <StepData_ConfParameters.hxx>
0020 #include <Resource_FormatType.hxx>
0021 #include <UnitsMethods_LengthUnit.hxx>
0022
0023 //! The purpose of this class is to configure the transfer process for STEP format
0024 //! Stores the necessary settings for STEPCAFControl_Provider.
0025 //! Configures and creates special provider to transfer STEP files.
0026 //!
0027 //! Nodes grouped by Vendor name and Format type.
0028 //! The Vendor name is "OCC"
0029 //! The Format type is "STEP"
0030 //! The supported CAD extensions are ".stp", ".step", ".stpz"
0031 //! The import process is supported.
0032 //! The export process is supported.
0033 class STEPCAFControl_ConfigurationNode : public DE_ConfigurationNode
0034 {
0035   DEFINE_STANDARD_RTTIEXT(STEPCAFControl_ConfigurationNode, DE_ConfigurationNode)
0036 public:
0037
0038   //! Initializes all field by default
0039   Standard_EXPORT STEPCAFControl_ConfigurationNode();
0040
0041   //! Copies values of all fields
0042   //! @param[in] theNode object to copy
0043   Standard_EXPORT STEPCAFControl_ConfigurationNode(const Handle(STEPCAFControl_ConfigurationNode)& theNode);
0044
0045   //! Updates values according the resource
0046   //! @param[in] theResource input resource to use
0047   //! @return true if theResource loading has ended correctly
0048   Standard_EXPORT virtual bool Load(const Handle(DE_ConfigurationContext)& theResource) Standard_OVERRIDE;
0049
0050   //! Writes configuration to the string
0051   //! @return result resource string
0052   Standard_EXPORT virtual TCollection_AsciiString Save() const Standard_OVERRIDE;
0053
0054   //! Copies values of all fields
0055   //! @return new object with the same field values
0056   Standard_EXPORT virtual Handle(DE_ConfigurationNode) Copy() const Standard_OVERRIDE;
0057
0058
0059   //! Creates new provider for the own format
0060   //! @return new created provider
0061   Standard_EXPORT virtual Handle(DE_Provider) BuildProvider() Standard_OVERRIDE;
0062
0063 public:
0064
0065   //! Checks the import supporting
0066   //! @return true if import is supported
0067   Standard_EXPORT virtual bool IsImportSupported() const Standard_OVERRIDE;
0068
0069   //! Checks the export supporting
0070   //! @return true if export is supported
0071   Standard_EXPORT virtual bool IsExportSupported() const Standard_OVERRIDE;
0072
0073   //! Gets CAD format name of associated provider
0074   //! @return provider CAD format
0075   Standard_EXPORT virtual TCollection_AsciiString GetFormat() const Standard_OVERRIDE;
0076
0077   //! Gets provider's vendor name of associated provider
0078   //! @return provider's vendor name
0079   Standard_EXPORT virtual TCollection_AsciiString GetVendor() const Standard_OVERRIDE;
0080
0081   //! Gets list of supported file extensions
0082   //! @return list of extensions
0083   Standard_EXPORT virtual TColStd_ListOfAsciiString GetExtensions() const Standard_OVERRIDE;
0084
0085   //! Checks the file content to verify a format
0086   //! @param[in] theBuffer read stream buffer to check content
0087   //! @return Standard_True if file is supported by a current provider
0088   Standard_EXPORT virtual bool CheckContent(const Handle(NCollection_Buffer)& theBuffer) const Standard_OVERRIDE;
0089
0090 public:
0091
0092   StepData_ConfParameters InternalParameters;
0093 };
0094
0095 #endif // _STEPCAFControl_ConfigurationNode_HeaderFile