0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IGESDimen / IGESDimen_DiameterDimension.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 _IGESDimen_DiameterDimension_HeaderFile
18 #define _IGESDimen_DiameterDimension_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <gp_XY.hxx>
24 #include <IGESData_IGESEntity.hxx>
25 #include <Standard_Boolean.hxx>
26 class IGESDimen_GeneralNote;
27 class IGESDimen_LeaderArrow;
28 class gp_XY;
29 class gp_Pnt2d;
30
31
32 class IGESDimen_DiameterDimension;
33 DEFINE_STANDARD_HANDLE(IGESDimen_DiameterDimension, IGESData_IGESEntity)
34
35 //! defines DiameterDimension, Type <206> Form <0>
36 //! in package IGESDimen
37 //! Used for dimensioning diameters
38 class IGESDimen_DiameterDimension : public IGESData_IGESEntity
39 {
40
41 public:
42
43   
44   Standard_EXPORT IGESDimen_DiameterDimension();
45   
46   //! This method is used to set the fields of the class
47   //! DiameterDimension
48   //! - aNote         : General Note Entity
49   //! - aLeader       : First Leader Entity
50   //! - anotherLeader : Second Leader Entity or a Null Handle.
51   //! - aCenter       : Arc center coordinates
52   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Handle(IGESDimen_LeaderArrow)& aLeader, const Handle(IGESDimen_LeaderArrow)& anotherLeader, const gp_XY& aCenter);
53   
54   //! returns the General Note Entity
55   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
56   
57   //! returns the First Leader Entity
58   Standard_EXPORT Handle(IGESDimen_LeaderArrow) FirstLeader() const;
59   
60   //! returns False if theSecondleader is a Null Handle.
61   Standard_EXPORT Standard_Boolean HasSecondLeader() const;
62   
63   //! returns the Second Leader Entity
64   Standard_EXPORT Handle(IGESDimen_LeaderArrow) SecondLeader() const;
65   
66   //! returns the Arc Center coordinates as Pnt2d from package gp
67   Standard_EXPORT gp_Pnt2d Center() const;
68   
69   //! returns the Arc Center coordinates as Pnt2d from package gp
70   //! after Transformation. (Z = 0.0 for Transformation)
71   Standard_EXPORT gp_Pnt2d TransformedCenter() const;
72
73
74
75
76   DEFINE_STANDARD_RTTIEXT(IGESDimen_DiameterDimension,IGESData_IGESEntity)
77
78 protected:
79
80
81
82
83 private:
84
85
86   Handle(IGESDimen_GeneralNote) theNote;
87   Handle(IGESDimen_LeaderArrow) theFirstLeader;
88   Handle(IGESDimen_LeaderArrow) theSecondLeader;
89   gp_XY theCenter;
90
91
92 };
93
94
95
96
97
98
99
100 #endif // _IGESDimen_DiameterDimension_HeaderFile