src/BRepToIGES/BRepToIGES_BREntity.hxx

   1 // Created on: 1994-11-15
   2 // Created by: Marie Jose MARTZ
   3 // Copyright (c) 1994-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 _BRepToIGES_BREntity_HeaderFile
  18 #define _BRepToIGES_BREntity_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_CString.hxx>
  25 #include <Message_ProgressRange.hxx>
  26
  27 class IGESData_IGESModel;
  28 class Transfer_FinderProcess;
  29 class IGESData_IGESEntity;
  30 class TopoDS_Shape;
  31 class Standard_Transient;
  32
  33
  34 //! provides methods to transfer BRep entity from CASCADE to IGES.
  35 class BRepToIGES_BREntity
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_ALLOC
  40
  41
  42   //! Creates a tool BREntity
  43   Standard_EXPORT BRepToIGES_BREntity();
  44
  45   //! Initializes the field of the tool BREntity with
  46   //! default creating values.
  47   Standard_EXPORT void Init();
  48
  49   //! Set the value of "TheModel"
  50   Standard_EXPORT void SetModel (const Handle(IGESData_IGESModel)& model);
  51
  52   //! Returns the value of "TheModel"
  53   Standard_EXPORT Handle(IGESData_IGESModel) GetModel() const;
  54
  55   //! Returns the value of the UnitFlag of the header of the model
  56   //! in meters.
  57   Standard_EXPORT Standard_Real GetUnit() const;
  58
  59   //! Set the value of "TheMap"
  60   Standard_EXPORT void SetTransferProcess (const Handle(Transfer_FinderProcess)& TP);
  61
  62   //! Returns the value of "TheMap"
  63   Standard_EXPORT Handle(Transfer_FinderProcess) GetTransferProcess() const;
  64
  65   //! Returns the result of the transfert of any Shape
  66   //! If  the transfer has  failed, this member return a NullEntity.
  67   Standard_EXPORT virtual Handle(IGESData_IGESEntity) TransferShape
  68                    (const TopoDS_Shape& start,
  69                     const Message_ProgressRange& theProgress = Message_ProgressRange());
  70
  71   //! Records a new Fail message
  72   Standard_EXPORT void AddFail (const TopoDS_Shape& start, const Standard_CString amess);
  73
  74   //! Records a new Warning message
  75   Standard_EXPORT void AddWarning (const TopoDS_Shape& start, const Standard_CString amess);
  76
  77   //! Records a new Fail message
  78   Standard_EXPORT void AddFail (const Handle(Standard_Transient)& start, const Standard_CString amess);
  79
  80   //! Records a new Warning message
  81   Standard_EXPORT void AddWarning (const Handle(Standard_Transient)& start, const Standard_CString amess);
  82
  83   //! Returns True if start was already treated and has a result in "TheMap"
  84   //! else returns False.
  85   Standard_EXPORT Standard_Boolean HasShapeResult (const TopoDS_Shape& start) const;
  86
  87   //! Returns the result of the transfer of the Shape "start" contained
  88   //! in "TheMap" . (if HasShapeResult is True).
  89   Standard_EXPORT Handle(Standard_Transient) GetShapeResult (const TopoDS_Shape& start) const;
  90
  91   //! set in "TheMap" the result of the transfer of the Shape "start".
  92   Standard_EXPORT void SetShapeResult (const TopoDS_Shape& start, const Handle(Standard_Transient)& result);
  93
  94   //! Returns True if start was already treated and has a result in "TheMap"
  95   //! else returns False.
  96   Standard_EXPORT Standard_Boolean HasShapeResult (const Handle(Standard_Transient)& start) const;
  97
  98   //! Returns the result of the transfer of the Transient "start" contained
  99   //! in "TheMap" . (if HasShapeResult is True).
 100   Standard_EXPORT Handle(Standard_Transient) GetShapeResult (const Handle(Standard_Transient)& start) const;
 101
 102   //! set in "TheMap" the result of the transfer of the Transient "start".
 103   Standard_EXPORT void SetShapeResult (const Handle(Standard_Transient)& start, const Handle(Standard_Transient)& result);
 104
 105   //! Returns mode for conversion of surfaces
 106   //! (value of parameter write.convertsurface.mode)
 107   Standard_EXPORT Standard_Boolean GetConvertSurfaceMode() const;
 108
 109   //! Returns mode for writing pcurves
 110   //! (value of parameter write.surfacecurve.mode)
 111   Standard_EXPORT Standard_Boolean GetPCurveMode() const;
 112
 113   Standard_EXPORT virtual ~BRepToIGES_BREntity();
 114
 115 private:
 116   Handle(IGESData_IGESModel) TheModel;
 117   Standard_Real TheUnitFactor;
 118   Standard_Boolean myConvSurface;
 119   Standard_Boolean myPCurveMode;
 120   Handle(Transfer_FinderProcess) TheMap;
 121 };
 122
 123 #endif // _BRepToIGES_BREntity_HeaderFile