src/IGESDefs/IGESDefs_UnitsData.hxx

   1 // Created on: 1993-01-13
   2 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
   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 _IGESDefs_UnitsData_HeaderFile
  18 #define _IGESDefs_UnitsData_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Interface_HArray1OfHAsciiString.hxx>
  24 #include <TColStd_HArray1OfReal.hxx>
  25 #include <IGESData_IGESEntity.hxx>
  26 #include <Standard_Integer.hxx>
  27 #include <Standard_Real.hxx>
  28 class TCollection_HAsciiString;
  29
  30
  31 class IGESDefs_UnitsData;
  32 DEFINE_STANDARD_HANDLE(IGESDefs_UnitsData, IGESData_IGESEntity)
  33
  34 //! defines IGES UnitsData Entity, Type <316> Form <0>
  35 //! in package IGESDefs
  36 //! This class stores data about a model's fundamental units.
  37 class IGESDefs_UnitsData : public IGESData_IGESEntity
  38 {
  39
  40 public:
  41
  42
  43   Standard_EXPORT IGESDefs_UnitsData();
  44
  45   //! This method is used to set the fields of the class
  46   //! UnitsData
  47   //! - unitTypes  : Types of the units being defined
  48   //! - unitValues : Unit Values of the units
  49   //! - unitScales : Multiplicative Scale Factors
  50   //! raises exception if lengths of unitTypes, unitValues and
  51   //! unitScale are not same
  52   Standard_EXPORT void Init (const Handle(Interface_HArray1OfHAsciiString)& unitTypes, const Handle(Interface_HArray1OfHAsciiString)& unitValues, const Handle(TColStd_HArray1OfReal)& unitScales);
  53
  54   //! returns the Number of units defined by this entity
  55   Standard_EXPORT Standard_Integer NbUnits() const;
  56
  57   //! returns the Type of the UnitNum'th unit being defined
  58   //! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
  59   Standard_EXPORT Handle(TCollection_HAsciiString) UnitType (const Standard_Integer UnitNum) const;
  60
  61   //! returns the Units of the UnitNum'th unit being defined
  62   //! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
  63   Standard_EXPORT Handle(TCollection_HAsciiString) UnitValue (const Standard_Integer UnitNum) const;
  64
  65   //! returns the multiplicative scale factor to be applied to the
  66   //! UnitNum'th unit being defined
  67   //! raises exception if UnitNum <= 0 or UnitNum > NbUnits()
  68   Standard_EXPORT Standard_Real ScaleFactor (const Standard_Integer UnitNum) const;
  69
  70
  71
  72
  73   DEFINE_STANDARD_RTTIEXT(IGESDefs_UnitsData,IGESData_IGESEntity)
  74
  75 protected:
  76
  77
  78
  79
  80 private:
  81
  82
  83   Handle(Interface_HArray1OfHAsciiString) theUnitTypes;
  84   Handle(Interface_HArray1OfHAsciiString) theUnitValues;
  85   Handle(TColStd_HArray1OfReal) theUnitScales;
  86
  87
  88 };
  89
  90
  91
  92
  93
  94
  95
  96 #endif // _IGESDefs_UnitsData_HeaderFile