0025748: Parallel version of progress indicator
[occt.git] / src / IGESControl / IGESControl_Writer.hxx
1 // Created on: 1996-01-30
2 // Created by: Christian CAILLET
3 // Copyright (c) 1996-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 _IGESControl_Writer_HeaderFile
18 #define _IGESControl_Writer_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <IGESData_BasicEditor.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <Standard_CString.hxx>
28 #include <Standard_OStream.hxx>
29 #include <Message_ProgressRange.hxx>
30
31 class Transfer_FinderProcess;
32 class IGESData_IGESModel;
33 class TopoDS_Shape;
34 class Standard_Transient;
35 class IGESData_IGESEntity;
36
37
38 //! This class creates and writes
39 //! IGES files from CAS.CADE models. An IGES file can be written to
40 //! an existing IGES file or to a new one.
41 //! The translation can be performed in one or several
42 //! operations. Each translation operation
43 //! outputs a distinct root entity in the IGES file.
44 //! To write an IGES file it is possible to use the following sequence:
45 //! To modify the IGES file header or to change translation
46 //! parameters it is necessary to use class Interface_Static (see
47 //! IGESParameters and GeneralParameters).
48 class IGESControl_Writer 
49 {
50 public:
51
52   DEFINE_STANDARD_ALLOC
53   
54   //! Creates a writer object with the
55   //! default unit (millimeters) and write mode (Face).
56   //! IGESControl_Writer (const Standard_CString unit,
57   //! const Standard_Integer modecr = 0);
58   Standard_EXPORT IGESControl_Writer();
59   
60   //! Creates a writer with given
61   //! values for units and for write mode.
62   //! unit may be any unit that is accepted by the IGES standard.
63   //! By default, it is the millimeter.
64   //! modecr defines the write mode and may be:
65   //! - 0: Faces (default)
66   //! - 1: BRep.
67   Standard_EXPORT IGESControl_Writer(const Standard_CString unit, const Standard_Integer modecr = 0);
68   
69   //! Creates a writer object with the
70   //! prepared IGES model model in write mode.
71   //! modecr defines the write mode and may be:
72   //! - 0: Faces (default)
73   //! - 1: BRep.
74   Standard_EXPORT IGESControl_Writer(const Handle(IGESData_IGESModel)& model, const Standard_Integer modecr = 0);
75   
76   //! Returns the IGES model to be written in output.
77   const Handle(IGESData_IGESModel) & Model() const
78   { return myModel; }
79
80   const Handle(Transfer_FinderProcess) & TransferProcess() const
81   { return myTP; }
82
83   //! Returns/Sets the TransferProcess : it contains final results
84   //! and if some, check messages
85   void SetTransferProcess (const Handle(Transfer_FinderProcess)& TP)
86   { myTP = TP; }
87   
88   //! Translates a Shape to IGES Entities and adds them to the model
89   //! Returns True if done, False if Shape not suitable for IGES or null
90   Standard_EXPORT Standard_Boolean AddShape (const TopoDS_Shape& sh,
91                                              const Message_ProgressRange& theProgress = Message_ProgressRange());
92   
93   //! Translates a Geometry (Surface or Curve) to IGES Entities and
94   //! adds them to the model
95   //! Returns True if done, False if geom is neither a Surface or
96   //! a Curve suitable for IGES or is null
97   Standard_EXPORT Standard_Boolean AddGeom (const Handle(Standard_Transient)& geom);
98   
99   //! Adds an IGES entity (and the ones it references) to the model
100   Standard_EXPORT Standard_Boolean AddEntity (const Handle(IGESData_IGESEntity)& ent);
101   
102   //! Computes the entities found in
103   //! the model, which is ready to be written.
104   //! This contrasts with the default computation of headers only.
105   Standard_EXPORT void ComputeModel();
106   
107   //! Computes then writes the model to an OStream
108   //! Returns True when done, false in case of error
109   Standard_EXPORT Standard_Boolean Write (Standard_OStream& S, const Standard_Boolean fnes = Standard_False);
110   
111   //! Prepares and writes an IGES model
112   //! either to an OStream, S or to a file name,CString.
113   //! Returns True if the operation was performed correctly and
114   //! False if an error occurred (for instance,
115   //! if the processor could not create the file).
116   Standard_EXPORT Standard_Boolean Write (const Standard_CString file, const Standard_Boolean fnes = Standard_False);
117
118  private:
119
120   Handle(Transfer_FinderProcess) myTP;
121   Handle(IGESData_IGESModel) myModel;
122   IGESData_BasicEditor myEditor;
123   Standard_Integer myWriteMode;
124   Standard_Boolean myIsComputed;
125 };
126
127 #endif // _IGESControl_Writer_HeaderFile