include/opencascade/IGESData_IGESDumper.hxx

0001 // Created on: 1993-09-06
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 _IGESData_IGESDumper_HeaderFile
0018 #define _IGESData_IGESDumper_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <IGESData_SpecificLib.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028 class IGESData_IGESModel;
0029 class IGESData_Protocol;
0030 class IGESData_IGESEntity;
0031
0032 //! Provides a way to obtain a clear Dump of an IGESEntity
0033 //! (distinct from normalized output). It works with tools
0034 //! attached to Entities, as for normalized Reade and Write
0035 //!
0036 //! For each Entity, displaying data is split in own data
0037 //! (specific to each type) and other attached data, which are
0038 //! defined for all IGES Types (either from "Directory Entry" or
0039 //! from Lists of Associativities and Properties)
0040 class IGESData_IGESDumper
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Returns an IGESDumper ready to work.
0046   //! The IGESModel provides the numbering of Entities:
0047   //! as for any InterfaceModel, it gives each Entity a number;
0048   //! but for IGESEntities, the "Number of Directory Entry"
0049   //! according to the definition of IGES Files, is also useful.
0050   Standard_EXPORT IGESData_IGESDumper(const Handle(IGESData_IGESModel)& model,
0051                                       const Handle(IGESData_Protocol)&  protocol);
0052
0053   //! Prints onto an output, the "Number of Directory Entry" which
0054   //! corresponds to an IGESEntity in the IGESModel, under the form
0055   //! "D#nnn" (a Null Handle gives D#0)
0056   Standard_EXPORT void PrintDNum(const Handle(IGESData_IGESEntity)& ent, Standard_OStream& S) const;
0057
0058   //! Prints onto an output, the "Number of Directory Entry" (see
0059   //! PrintDNum) plus IGES Type and Form Numbers, which gives
0060   //! "D#nnn  Type nnn  Form nnn"
0061   Standard_EXPORT void PrintShort(const Handle(IGESData_IGESEntity)& ent,
0062                                   Standard_OStream&                  S) const;
0063
0064   Standard_EXPORT void Dump(const Handle(IGESData_IGESEntity)& ent,
0065                             Standard_OStream&                  S,
0066                             const Standard_Integer             own,
0067                             const Standard_Integer             attached = -1) const;
0068
0069   //! Specific Dump for each IGES Entity, call by Dump (just above)
0070   //! <own> is the parameter <own> from Dump
0071   Standard_EXPORT void OwnDump(const Handle(IGESData_IGESEntity)& ent,
0072                                Standard_OStream&                  S,
0073                                const Standard_Integer             own) const;
0074
0075 private:
0076   Handle(IGESData_IGESModel) themodel;
0077   IGESData_SpecificLib       thelib;
0078 };
0079
0080 #endif // _IGESData_IGESDumper_HeaderFile