src/IGESBasic/IGESBasic_ToolName.hxx

   1 // Created on: 1993-10-14
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESBasic_ToolName_HeaderFile
  18 #define _IGESBasic_ToolName_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Integer.hxx>
  26 class Standard_DomainError;
  27 class IGESBasic_Name;
  28 class IGESData_IGESReaderData;
  29 class IGESData_ParamReader;
  30 class IGESData_IGESWriter;
  31 class Interface_EntityIterator;
  32 class IGESData_DirChecker;
  33 class Interface_ShareTool;
  34 class Interface_Check;
  35 class Interface_CopyTool;
  36 class IGESData_IGESDumper;
  37
  38 //! Tool to work on a Name. Called by various Modules
  39 //! (ReadWriteModule, GeneralModule, SpecificModule)
  40 class IGESBasic_ToolName
  41 {
  42 public:
  43
  44   DEFINE_STANDARD_ALLOC
  45
  46
  47   //! Returns a ToolName, ready to work
  48   Standard_EXPORT IGESBasic_ToolName();
  49
  50   //! Reads own parameters from file. <PR> gives access to them,
  51   //! <IR> detains parameter types and values
  52   Standard_EXPORT void ReadOwnParams (const Handle(IGESBasic_Name)& ent, const Handle(IGESData_IGESReaderData)& IR, IGESData_ParamReader& PR) const;
  53
  54   //! Writes own parameters to IGESWriter
  55   Standard_EXPORT void WriteOwnParams (const Handle(IGESBasic_Name)& ent, IGESData_IGESWriter& IW) const;
  56
  57   //! Lists the Entities shared by a Name <ent>, from
  58   //! its specific (own) parameters
  59   Standard_EXPORT void OwnShared (const Handle(IGESBasic_Name)& ent, Interface_EntityIterator& iter) const;
  60
  61   //! Sets automatic unambiguous Correction on a Name
  62   //! (NbPropertyValues forced to 1)
  63   Standard_EXPORT Standard_Boolean OwnCorrect (const Handle(IGESBasic_Name)& ent) const;
  64
  65   //! Returns specific DirChecker
  66   Standard_EXPORT IGESData_DirChecker DirChecker (const Handle(IGESBasic_Name)& ent) const;
  67
  68   //! Performs Specific Semantic Check
  69   Standard_EXPORT void OwnCheck (const Handle(IGESBasic_Name)& ent, const Interface_ShareTool& shares, Handle(Interface_Check)& ach) const;
  70
  71   //! Copies Specific Parameters
  72   Standard_EXPORT void OwnCopy (const Handle(IGESBasic_Name)& entfrom, const Handle(IGESBasic_Name)& entto, Interface_CopyTool& TC) const;
  73
  74   //! Dump of Specific Parameters
  75   Standard_EXPORT void OwnDump (const Handle(IGESBasic_Name)& ent, const IGESData_IGESDumper& dumper, Standard_OStream& S, const Standard_Integer own) const;
  76
  77
  78
  79
  80 protected:
  81
  82
  83
  84
  85
  86 private:
  87
  88
  89
  90
  91
  92 };
  93
  94
  95
  96
  97
  98
  99
 100 #endif // _IGESBasic_ToolName_HeaderFile