0029119: Documentation for PMI in XCAF

[occt.git] / src / XCAFDimTolObjects / XCAFDimTolObjects_GeomToleranceObject.hxx

diff --git a/src/XCAFDimTolObjects/XCAFDimTolObjects_GeomToleranceObject.hxx b/src/XCAFDimTolObjects/XCAFDimTolObjects_GeomToleranceObject.hxx
index 5fdf620..4b0547f 100644 (file)
--- a/src/XCAFDimTolObjects/XCAFDimTolObjects_GeomToleranceObject.hxx
+++ b/src/XCAFDimTolObjects/XCAFDimTolObjects_GeomToleranceObject.hxx
@@ -36,7 +36,7 @@
 class XCAFDimTolObjects_GeomToleranceObject;
 DEFINE_STANDARD_HANDLE(XCAFDimTolObjects_GeomToleranceObject, Standard_Transient)
 
-//! attribute to store dimension and tolerance
+//! Access object to store dimension and tolerance
 class XCAFDimTolObjects_GeomToleranceObject : public Standard_Transient
 {
 
@@ -46,38 +46,55 @@ public:
   
   Standard_EXPORT XCAFDimTolObjects_GeomToleranceObject(const Handle(XCAFDimTolObjects_GeomToleranceObject)& theObj);
   
+  //! Sets type of the object.
   Standard_EXPORT void SetType (const XCAFDimTolObjects_GeomToleranceType theType);
   
+  //! Returns type of the object.
   Standard_EXPORT XCAFDimTolObjects_GeomToleranceType GetType() const;
   
+  //! Sets type of tolerance value.
   Standard_EXPORT void SetTypeOfValue (const XCAFDimTolObjects_GeomToleranceTypeValue theTypeOfValue);
   
+  //! Returns type of tolerance value.
   Standard_EXPORT XCAFDimTolObjects_GeomToleranceTypeValue GetTypeOfValue() const;
   
+  //! Sets tolerance value.
   Standard_EXPORT void SetValue (const Standard_Real theValue);
   
+  //! Returns tolerance value.
   Standard_EXPORT Standard_Real GetValue() const;
   
+  //! Sets material requirement of the tolerance.
   Standard_EXPORT void SetMaterialRequirementModifier (const XCAFDimTolObjects_GeomToleranceMatReqModif theMatReqModif);
   
+  //! Returns material requirement of the tolerance.
   Standard_EXPORT XCAFDimTolObjects_GeomToleranceMatReqModif GetMaterialRequirementModifier() const;
   
+  //! Sets tolerance zone.
   Standard_EXPORT void SetZoneModifier (const XCAFDimTolObjects_GeomToleranceZoneModif theZoneModif);
   
+  //! Returns tolerance zone.
   Standard_EXPORT XCAFDimTolObjects_GeomToleranceZoneModif GetZoneModifier() const;
   
+  //! Sets value associated with tolerance zone.
   Standard_EXPORT void SetValueOfZoneModifier (const Standard_Real theValue);
   
+  //! Returns value associated with tolerance zone.
   Standard_EXPORT Standard_Real GetValueOfZoneModifier() const;
   
+  //! Sets new sequence of tolerance modifiers.
   Standard_EXPORT void SetModifiers (const XCAFDimTolObjects_GeomToleranceModifiersSequence& theModifiers);
   
+  //! Adds a tolerance modifier to the sequence of modifiers.
   Standard_EXPORT void AddModifier (const XCAFDimTolObjects_GeomToleranceModif theModifier);
   
+  //! Returns a sequence of modifiers of the tolerance.
   Standard_EXPORT XCAFDimTolObjects_GeomToleranceModifiersSequence GetModifiers() const;
   
+  //! Sets the maximal upper tolerance value for tolerance with modifiers.
   Standard_EXPORT void SetMaxValueModifier (const Standard_Real theModifier);
   
+  //! Returns the maximal upper tolerance.
   Standard_EXPORT Standard_Real GetMaxValueModifier() const;
 
   Standard_EXPORT void SetAxis (const gp_Ax2 theAxis);
@@ -86,43 +103,52 @@ public:
    
   Standard_EXPORT Standard_Boolean HasAxis () const;
 
+  //! Sets annotation plane.
   void SetPlane (const gp_Ax2& thePlane)
   {
     myPlane = thePlane;
     myHasPlane = Standard_True;
   }
 
+  //! Returns annotation plane.
   const gp_Ax2& GetPlane() const { return myPlane; }
 
+  //! Sets reference point.
   void SetPoint (const gp_Pnt& thePnt)
   {
     myPnt = thePnt;
     myHasPnt = Standard_True;
   }
 
+  //! Returns reference point.
   const gp_Pnt& GetPoint() const { return myPnt; }
 
+  //! Sets text position.
   void SetPointTextAttach (const gp_Pnt& thePntText)
   {
     myPntText = thePntText;
     myHasPntText = Standard_True;
   }
 
+  //! Returns the text position.
   const gp_Pnt& GetPointTextAttach() const 
   { 
     return myPntText; 
   }
+
+  //! Returns True if the object has annotation plane.
   Standard_Boolean HasPlane() const { return myHasPlane; }
 
+  //! Returns True if reference point is specified.
   Standard_Boolean HasPoint() const { return myHasPnt; }
   
+  //! Returns True if text position is specified.
   Standard_Boolean HasPointText() const 
   { 
     return myHasPntText; 
   }
-
- 
-   //! Set graphical presentation for object
+   
+  //! Set graphical presentation for object.
   Standard_EXPORT void SetPresentation(const TopoDS_Shape& thePresentation, 
     const Handle(TCollection_HAsciiString)& thePresentationName)
   {
@@ -130,13 +156,13 @@ public:
     myPresentationName = thePresentationName;
   }
 
-  //! Returns graphical presentation of the object
+  //! Returns graphical presentation of the object.
   Standard_EXPORT TopoDS_Shape GetPresentation() const
   {
     return myPresentation;
   }
 
-   //! Returns graphical presentation of the object
+  //! Returns graphical presentation of the object.
   Standard_EXPORT Handle(TCollection_HAsciiString) GetPresentationName() const
   {
     return myPresentationName;
@@ -167,10 +193,4 @@ private:
 
 };
 
-
-
-
-
-
-
 #endif // _XCAFDimTolObjects_GeomToleranceObject_HeaderFile