include/opencascade/IGESBasic_ToolGroup.hxx

0001 // Created on: 1993-10-14
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESBasic_ToolGroup_HeaderFile
0018 #define _IGESBasic_ToolGroup_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Integer.hxx>
0025 class IGESBasic_Group;
0026 class IGESData_IGESReaderData;
0027 class IGESData_ParamReader;
0028 class IGESData_IGESWriter;
0029 class Interface_EntityIterator;
0030 class IGESData_DirChecker;
0031 class Interface_ShareTool;
0032 class Interface_Check;
0033 class Interface_CopyTool;
0034 class IGESData_IGESDumper;
0035
0036 //! Tool to work on a Group. Called by various Modules
0037 //! (ReadWriteModule, GeneralModule, SpecificModule)
0038 class IGESBasic_ToolGroup
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   //! Returns a ToolGroup, ready to work
0044   Standard_EXPORT IGESBasic_ToolGroup();
0045
0046   //! Reads own parameters from file. <PR> gives access to them,
0047   //! <IR> detains parameter types and values
0048   Standard_EXPORT void ReadOwnParams(const occ::handle<IGESBasic_Group>&         ent,
0049                                      const occ::handle<IGESData_IGESReaderData>& IR,
0050                                      IGESData_ParamReader&                       PR) const;
0051
0052   //! Writes own parameters to IGESWriter
0053   Standard_EXPORT void WriteOwnParams(const occ::handle<IGESBasic_Group>& ent,
0054                                       IGESData_IGESWriter&                IW) const;
0055
0056   //! Lists the Entities shared by a Group <ent>, from
0057   //! its specific (own) parameters
0058   Standard_EXPORT void OwnShared(const occ::handle<IGESBasic_Group>& ent,
0059                                  Interface_EntityIterator&           iter) const;
0060
0061   //! Sets automatic unambiguous Correction on a Group
0062   //! (Null Elements are removed from list)
0063   Standard_EXPORT bool OwnCorrect(const occ::handle<IGESBasic_Group>& ent) const;
0064
0065   //! Returns specific DirChecker
0066   Standard_EXPORT IGESData_DirChecker DirChecker(const occ::handle<IGESBasic_Group>& ent) const;
0067
0068   //! Performs Specific Semantic Check
0069   Standard_EXPORT void OwnCheck(const occ::handle<IGESBasic_Group>& ent,
0070                                 const Interface_ShareTool&          shares,
0071                                 occ::handle<Interface_Check>&       ach) const;
0072
0073   //! Copies Specific Parameters
0074   Standard_EXPORT void OwnCopy(const occ::handle<IGESBasic_Group>& entfrom,
0075                                const occ::handle<IGESBasic_Group>& entto,
0076                                Interface_CopyTool&                 TC) const;
0077
0078   //! Dump of Specific Parameters
0079   Standard_EXPORT void OwnDump(const occ::handle<IGESBasic_Group>& ent,
0080                                const IGESData_IGESDumper&          dumper,
0081                                Standard_OStream&                   S,
0082                                const int                           own) const;
0083 };
0084
0085 #endif // _IGESBasic_ToolGroup_HeaderFile