src/IGESDimen/IGESDimen_DimensionDisplayData.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
   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 _IGESDimen_DimensionDisplayData_HeaderFile
  18 #define _IGESDimen_DimensionDisplayData_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <Standard_Real.hxx>
  25 #include <TColStd_HArray1OfInteger.hxx>
  26 #include <IGESData_IGESEntity.hxx>
  27 class TCollection_HAsciiString;
  28 class Standard_DimensionMismatch;
  29 class Standard_OutOfRange;
  30
  31
  32 class IGESDimen_DimensionDisplayData;
  33 DEFINE_STANDARD_HANDLE(IGESDimen_DimensionDisplayData, IGESData_IGESEntity)
  34
  35 //! Defines IGES Dimension Display Data, Type <406> Form <30>,
  36 //! in package IGESDimen
  37 //! The Dimensional Display Data Property is optional but when
  38 //! present must be referenced by a dimension entity.
  39 //! The information it contains could be extracted from the text,
  40 //! leader and witness line data with difficulty.
  41 class IGESDimen_DimensionDisplayData : public IGESData_IGESEntity
  42 {
  43
  44 public:
  45
  46
  47   Standard_EXPORT IGESDimen_DimensionDisplayData();
  48
  49   Standard_EXPORT void Init (const Standard_Integer numProps, const Standard_Integer aDimType, const Standard_Integer aLabelPos, const Standard_Integer aCharSet, const Handle(TCollection_HAsciiString)& aString, const Standard_Integer aSymbol, const Standard_Real anAng, const Standard_Integer anAlign, const Standard_Integer aLevel, const Standard_Integer aPlace, const Standard_Integer anOrient, const Standard_Real initVal, const Handle(TColStd_HArray1OfInteger)& notes, const Handle(TColStd_HArray1OfInteger)& startInd, const Handle(TColStd_HArray1OfInteger)& endInd);
  50
  51   //! returns the number of property values (14)
  52   Standard_EXPORT Standard_Integer NbPropertyValues() const;
  53
  54   //! returns the dimension type
  55   Standard_EXPORT Standard_Integer DimensionType() const;
  56
  57   //! returns the preferred label position
  58   Standard_EXPORT Standard_Integer LabelPosition() const;
  59
  60   //! returns the character set interpretation
  61   Standard_EXPORT Standard_Integer CharacterSet() const;
  62
  63   //! returns e.g., 8HDIAMETER
  64   Standard_EXPORT Handle(TCollection_HAsciiString) LString() const;
  65
  66   Standard_EXPORT Standard_Integer DecimalSymbol() const;
  67
  68   //! returns the witness line angle in radians
  69   Standard_EXPORT Standard_Real WitnessLineAngle() const;
  70
  71   //! returns the text alignment
  72   Standard_EXPORT Standard_Integer TextAlignment() const;
  73
  74   //! returns the text level
  75   Standard_EXPORT Standard_Integer TextLevel() const;
  76
  77   //! returns the preferred text placement
  78   Standard_EXPORT Standard_Integer TextPlacement() const;
  79
  80   //! returns the arrowhead orientation
  81   Standard_EXPORT Standard_Integer ArrowHeadOrientation() const;
  82
  83   //! returns the primary dimension initial value
  84   Standard_EXPORT Standard_Real InitialValue() const;
  85
  86   //! returns the number of supplementary notes or zero
  87   Standard_EXPORT Standard_Integer NbSupplementaryNotes() const;
  88
  89   //! returns the Index'th supplementary note
  90   //! raises exception if Index <= 0 or Index > NbSupplementaryNotes()
  91   Standard_EXPORT Standard_Integer SupplementaryNote (const Standard_Integer Index) const;
  92
  93   //! returns the Index'th note start index
  94   //! raises exception if Index <= 0 or Index > NbSupplementaryNotes()
  95   Standard_EXPORT Standard_Integer StartIndex (const Standard_Integer Index) const;
  96
  97   //! returns the Index'th note end index
  98   //! raises exception if Index <= 0 or Index > NbSupplemetaryNotes()
  99   Standard_EXPORT Standard_Integer EndIndex (const Standard_Integer Index) const;
 100
 101
 102
 103
 104   DEFINE_STANDARD_RTTIEXT(IGESDimen_DimensionDisplayData,IGESData_IGESEntity)
 105
 106 protected:
 107
 108
 109
 110
 111 private:
 112
 113
 114   Standard_Integer theNbPropertyValues;
 115   Standard_Integer theDimensionType;
 116   Standard_Integer theLabelPosition;
 117   Standard_Integer theCharacterSet;
 118   Handle(TCollection_HAsciiString) theLString;
 119   Standard_Integer theDecimalSymbol;
 120   Standard_Real theWitnessLineAngle;
 121   Standard_Integer theTextAlignment;
 122   Standard_Integer theTextLevel;
 123   Standard_Integer theTextPlacement;
 124   Standard_Integer theArrowHeadOrientation;
 125   Standard_Real theInitialValue;
 126   Handle(TColStd_HArray1OfInteger) theSupplementaryNotes;
 127   Handle(TColStd_HArray1OfInteger) theStartIndex;
 128   Handle(TColStd_HArray1OfInteger) theEndIndex;
 129
 130
 131 };
 132
 133
 134
 135
 136
 137
 138
 139 #endif // _IGESDimen_DimensionDisplayData_HeaderFile