src/STEPConstruct/STEPConstruct_UnitContext.hxx

   1 // Created on: 1996-01-18
   2 // Created by: Frederic MAUPAS
   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 _STEPConstruct_UnitContext_HeaderFile
  18 #define _STEPConstruct_UnitContext_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_Real.hxx>
  26 #include <Standard_Integer.hxx>
  27 #include <Standard_CString.hxx>
  28 #include <StepBasic_SiPrefix.hxx>
  29 class StepGeom_GeomRepContextAndGlobUnitAssCtxAndGlobUncertaintyAssCtx;
  30 class StepRepr_GlobalUnitAssignedContext;
  31 class StepBasic_NamedUnit;
  32 class StepRepr_GlobalUncertaintyAssignedContext;
  33 class StepBasic_SiUnit;
  34
  35
  36 //! Tool for creation (encoding) and decoding (for writing and reading
  37 //! accordingly) context defining units and tolerances (uncerntanties)
  38 class STEPConstruct_UnitContext
  39 {
  40 public:
  41
  42   DEFINE_STANDARD_ALLOC
  43
  44
  45   //! Creates empty tool
  46   Standard_EXPORT STEPConstruct_UnitContext();
  47
  48   //! Creates new context (units are MM and radians,
  49   //! uncertainty equal to Tol3d)
  50   Standard_EXPORT void Init (const Standard_Real Tol3d);
  51
  52   //! Returns True if Init was called successfully
  53   Standard_EXPORT Standard_Boolean IsDone() const;
  54
  55   //! Returns context (or Null if not done)
  56   Standard_EXPORT Handle(StepGeom_GeomRepContextAndGlobUnitAssCtxAndGlobUncertaintyAssCtx) Value() const;
  57
  58   //! Computes the length, plane angle and solid angle conversion
  59   //! factor  .  Returns a status, 0 if OK
  60   Standard_EXPORT Standard_Integer ComputeFactors (const Handle(StepRepr_GlobalUnitAssignedContext)& aContext);
  61
  62   Standard_EXPORT Standard_Integer ComputeFactors (const Handle(StepBasic_NamedUnit)& aUnit);
  63
  64   //! Computes the uncertainty value (for length)
  65   Standard_EXPORT Standard_Integer ComputeTolerance (const Handle(StepRepr_GlobalUncertaintyAssignedContext)& aContext);
  66
  67   //! Returns the lengthFactor
  68   Standard_EXPORT Standard_Real LengthFactor() const;
  69
  70   //! Returns the planeAngleFactor
  71   Standard_EXPORT Standard_Real PlaneAngleFactor() const;
  72
  73   //! Returns the solidAngleFactor
  74   Standard_EXPORT Standard_Real SolidAngleFactor() const;
  75
  76   //! Returns the Uncertainty value (for length)
  77   //! It has been converted  with LengthFactor
  78   Standard_EXPORT Standard_Real Uncertainty() const;
  79
  80   //! Returns the areaFactor
  81   Standard_EXPORT Standard_Real AreaFactor() const;
  82
  83   //! Returns the volumeFactor
  84   Standard_EXPORT Standard_Real VolumeFactor() const;
  85
  86   //! Tells if a Uncertainty (for length) is recorded
  87   Standard_EXPORT Standard_Boolean HasUncertainty() const;
  88
  89   //! Returns true if ComputeFactors has calculated
  90   //! a LengthFactor
  91   Standard_EXPORT Standard_Boolean LengthDone() const;
  92
  93   //! Returns true if ComputeFactors has calculated
  94   //! a PlaneAngleFactor
  95   Standard_EXPORT Standard_Boolean PlaneAngleDone() const;
  96
  97   //! Returns true if ComputeFactors has calculated
  98   //! a SolidAngleFactor
  99   Standard_EXPORT Standard_Boolean SolidAngleDone() const;
 100
 101   //! Returns true if areaFactor is computed
 102   Standard_EXPORT Standard_Boolean AreaDone() const;
 103
 104   //! Returns true if volumeFactor is computed
 105   Standard_EXPORT Standard_Boolean VolumeDone() const;
 106
 107   //! Returns a message for a given status (0 - empty)
 108   //! This message can then be added as warning for transfer
 109   Standard_EXPORT Standard_CString StatusMessage (const Standard_Integer status) const;
 110
 111   //! Convert SI prefix defined by enumertaion to corresponding
 112   //! real factor (e.g. 1e6 for mega)
 113   Standard_EXPORT static Standard_Real ConvertSiPrefix (const StepBasic_SiPrefix aPrefix);
 114
 115
 116
 117
 118 protected:
 119
 120
 121
 122
 123
 124 private:
 125
 126
 127   //! Fills numerical equivalent of SiUnitName (in SI value)
 128   //! Returns False if name SiUnit Name not recognized
 129   Standard_EXPORT Standard_Boolean SiUnitNameFactor (const Handle(StepBasic_SiUnit)& aSiUnit, Standard_Real& val) const;
 130
 131
 132   Standard_Boolean done;
 133   Handle(StepGeom_GeomRepContextAndGlobUnitAssCtxAndGlobUncertaintyAssCtx) GRC;
 134   Standard_Real lengthFactor;
 135   Standard_Real planeAngleFactor;
 136   Standard_Real solidAngleFactor;
 137   Standard_Real theUncertainty;
 138   Standard_Real areaFactor;
 139   Standard_Real volumeFactor;
 140   Standard_Boolean areaDone;
 141   Standard_Boolean volumeDone;
 142   Standard_Boolean lengthDone;
 143   Standard_Boolean planeAngleDone;
 144   Standard_Boolean solidAngleDone;
 145   Standard_Boolean hasUncertainty;
 146
 147
 148 };
 149
 150
 151
 152
 153
 154
 155
 156 #endif // _STEPConstruct_UnitContext_HeaderFile