From ff8178ef853e82d5faef3dacc3d9f858833609bc Mon Sep 17 00:00:00 2001 From: ski Date: Thu, 29 May 2014 16:05:47 +0400 Subject: [PATCH] 0024784: Move documentation in CDL files to proper location Mostly duplicated comments were removed and missing ones were moved into dedicated class CDL files. Some more duplicated comments were removed from CDL files. Correction of merge --- src/Adaptor2d/Adaptor2d.cdl | 6 +- src/Adaptor3d/Adaptor3d.cdl | 26 +--- src/Adaptor3d/Adaptor3d_InterFunc.cdl | 3 +- src/Adaptor3d/Adaptor3d_OffsetCurve.cdl | 2 +- .../Adaptor3d_SurfaceOfRevolution.cdl | 2 + src/AdvApp2Var/AdvApp2Var.cdl | 32 +---- src/AdvApp2Var/AdvApp2Var_Context.cdl | 3 + src/AdvApp2Var/AdvApp2Var_Criterion.cdl | 2 + .../AdvApp2Var_EvaluatorFunc2Var.hxx | 4 +- src/AdvApp2Var/AdvApp2Var_Iso.cdl | 3 + src/AdvApp2Var/AdvApp2Var_Node.cdl | 4 +- src/AdvApp2Var/AdvApp2Var_Patch.cdl | 3 + src/AdvApprox/AdvApprox.cdl | 28 +---- src/AdvApprox/AdvApprox_ApproxAFunction.cdl | 3 +- src/AdvApprox/AdvApprox_PrefAndRec.cdl | 1 + src/AppCont/AppCont.cdl | 18 --- src/AppCont/AppCont_Function.cdl | 3 +- src/AppCont/AppCont_Function2d.cdl | 3 +- src/AppCont/AppCont_FunctionTool.cdl | 3 +- src/AppCont/AppCont_FunctionTool2d.cdl | 3 +- src/AppCont/AppCont_LeastSquare.cdl | 6 +- src/AppDef/AppDef.cdl | 9 -- src/AppDef/AppDef_MyLineTool.cdl | 3 + src/AppDef/AppDef_Variational.cdl | 3 +- src/AppParCurves/AppParCurves.cdl | 19 +-- src/AppParCurves/AppParCurves_BSpGradient.cdl | 2 +- src/AppParCurves/AppParCurves_LeastSquare.cdl | 7 +- src/Approx/Approx.cdl | 9 +- src/Approx/Approx_ComputeCLine.cdl | 3 +- src/Approx/Approx_ComputeLine.cdl | 2 +- src/Aspect/Aspect.cdl | 53 +-------- src/Aspect/Aspect_CLayer2d.hxx | 1 + src/Aspect/Aspect_ColorCubeColorMap.cdl | 1 + src/Aspect/Aspect_ColorRampColorMap.cdl | 1 + src/Aspect/Aspect_ColorScale.cdl | 2 +- src/Aspect/Aspect_Display.hxx | 1 + .../Aspect_DisplayConnection_Handle.hxx | 2 + src/Aspect/Aspect_Drawable.hxx | 1 + src/Aspect/Aspect_FontMap.cdl | 1 + src/Aspect/Aspect_GenericColorMap.cdl | 1 + src/Aspect/Aspect_GraphicCallbackProc.hxx | 2 + src/Aspect/Aspect_MarkMap.cdl | 1 + src/Aspect/Aspect_Pixel.cdl | 1 + src/Aspect/Aspect_PolygonOffsetMode.hxx | 2 + src/Aspect/Aspect_RenderingContext.hxx | 1 + src/Aspect/Aspect_TypeMap.cdl | 1 + src/Aspect/Aspect_WidthMap.cdl | 1 + src/Aspect/Aspect_Window.cdl | 2 +- src/BRep/BRep.cdl | 55 ++------- src/BRep/BRep_Builder.cdl | 1 + src/BRep/BRep_GCurve.cdl | 2 +- src/BRep/BRep_PointOnCurve.cdl | 2 +- src/BRep/BRep_PointOnCurveOnSurface.cdl | 2 + src/BRep/BRep_PointOnSurface.cdl | 1 + src/BRep/BRep_PointsOnSurface.cdl | 2 +- src/BRep/BRep_Polygon3D.cdl | 2 +- src/BRep/BRep_TVertex.cdl | 2 +- src/BRepAdaptor/BRepAdaptor.cdl | 5 - src/BRepAlgo/BRepAlgo.cdl | 8 +- src/BRepAlgoAPI/BRepAlgoAPI.cdl | 15 +-- src/BRepBlend/BRepBlend.cdl | 45 +------ src/BRepBlend/BRepBlend_AppFunc.cdl | 1 + src/BRepBlend/BRepBlend_AppFuncRst.cdl | 2 +- src/BRepBlend/BRepBlend_AppFuncRstRst.cdl | 2 +- src/BRepBlend/BRepBlend_CurvPointRadInv.cdl | 4 +- src/BRepBlend/BRepBlend_RstRstConstRad.cdl | 3 +- src/BRepBlend/BRepBlend_RstRstEvolRad.cdl | 2 + src/BRepBlend/BRepBlend_RstRstLineBuilder.cdl | 9 ++ .../BRepBlend_SurfCurvConstRadInv.cdl | 4 +- .../BRepBlend_SurfCurvEvolRadInv.cdl | 6 +- .../BRepBlend_SurfPointConstRadInv.cdl | 3 +- .../BRepBlend_SurfPointEvolRadInv.cdl | 5 +- src/BRepBlend/BRepBlend_SurfRstConstRad.cdl | 2 + src/BRepBlend/BRepBlend_SurfRstEvolRad.cdl | 3 +- .../BRepBlend_SurfRstLineBuilder.cdl | 10 ++ src/BRepBuilderAPI/BRepBuilderAPI.cdl | 9 -- .../BRepBuilderAPI_NurbsConvert.cdl | 11 +- src/BRepBuilderAPI/BRepBuilderAPI_Sewing.cdl | 2 +- src/BRepClass/BRepClass.cdl | 8 -- src/BRepClass/BRepClass_FaceClassifier.cdl | 2 +- src/BRepClass/BRepClass_FaceExplorer.cdl | 2 +- src/BRepClass/BRepClass_Intersector.cdl | 3 +- src/BRepFill/BRepFill.cdl | 44 +------ src/BRepFill/BRepFill_CompatibleWires.cdl | 6 +- src/BRepFill/BRepFill_CurveConstraint.cdl | 5 +- src/BRepFill/BRepFill_OffsetWire.cdl | 2 +- src/BRepFill/BRepFill_PipeShell.cdl | 4 +- src/BRepFill/BRepFill_Sweep.cdl | 2 + src/BRepFill/BRepFill_TrimEdgeTool.cdl | 2 +- src/BRepFill/BRepFill_TrimSurfaceTool.cdl | 3 +- src/BRepLib/BRepLib.cdl | 3 - src/BRepMAT2d/BRepMAT2d.cdl | 11 +- src/BRepMAT2d/BRepMAT2d_LinkTopoBilo.cdl | 2 +- src/BRepMesh/BRepMesh.cdl | 1 - src/BRepMesh/BRepMesh_IncrementalMesh.cdl | 4 +- src/BRepOffset/BRepOffset.cdl | 6 - src/BRepOffset/BRepOffset_Offset.cdl | 7 +- src/BRepOffsetAPI/BRepOffsetAPI.cdl | 21 +--- src/BRepPrimAPI/BRepPrimAPI.cdl | 1 - src/BRepProj/BRepProj.cdl | 5 +- src/BRepSweep/BRepSweep.cdl | 6 +- src/BRepTools/BRepTools.cdl | 25 ---- src/BRepTools/BRepTools_Modifier.cdl | 2 +- src/BSplCLib/BSplCLib.cdl | 8 -- src/BSplCLib/BSplCLib_EvaluatorFunction.hxx | 4 + src/BiTgte/BiTgte.cdl | 5 - src/BiTgte/BiTgte_Blend.cdl | 2 +- src/BiTgte/BiTgte_CurveOnEdge.cdl | 3 +- src/BiTgte/BiTgte_CurveOnVertex.cdl | 3 +- src/BinMDataStd/BinMDataStd.cdl | 4 +- src/BinMDataXtd/BinMDataXtd.cdl | 4 +- src/BinMPrsStd/BinMPrsStd.cdl | 4 +- src/Bisector/Bisector.cdl | 14 +-- src/Bisector/Bisector_BisecAna.cdl | 4 +- src/Bnd/Bnd.cdl | 12 -- src/BndLib/BndLib.cdl | 2 - src/CDF/CDF.cdl | 4 +- src/CDF/CDF_MetaDataDriver.cdl | 3 +- src/CDM/CDM.cdl | 5 +- src/CDM/CDM_COutMessageDriver.cdl | 1 + src/CDM/CDM_NullMessageDriver.cdl | 1 + src/CPnts/CPnts.cdl | 12 -- src/CPnts/CPnts_MyGaussFunction.cdl | 1 + src/CPnts/CPnts_MyRootFunction.cdl | 1 + src/CPnts/CPnts_RealFunction.hxx | 2 + src/CPnts/CPnts_UniformDeflection.cdl | 5 +- src/CSLib/CSLib.cdl | 13 +- src/CSLib/CSLib_Class2d.cdl | 4 + src/ChFi3d/ChFi3d.cdl | 7 +- src/ChFi3d/ChFi3d_ChBuilder.cdl | 2 +- src/ChFi3d/ChFi3d_FilBuilder.cdl | 2 +- src/ChFi3d/ChFi3d_SearchSing.cdl | 3 +- src/ChFiDS/ChFiDS.cdl | 26 +--- src/ChFiDS/ChFiDS_CommonPoint.cdl | 4 +- src/ChFiDS/ChFiDS_Spine.cdl | 2 +- src/ChFiDS/ChFiDS_Stripe.cdl | 2 +- src/ChFiDS/ChFiDS_StripeMap.cdl | 2 +- src/ChFiDS/ChFiDS_SurfData.cdl | 3 +- src/ChFiKPart/ChFiKPart.cdl | 3 - src/Convert/Convert.cdl | 58 ++------- src/Convert/Convert_CompPolynomialToPoles.cdl | 6 +- src/Convert/Convert_GridPolynomialToPoles.cdl | 6 +- src/DBRep/DBRep.cdl | 7 +- src/DBRep/DBRep_DrawableShape.cdl | 3 +- src/DBRep/DBRep_Edge.cdl | 2 +- src/DBRep/DBRep_Face.cdl | 2 +- src/DDF/DDF.cdl | 3 - src/DDF/DDF_Browser.cdl | 2 +- src/DDF/DDF_Data.cdl | 2 +- src/DDataStd/DDataStd.cdl | 7 -- src/DDataStd/DDataStd_DrawDriver.cdl | 3 +- src/Draw/Draw.cdl | 11 +- src/Draw/Draw_Box.cdl | 2 +- src/Draw/Draw_Printer.cdl | 3 +- src/DrawDim/DrawDim.cdl | 9 +- src/DrawDim/DrawDim_Dimension.cdl | 2 +- src/DrawDim/DrawDim_PlanarDimension.cdl | 2 +- src/FEmTool/FEmTool.cdl | 10 +- src/FEmTool/FEmTool_ElementsOfRefMatrix.cdl | 2 +- src/FEmTool/FEmTool_LinearJerk.cdl | 2 +- src/GC/GC.cdl | 19 --- src/GC/GC_MakeScale.cdl | 3 +- src/GC/GC_MakeSegment.cdl | 18 +-- src/GC/GC_MakeTranslation.cdl | 14 +-- src/GCE2d/GCE2d.cdl | 14 --- src/GCE2d/GCE2d_MakeCircle.cdl | 2 +- src/GCE2d/GCE2d_MakeEllipse.cdl | 2 +- src/GProp/GProp.cdl | 26 ---- src/GProp/GProp_SelGProps.cdl | 4 +- src/GProp/GProp_VelGProps.cdl | 6 +- src/GccAna/GccAna.cdl | 25 ---- src/Geom2dAdaptor/Geom2dAdaptor.cdl | 1 - src/Geom2dConvert/Geom2dConvert.cdl | 16 +-- ...eom2dConvert_BSplineCurveKnotSplitting.cdl | 3 +- .../Geom2dConvert_CompCurveToBSplineCurve.cdl | 2 +- src/Geom2dLProp/Geom2dLProp.cdl | 2 - src/GeomAPI/GeomAPI.cdl | 9 +- src/GeomAdaptor/GeomAdaptor.cdl | 6 - src/GeomAdaptor/GeomAdaptor_Curve.cdl | 3 +- src/GeomAdaptor/GeomAdaptor_HSurface.cdl | 1 + src/GeomAdaptor/GeomAdaptor_Surface.cdl | 2 +- src/GeomConvert/GeomConvert.cdl | 34 +----- .../GeomConvert_BSplineCurveKnotSplitting.cdl | 3 +- ...eomConvert_BSplineSurfaceKnotSplitting.cdl | 5 +- ...ert_CompBezierSurfacesToBSplineSurface.cdl | 3 +- .../GeomConvert_CompCurveToBSplineCurve.cdl | 2 +- src/GeomFill/GeomFill.cdl | 70 ++--------- src/GeomFill/GeomFill_BoundWithSurf.cdl | 2 + src/GeomFill/GeomFill_Boundary.cdl | 1 + src/GeomFill/GeomFill_ConstrainedFilling.cdl | 1 + src/GeomFill/GeomFill_CoonsAlgPatch.cdl | 2 +- src/GeomFill/GeomFill_DegeneratedBound.cdl | 5 +- src/GeomFill/GeomFill_Filling.cdl | 2 +- src/GeomFill/GeomFill_Line.cdl | 2 +- src/GeomFill/GeomFill_SimpleBound.cdl | 1 + src/GeomLib/GeomLib.cdl | 23 +--- src/GeomLib/GeomLib_Check2dBSplineCurve.cdl | 5 +- src/GeomLib/GeomLib_CheckBSplineCurve.cdl | 5 +- src/GeomLib/GeomLib_DenominatorMultiplier.cdl | 6 +- src/GeomLib/GeomLib_Tool.cdl | 3 +- src/GeomPlate/GeomPlate.cdl | 20 +--- src/GeomPlate/GeomPlate_BuildAveragePlane.cdl | 2 + src/GeomPlate/GeomPlate_PlateG0Criterion.cdl | 3 +- src/GeomPlate/GeomPlate_PlateG1Criterion.cdl | 3 +- src/GeomTools/GeomTools.cdl | 6 +- src/Graphic3d/Graphic3d.cdl | 39 ------ src/Graphic3d/Graphic3d_ArrayOfPoints.cdl | 1 + src/Graphic3d/Graphic3d_ArrayOfPolygons.cdl | 1 + src/Graphic3d/Graphic3d_ArrayOfPolylines.cdl | 1 + .../Graphic3d_ArrayOfQuadrangleStrips.cdl | 1 + .../Graphic3d_ArrayOfQuadrangles.cdl | 1 + src/Graphic3d/Graphic3d_ArrayOfSegments.cdl | 1 + .../Graphic3d_ArrayOfTriangleFans.cdl | 1 + .../Graphic3d_ArrayOfTriangleStrips.cdl | 1 + src/Graphic3d/Graphic3d_ArrayOfTriangles.cdl | 1 + .../Graphic3d_CGraduatedTrihedron.hxx | 1 + src/Graphic3d/Graphic3d_ClipPlane_Handle.hxx | 1 + src/Graphic3d/Graphic3d_GraphicDriver.cdl | 2 +- src/Graphic3d/Graphic3d_MaterialAspect.cdl | 1 + src/HLRAlgo/HLRAlgo.cdl | 42 ++----- src/HLRAlgo/HLRAlgo_PolyData.cdl | 1 + src/HLRAlgo/HLRAlgo_PolyHidingData.cdl | 1 + src/HLRAlgo/HLRAlgo_PolyInternalData.cdl | 1 + src/HLRAlgo/HLRAlgo_PolyInternalNode.cdl | 1 + src/HLRAlgo/HLRAlgo_PolyInternalSegment.cdl | 1 + src/HLRAlgo/HLRAlgo_PolyShellData.cdl | 1 + src/HLRAlgo/HLRAlgo_Projector.cdl | 1 + src/HLRAlgo/HLRAlgo_TriangleData.cdl | 1 + src/HLRBRep/HLRBRep.cdl | 7 +- src/HLRBRep/HLRBRep_Algo.cdl | 3 +- src/HLRBRep/HLRBRep_PolyAlgo.cdl | 3 +- src/HLRTest/HLRTest.cdl | 5 +- src/HLRTest/HLRTest_DrawableEdgeTool.cdl | 2 +- src/HLRTest/HLRTest_DrawablePolyEdgeTool.cdl | 2 +- src/HLRTest/HLRTest_Projector.cdl | 2 +- src/Hatch/Hatch.cdl | 6 +- src/IGESAppli/IGESAppli.cdl | 66 ----------- src/IGESBasic/IGESBasic.cdl | 53 --------- src/IGESBasic/IGESBasic_OrderedGroup.cdl | 4 +- .../IGESBasic_OrderedGroupWithoutBackP.cdl | 4 +- src/IGESCAFControl/IGESCAFControl.cdl | 1 - src/IGESDefs/IGESDefs.cdl | 29 ----- src/IGESDimen/IGESDimen.cdl | 76 ------------ src/IGESDraw/IGESDraw.cdl | 62 ---------- src/IGESGeom/IGESGeom.cdl | 46 ------- src/IGESGraph/IGESGraph.cdl | 53 --------- src/IGESSolid/IGESSolid.cdl | 75 ------------ src/IGESSolid/IGESSolid_EdgeList.cdl | 1 + src/IGESSolid/IGESSolid_VertexList.cdl | 1 + src/IntCurve/IntCurve.cdl | 6 +- src/IntCurve/IntCurve_IntConicCurveGen.cdl | 2 +- src/IntPatch/IntPatch.cdl | 3 - .../IntPatch_InterferencePolyhedron.cdl | 3 +- src/IntPolyh/IntPolyh.cdl | 9 +- src/IntPolyh/IntPolyh_Couple.cdl | 2 +- src/IntPolyh/IntPolyh_Intersection.cdl | 7 +- src/IntPolyh/IntPolyh_MaillageAffinage.cdl | 2 +- src/IntTools/IntTools.cdl | 39 ++---- src/IntTools/IntTools_BaseRangeSample.cdl | 2 +- src/IntTools/IntTools_Curve.cdl | 4 +- src/IntTools/IntTools_CurveRangeSample.cdl | 2 + .../IntTools_CurveRangeSampleMapHasher.cdl | 1 + src/IntTools/IntTools_LineConstructor.cdl | 2 + src/IntTools/IntTools_SurfaceRangeSample.cdl | 2 + src/IntWalk/IntWalk.cdl | 4 +- src/IntWalk/IntWalk_VectorOfInteger.hxx | 2 + src/IntWalk/IntWalk_VectorOfWalkingData.hxx | 2 + src/Intf/Intf.cdl | 16 --- src/Intf/Intf_Interference.cdl | 4 +- src/Intf/Intf_Polygon2d.cdl | 3 +- src/LProp/LProp.cdl | 11 +- src/LocalAnalysis/LocalAnalysis.cdl | 6 +- src/MAT/MAT.cdl | 12 +- src/MAT/MAT_Node.cdl | 2 +- src/MAT2d/MAT2d.cdl | 22 +--- src/MAT2d/MAT2d_Circuit.cdl | 3 +- src/MAT2d/MAT2d_SketchExplorer.cdl | 1 + src/MDF/MDF.cdl | 4 +- src/MDataStd/MDataStd.cdl | 8 +- src/MDataXtd/MDataXtd.cdl | 8 +- src/MDocStd/MDocStd.cdl | 8 +- src/MMgt/MMgt.cdl | 2 - src/MMgt/MMgt_TShared.cdl | 2 + src/MPrsStd/MPrsStd.cdl | 8 +- ...MPrsStd_AISPresentationRetrievalDriver.cdl | 3 +- ...rsStd_AISPresentationRetrievalDriver_1.cdl | 3 +- .../MPrsStd_AISPresentationStorageDriver.cdl | 3 +- .../MPrsStd_PositionRetrievalDriver.cdl | 4 +- src/MPrsStd/MPrsStd_PositionStorageDriver.cdl | 3 +- src/MeshVS/MeshVS.cdl | 12 +- src/Message/Message.cdl | 15 +-- src/MgtBRep/MgtBRep.cdl | 6 +- src/MgtBRep/MgtBRep_TranslateTool.cdl | 1 + src/MgtBRep/MgtBRep_TranslateTool1.cdl | 1 + src/MgtTopoDS/MgtTopoDS.cdl | 4 - src/MgtTopoDS/MgtTopoDS_TranslateTool.cdl | 2 +- src/MgtTopoDS/MgtTopoDS_TranslateTool1.cdl | 2 +- src/OSD/OSD.cdl | 28 ----- src/OSD/OSD_Directory.cdl | 2 +- src/OSD/OSD_Disk.cdl | 2 +- src/OSD/OSD_Error.cdl | 2 +- src/OSD/OSD_FileNode.cdl | 2 +- src/OSD/OSD_Function.hxx | 3 + src/OSD/OSD_Host.cdl | 1 + src/OSD/OSD_Printer.cdl | 2 +- src/OSD/OSD_SharedLibrary.cdl | 2 + src/ObjMgt/ObjMgt.cdl | 6 +- src/ObjMgt/ObjMgt_ExternRef.cdl | 1 + src/ObjMgt/ObjMgt_ExternShareable.cdl | 2 + src/PBRep/PBRep.cdl | 58 ++------- src/PBRep/PBRep_GCurve.cdl | 1 + src/PBRep/PBRep_PointOnCurve.cdl | 2 +- src/PBRep/PBRep_PointOnCurveOnSurface.cdl | 3 +- src/PBRep/PBRep_PointOnSurface.cdl | 2 +- src/PBRep/PBRep_PointsOnSurface.cdl | 2 +- src/PBRep/PBRep_Polygon3D.cdl | 2 +- src/PCollection/PCollection.cdl | 4 - src/PCollection/PCollection_HSequence.cdl | 3 +- src/PDataStd/PDataStd.cdl | 12 +- src/PDataXtd/PDataXtd.cdl | 4 +- src/PMMgt/PMMgt.cdl | 5 - src/PMMgt/PMMgt_PManaged.cdl | 6 +- src/PPoly/PPoly.cdl | 19 +-- src/PPoly/PPoly_Triangulation.cdl | 3 +- src/PTopLoc/PTopLoc.cdl | 10 +- src/PTopoDS/PTopoDS.cdl | 112 ++++-------------- src/PTopoDS/PTopoDS_CompSolid.cdl | 4 +- src/PTopoDS/PTopoDS_Compound.cdl | 4 +- src/PTopoDS/PTopoDS_Edge.cdl | 4 +- src/PTopoDS/PTopoDS_Face.cdl | 4 +- src/PTopoDS/PTopoDS_Shell.cdl | 4 +- src/PTopoDS/PTopoDS_Solid.cdl | 4 +- src/PTopoDS/PTopoDS_TCompSolid.cdl | 2 +- src/PTopoDS/PTopoDS_TCompSolid1.cdl | 2 +- src/PTopoDS/PTopoDS_TEdge.cdl | 4 +- src/PTopoDS/PTopoDS_TEdge1.cdl | 3 +- src/PTopoDS/PTopoDS_TFace.cdl | 3 +- src/PTopoDS/PTopoDS_TFace1.cdl | 3 +- src/PTopoDS/PTopoDS_TShape.cdl | 3 +- src/PTopoDS/PTopoDS_TShape1.cdl | 4 +- src/PTopoDS/PTopoDS_TShell.cdl | 3 +- src/PTopoDS/PTopoDS_TShell1.cdl | 3 +- src/PTopoDS/PTopoDS_TSolid.cdl | 5 +- src/PTopoDS/PTopoDS_TSolid1.cdl | 3 +- src/PTopoDS/PTopoDS_TVertex.cdl | 3 +- src/PTopoDS/PTopoDS_TVertex1.cdl | 2 +- src/PTopoDS/PTopoDS_TWire.cdl | 3 +- src/PTopoDS/PTopoDS_TWire1.cdl | 6 +- src/PTopoDS/PTopoDS_Vertex.cdl | 4 +- src/PTopoDS/PTopoDS_Wire.cdl | 4 +- src/Poly/Poly.cdl | 16 --- src/Poly/Poly_Triangulation.cdl | 1 + src/ProjLib/ProjLib.cdl | 29 +---- src/ProjLib/ProjLib_ComputeApprox.cdl | 4 +- .../ProjLib_ComputeApproxOnPolarSurface.cdl | 6 +- src/ProjLib/ProjLib_ProjectOnSurface.cdl | 3 +- src/ProjLib/ProjLib_ProjectedCurve.cdl | 5 +- src/Prs3d/Prs3d.cdl | 26 +--- src/Prs3d/Prs3d_BasicAspect.cdl | 4 +- src/Prs3d/Prs3d_Drawer.cdl | 2 + src/Prs3d/Prs3d_PlaneSet.cdl | 3 + src/Prs3d/Prs3d_Presentation.cdl | 1 + src/Prs3d/Prs3d_ShapeTool.cdl | 4 +- src/QANewModTopOpe/QANewModTopOpe.cdl | 6 +- src/QANewModTopOpe/QANewModTopOpe_Glue.cdl | 3 +- src/QANewModTopOpe/QANewModTopOpe_Tools.cdl | 2 + src/Quantity/Quantity.cdl | 11 -- src/RWStepBasic/RWStepBasic.cdl | 2 +- src/RWStepGeom/RWStepGeom.cdl | 2 +- src/RWStepRepr/RWStepRepr.cdl | 2 +- src/RWStepShape/RWStepShape.cdl | 2 +- src/RWStepVisual/RWStepVisual.cdl | 2 +- src/Resource/Resource.cdl | 1 - src/STEPCAFControl/STEPCAFControl.cdl | 8 +- src/STEPConstruct/STEPConstruct.cdl | 25 ++-- src/STEPConstruct/STEPConstruct_Assembly.cdl | 2 +- .../STEPConstruct_ContextTool.cdl | 3 +- src/SWDRAW/SWDRAW.cdl | 11 +- src/SelectBasics/SelectBasics.cdl | 5 - src/SelectBasics/SelectBasics_BasicTool.cdl | 3 +- src/SelectBasics/SelectBasics_SortAlgo.cdl | 1 + src/SelectMgr/SelectMgr.cdl | 27 +---- src/SelectMgr/SelectMgr_CompareResults.hxx | 3 + src/ShapeAlgo/ShapeAlgo.cdl | 1 - src/ShapeAlgo/ShapeAlgo_ToolContainer.cdl | 2 +- src/ShapeAnalysis/ShapeAnalysis.cdl | 70 ++++------- .../ShapeAnalysis_CheckSmallFace.cdl | 2 +- .../ShapeAnalysis_ShapeContents.cdl | 2 +- src/ShapeBuild/ShapeBuild.cdl | 6 +- src/ShapeConstruct/ShapeConstruct.cdl | 7 +- src/ShapeExtend/ShapeExtend.cdl | 13 +- src/ShapeFix/ShapeFix.cdl | 37 ++---- src/ShapeFix/ShapeFix_EdgeConnect.cdl | 3 +- src/ShapeFix/ShapeFix_FaceConnect.cdl | 2 +- src/ShapeFix/ShapeFix_FixSmallFace.cdl | 2 +- src/ShapeFix/ShapeFix_WireSegment.cdl | 2 +- src/ShapeFix/ShapeFix_WireVertex.cdl | 3 +- src/ShapeProcess/ShapeProcess.cdl | 7 +- src/ShapeProcessAPI/ShapeProcessAPI.cdl | 3 +- src/ShapeUpgrade/ShapeUpgrade.cdl | 15 +-- .../ShapeUpgrade_ShapeDivideAngle.cdl | 2 +- .../ShapeUpgrade_ShapeDivideContinuity.cdl | 2 +- src/SortTools/SortTools.cdl | 4 - src/StdPrs/StdPrs.cdl | 58 ++------- src/StdPrs/StdPrs_HLRPolyShape.cdl | 1 + src/StdPrs/StdPrs_HLRShape.hxx | 4 + src/StdPrs/StdPrs_Point.hxx | 2 +- src/StdPrs/StdPrs_PoleCurve.cdl | 6 +- src/StdPrs/StdPrs_ShadedSurface.cdl | 9 +- .../StdPrs_WFDeflectionRestrictedFace.cdl | 5 + src/StdPrs/StdPrs_WFDeflectionShape.hxx | 3 + src/StdPrs/StdPrs_WFPoleSurface.cdl | 7 +- src/StdPrs/StdPrs_WFRestrictedFace.hxx | 6 + src/StdPrs/StdPrs_WFSurface.cdl | 4 + src/StdSelect/StdSelect.cdl | 13 +- src/StdSelect/StdSelect_BRepOwner.cdl | 2 + src/StdSelect/StdSelect_ViewerSelector3d.cdl | 1 + src/StepAP209/StepAP209.cdl | 3 +- src/StepBasic/StepBasic.cdl | 1 - src/StepGeom/StepGeom.cdl | 1 - src/StepRepr/StepRepr.cdl | 1 - src/StepShape/StepShape.cdl | 1 - src/StepVisual/StepVisual.cdl | 1 - src/StlMesh/StlMesh.cdl | 16 --- src/StlMesh/StlMesh_MeshDomain.cdl | 6 +- src/Storage/Storage.cdl | 1 - src/Sweep/Sweep.cdl | 9 +- src/TCollection/TCollection.cdl | 30 ++--- src/TCollection/TCollection_MapNode.cdl | 1 + src/TDF/TDF.cdl | 48 +------- src/TDF/TDF_Attribute.cdl | 4 +- src/TDF/TDF_AttributeIterator.hxx | 2 + src/TDF/TDF_ClosureTool.cdl | 4 +- src/TDF/TDF_CopyLabel.cdl | 2 +- src/TDF/TDF_Delta.cdl | 8 +- src/TDF/TDF_LabelMapHasher.cdl | 2 +- src/TDF/TDF_Reference.cdl | 3 +- src/TDF/TDF_RelocationTable.cdl | 3 +- src/TDataStd/TDataStd.cdl | 2 +- src/TDataXtd/TDataXtd.cdl | 8 +- src/TDataXtd/TDataXtd_PatternStd.cdl | 4 +- src/TDocStd/TDocStd.cdl | 35 ++---- src/TDocStd/TDocStd_Owner.cdl | 5 +- src/TDocStd/TDocStd_XLinkIterator.cdl | 2 + src/TDocStd/TDocStd_XLinkTool.cdl | 2 + src/TNaming/TNaming.cdl | 28 +---- src/TNaming/TNaming_Name.cdl | 2 +- src/TNaming/TNaming_TranslateTool.cdl | 7 +- src/TNaming/TNaming_Translator.cdl | 2 +- src/TNaming/TNaming_UsedShapes.cdl | 4 +- src/TopAbs/TopAbs.cdl | 7 +- src/TopBas/TopBas.cdl | 2 - src/TopClass/TopClass.cdl | 20 +--- src/TopClass/TopClass_Classifier2d.cdl | 2 +- src/TopClass/TopClass_Classifier3d.cdl | 2 +- src/TopClass/TopClass_SolidExplorer.cdl | 3 +- src/TopCnx/TopCnx.cdl | 2 - src/TopLoc/TopLoc.cdl | 5 - src/TopOpeBRep/TopOpeBRep.cdl | 7 +- .../TopOpeBRep_EdgesIntersector.cdl | 1 + .../TopOpeBRep_FaceEdgeIntersector.cdl | 2 +- .../TopOpeBRep_FacesIntersector.cdl | 2 +- src/TopOpeBRepDS/TopOpeBRepDS.cdl | 19 ++- src/TopOpeBRepDS/TopOpeBRepDS_Curve.cdl | 2 +- .../TopOpeBRepDS_EdgeVertexInterference.cdl | 2 +- .../TopOpeBRepDS_FaceEdgeInterference.cdl | 1 + .../TopOpeBRepDS_ShapeShapeInterference.cdl | 2 +- .../TopOpeBRepDS_SolidSurfaceInterference.cdl | 2 +- src/TopOpeBRepDS/TopOpeBRepDS_Surface.cdl | 2 +- src/TopOpeBRepTool/TopOpeBRepTool.cdl | 2 - src/TopTools/TopTools.cdl | 1 - src/TopoDS/TopoDS.cdl | 33 ------ src/TopoDS/TopoDS_Builder.cdl | 2 +- src/TopoDS/TopoDS_CompSolid.cdl | 1 + src/TopoDS/TopoDS_Compound.cdl | 1 + src/TopoDS/TopoDS_TCompSolid.cdl | 1 + src/TopoDS/TopoDS_TCompound.cdl | 1 + src/TopoDS/TopoDS_TEdge.cdl | 2 + src/TopoDS/TopoDS_TFace.cdl | 3 + src/TopoDS/TopoDS_TShape.cdl | 4 + src/TopoDS/TopoDS_TShell.cdl | 1 + src/TopoDS/TopoDS_TSolid.cdl | 2 + src/TopoDS/TopoDS_TVertex.cdl | 2 + src/TopoDS/TopoDS_TWire.cdl | 1 + src/V3d/V3d.cdl | 11 -- src/V3d/V3d_Light.cdl | 2 +- src/V3d/V3d_PositionalLight.cdl | 2 +- src/V3d/V3d_View.cdl | 1 + src/ViewerTest/ViewerTest.cdl | 3 - src/ViewerTest/ViewerTest_EventManager.cdl | 4 +- src/Visual3d/Visual3d.cdl | 32 ----- src/Vrml/Vrml.cdl | 13 +- src/VrmlAPI/VrmlAPI.cdl | 22 ++-- src/VrmlConverter/VrmlConverter.cdl | 69 ++--------- .../VrmlConverter_PointAspect.cdl | 2 +- src/WNT/WNT.cdl | 5 - src/WNT/WNT_Dword.hxx | 2 + src/WNT/WNT_Uint.hxx | 2 + src/WNT/WNT_WindowData.hxx | 2 + src/XCAFApp/XCAFApp.cdl | 3 +- src/XCAFDoc/XCAFDoc.cdl | 28 +---- src/XCAFDoc/XCAFDoc_Area.cdl | 2 +- src/XCAFDoc/XCAFDoc_Centroid.cdl | 2 +- src/XCAFDoc/XCAFDoc_Color.cdl | 2 +- src/XCAFDoc/XCAFDoc_ColorTool.cdl | 1 + src/XCAFDoc/XCAFDoc_Datum.cdl | 2 +- src/XCAFDoc/XCAFDoc_DimTol.cdl | 2 +- src/XCAFDoc/XCAFDoc_DimTolTool.cdl | 5 +- src/XCAFDoc/XCAFDoc_DocumentTool.cdl | 3 +- src/XCAFDoc/XCAFDoc_GraphNode.cdl | 4 +- src/XCAFDoc/XCAFDoc_LayerTool.cdl | 2 +- src/XCAFDoc/XCAFDoc_Location.cdl | 2 +- src/XCAFDoc/XCAFDoc_Material.cdl | 2 + src/XCAFDoc/XCAFDoc_MaterialTool.cdl | 1 + src/XCAFDoc/XCAFDoc_ShapeMapTool.cdl | 1 + src/XCAFDoc/XCAFDoc_ShapeTool.cdl | 2 + src/XCAFDoc/XCAFDoc_Volume.cdl | 2 +- src/XCAFPrs/XCAFPrs.cdl | 3 - src/XDEDRAW/XDEDRAW.cdl | 6 +- src/XDEDRAW/XDEDRAW_Shapes.cdl | 2 +- src/XSAlgo/XSAlgo.cdl | 1 - src/XSAlgo/XSAlgo_ToolContainer.cdl | 2 +- src/XSDRAW/XSDRAW.cdl | 5 - src/XmlMDF/XmlMDF.cdl | 2 +- src/XmlMDataStd/XmlMDataStd.cdl | 2 +- src/XmlMDataXtd/XmlMDataXtd.cdl | 2 +- src/XmlObjMgt/XmlObjMgt.cdl | 2 - src/XmlObjMgt/XmlObjMgt_Persistent.cdl | 1 + src/gce/gce.cdl | 61 +--------- src/gce/gce_MakePln.cdl | 2 +- src/gp/gp.cdl | 57 +-------- src/gp/gp_Trsf.cdl | 2 +- src/gp/gp_Trsf2d.cdl | 2 +- 533 files changed, 1047 insertions(+), 2921 deletions(-) diff --git a/src/Adaptor2d/Adaptor2d.cdl b/src/Adaptor2d/Adaptor2d.cdl index 7a616394a4..2563f42bbe 100644 --- a/src/Adaptor2d/Adaptor2d.cdl +++ b/src/Adaptor2d/Adaptor2d.cdl @@ -134,17 +134,13 @@ uses is deferred class Curve2d; - ---Purpose: Root of the 2d curve. pointer Curve2dPtr to Curve2d from Adaptor2d; deferred class HCurve2d; - ---Purpose: deferred class for the 2d curves manipulated with - -- Handle. generic class GenHCurve2d; - ---Purpose: Generic class used to create a curve inheriting - -- from HCurve2d. + diff --git a/src/Adaptor3d/Adaptor3d.cdl b/src/Adaptor3d/Adaptor3d.cdl index f9c2f95649..2f2873d82c 100644 --- a/src/Adaptor3d/Adaptor3d.cdl +++ b/src/Adaptor3d/Adaptor3d.cdl @@ -139,31 +139,20 @@ uses is deferred class Curve; - ---Purpose: Root of the 3d curve. pointer CurvePtr to Curve from Adaptor3d; deferred class HCurve; - ---Purpose: deferred class for the curves manipulated with - -- Handle. generic class GenHCurve; - ---Purpose: Generic class used to create a curve inheriting - -- from HCurve. - deferred class Surface; - ---Purpose: Root of the surface. pointer SurfacePtr to Surface from Adaptor3d; deferred class HSurface; - ---Purpose: deferred class for the surfaces manipulated with - -- Handle. generic class GenHSurface; - ---Purpose: Generic class used to create a surface inheriting - -- from HSurface. -- @@ -188,15 +177,12 @@ is class IsoCurve; - ---Purpose: Algorithmic 3d curv, isoparametric on a surface. class HIsoCurve instantiates GenHCurve from Adaptor3d (IsoCurve from Adaptor3d); class CurveOnSurface; - ---Purpose: Algorithmic 3d curve from a surface and a 2d curve - -- in the parameter space. pointer CurveOnSurfacePtr to CurveOnSurface from Adaptor3d; @@ -206,16 +192,11 @@ is class OffsetCurve; - ---Purpose: Algorithmic 2d curve. - class HOffsetCurve instantiates GenHCurve2d from Adaptor2d + class HOffsetCurve instantiates GenHCurve2d from Adaptor2d (OffsetCurve from Adaptor3d); - - + class SurfaceOfRevolution; - ---Purpose: Algorithmic Surface from a Curve and an Axis - -- Curve and Axis are coplanar. - -- Curve doesn't intersect Axis. class HSurfaceOfRevolution instantiates GenHSurface from Adaptor3d (SurfaceOfRevolution from Adaptor3d); @@ -223,13 +204,10 @@ is class SurfaceOfLinearExtrusion; - ---Purpose: Algorithmic Surface from a curve and a direction class HSurfaceOfLinearExtrusion instantiates GenHSurface from Adaptor3d (SurfaceOfLinearExtrusion from Adaptor3d); private class InterFunc; - ---Purpose: function to find the Cn discontinuity point. Used to - -- find the roots of the functions end Adaptor3d; diff --git a/src/Adaptor3d/Adaptor3d_InterFunc.cdl b/src/Adaptor3d/Adaptor3d_InterFunc.cdl index c4b8f30e90..0a076b89ea 100644 --- a/src/Adaptor3d/Adaptor3d_InterFunc.cdl +++ b/src/Adaptor3d/Adaptor3d_InterFunc.cdl @@ -19,7 +19,8 @@ private class InterFunc from Adaptor3d inherits FunctionWithDerivative fr ---Purpose: Used to find the points U(t) = U0 or V(t) = V0 in -- order to determine the Cn discontinuities of an -- Adpator_CurveOnSurface relativly to the - -- discontinuities of the surface. + -- discontinuities of the surface. Used to + -- find the roots of the functions uses HCurve2d from Adaptor2d diff --git a/src/Adaptor3d/Adaptor3d_OffsetCurve.cdl b/src/Adaptor3d/Adaptor3d_OffsetCurve.cdl index c97cd80c7b..e9727be660 100644 --- a/src/Adaptor3d/Adaptor3d_OffsetCurve.cdl +++ b/src/Adaptor3d/Adaptor3d_OffsetCurve.cdl @@ -16,7 +16,7 @@ class OffsetCurve from Adaptor3d inherits Curve2d from Adaptor2d - ---Purpose: Defines an Offset curve. + ---Purpose: Defines an Offset curve (algorithmic 2d curve). -- uses diff --git a/src/Adaptor3d/Adaptor3d_SurfaceOfRevolution.cdl b/src/Adaptor3d/Adaptor3d_SurfaceOfRevolution.cdl index 18604d64f6..9875cd518e 100644 --- a/src/Adaptor3d/Adaptor3d_SurfaceOfRevolution.cdl +++ b/src/Adaptor3d/Adaptor3d_SurfaceOfRevolution.cdl @@ -33,6 +33,8 @@ class SurfaceOfRevolution from Adaptor3d inherits Surface from Adaptor3d -- The derivatives are always defined for the u direction. -- For the v direction the definition of the derivatives depends on -- the degree of continuity of the referenced curve. + -- Curve and Axis are coplanar. + -- Curve doesn't intersect Axis. diff --git a/src/AdvApp2Var/AdvApp2Var.cdl b/src/AdvApp2Var/AdvApp2Var.cdl index 5df716ee08..f74fc0d98f 100644 --- a/src/AdvApp2Var/AdvApp2Var.cdl +++ b/src/AdvApp2Var/AdvApp2Var.cdl @@ -77,28 +77,11 @@ is -- class ApproxAFunc2Var from AdvApp2Var ; - ---Purpose: - -- this class approximates a given function of 2 variables imported EvaluatorFunc2Var ; - ---Purpose: - -- typedef void (*EvaluatorFunc2Var) ( - -- Standard_Integer * -- dimension - -- Standard_Real * -- first and last parameters in U - -- Standard_Real * -- first and last parameters in V - -- Standard_Integer * -- choice of constante, 1 for U, 2 for V - -- Standard_Real * -- value of constant parameter - -- Standard_Integer * -- number of parameters - -- Standard_Real * -- values of parameters - -- Standard_Integer * -- order of derivation in U - -- Standard_Integer * -- order of derivation in V - -- Standard_Real * -- evaluation - -- Standard_Integer * -- error code - -- ) ; deferred class Criterion from AdvApp2Var ; - ---Purpose: - -- this class contains a given criterion to be satisfied + -- @@ -109,25 +92,12 @@ is -- Basic Data class Context from AdvApp2Var; - ---Purpose : - -- contains all the parameters for approximation - -- ( tolerancy, computing option, ...) - -- class Node from AdvApp2Var; - ---Purpose : - -- used to store constraints on a (Ui,Vj) point - -- class Iso from AdvApp2Var; - ---Purpose : - -- used to store constraints on a line U = Ui or V = Vj - -- class Patch from AdvApp2Var; - ---Purpose : - -- used to store results on a domain [Ui,Ui+1]x[Vj,Vj+1] - -- class Strip from AdvApp2Var instantiates Sequence from TCollection (Iso from AdvApp2Var); diff --git a/src/AdvApp2Var/AdvApp2Var_Context.cdl b/src/AdvApp2Var/AdvApp2Var_Context.cdl index 06cfdd6809..5fe426a7f4 100644 --- a/src/AdvApp2Var/AdvApp2Var_Context.cdl +++ b/src/AdvApp2Var/AdvApp2Var_Context.cdl @@ -20,6 +20,9 @@ class Context from AdvApp2Var + ---Purpose : + -- contains all the parameters for approximation + -- ( tolerancy, computing option, ...) uses HArray1OfReal from TColStd, diff --git a/src/AdvApp2Var/AdvApp2Var_Criterion.cdl b/src/AdvApp2Var/AdvApp2Var_Criterion.cdl index ee99d095bd..df404528b1 100644 --- a/src/AdvApp2Var/AdvApp2Var_Criterion.cdl +++ b/src/AdvApp2Var/AdvApp2Var_Criterion.cdl @@ -15,6 +15,8 @@ -- commercial license or contractual agreement. deferred class Criterion from AdvApp2Var + ---Purpose: + -- this class contains a given criterion to be satisfied uses Patch,Context from AdvApp2Var, diff --git a/src/AdvApp2Var/AdvApp2Var_EvaluatorFunc2Var.hxx b/src/AdvApp2Var/AdvApp2Var_EvaluatorFunc2Var.hxx index c4b391a383..46366dc44c 100644 --- a/src/AdvApp2Var/AdvApp2Var_EvaluatorFunc2Var.hxx +++ b/src/AdvApp2Var/AdvApp2Var_EvaluatorFunc2Var.hxx @@ -35,8 +35,8 @@ public: //! Function evaluation method to be defined by descendant virtual void Evaluate (Standard_Integer* theDimension, - Standard_Real* theUStartEnd, - Standard_Real* theVStartEnd, + Standard_Real* theUStartEnd, //!< First and last parameters in U + Standard_Real* theVStartEnd, //!< First and last parameters in V Standard_Integer* theFavorIso, //!< Choice of constante, 1 for U, 2 for V Standard_Real* theConstParam, //!< Value of constant parameter Standard_Integer* theNbParams, //!< Number of parameters N diff --git a/src/AdvApp2Var/AdvApp2Var_Iso.cdl b/src/AdvApp2Var/AdvApp2Var_Iso.cdl index 1da3fa88d9..b720a302e9 100644 --- a/src/AdvApp2Var/AdvApp2Var_Iso.cdl +++ b/src/AdvApp2Var/AdvApp2Var_Iso.cdl @@ -15,6 +15,9 @@ -- commercial license or contractual agreement. class Iso from AdvApp2Var + ---Purpose : + -- used to store constraints on a line U = Ui or V = Vj + -- uses diff --git a/src/AdvApp2Var/AdvApp2Var_Node.cdl b/src/AdvApp2Var/AdvApp2Var_Node.cdl index ecc9e1a340..2852348e53 100644 --- a/src/AdvApp2Var/AdvApp2Var_Node.cdl +++ b/src/AdvApp2Var/AdvApp2Var_Node.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Node from AdvApp2Var - + ---Purpose : + -- used to store constraints on a (Ui,Vj) point + -- uses XY,Pnt from gp, diff --git a/src/AdvApp2Var/AdvApp2Var_Patch.cdl b/src/AdvApp2Var/AdvApp2Var_Patch.cdl index 1d1afec5ef..f2ec01e41b 100644 --- a/src/AdvApp2Var/AdvApp2Var_Patch.cdl +++ b/src/AdvApp2Var/AdvApp2Var_Patch.cdl @@ -21,6 +21,9 @@ -- Field 'myCritValue' class Patch from AdvApp2Var + ---Purpose : + -- used to store results on a domain [Ui,Ui+1]x[Vj,Vj+1] + -- uses diff --git a/src/AdvApprox/AdvApprox.cdl b/src/AdvApprox/AdvApprox.cdl index 132f454fc3..9d759bb43d 100644 --- a/src/AdvApprox/AdvApprox.cdl +++ b/src/AdvApprox/AdvApprox.cdl @@ -36,42 +36,18 @@ is class ApproxAFunction from AdvApprox ; - ---Purpose: - -- this approximate a given function - class SimpleApprox; + class SimpleApprox; -- class ApproxAFunction; imported EvaluatorFunction ; - ---Purpose: - -- typedef void (*EvaluatorFunction) ( - -- Standard_Integer * - -- Standard_Real * - -- Standard_Real * - -- Standard_Integer * - -- Standard_Real * - -- Standard_Integer *) ; - deferred class Cutting; - ---Purpose : - -- this class is used to choose the way of cutting if needed class DichoCutting; - ---Purpose : - -- inherits class Cutting; - -- if Cutting is necessary in [a,b], we cut at (a+b) / 2. - -- class PrefCutting; - ---Purpose : - -- inherits class Cutting; contains a list of preferential points (di)i - -- if Cutting is necessary in [a,b], we cut at the di nearest from (a+b)/2. - + class PrefAndRec; - ---Purpose : - -- inherits class Cutting; contains two lists of preferential points to - -- manage to level of preferential cutting. - -- if Cutting is necessary in [a,b], we cut at the di nearest from (a+b)/2 end AdvApprox; diff --git a/src/AdvApprox/AdvApprox_ApproxAFunction.cdl b/src/AdvApprox/AdvApprox_ApproxAFunction.cdl index 15875ce951..db667f73c8 100644 --- a/src/AdvApprox/AdvApprox_ApproxAFunction.cdl +++ b/src/AdvApprox/AdvApprox_ApproxAFunction.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class ApproxAFunction from AdvApprox - + ---Purpose: + -- this approximate a given function uses Array1OfInteger from TColStd, Vector from math, HArray1OfInteger from TColStd, diff --git a/src/AdvApprox/AdvApprox_PrefAndRec.cdl b/src/AdvApprox/AdvApprox_PrefAndRec.cdl index 8d5238de26..76715b2afb 100644 --- a/src/AdvApprox/AdvApprox_PrefAndRec.cdl +++ b/src/AdvApprox/AdvApprox_PrefAndRec.cdl @@ -19,6 +19,7 @@ class PrefAndRec from AdvApprox inherits Cutting from AdvApprox ---Purpose : -- inherits class Cutting; contains a list of preferential points (pi)i -- and a list of Recommended points used in cutting management. + -- if Cutting is necessary in [a,b], we cut at the di nearest from (a+b)/2 uses Array1OfReal from TColStd diff --git a/src/AppCont/AppCont.cdl b/src/AppCont/AppCont.cdl index 984daa036b..ed401f3b76 100644 --- a/src/AppCont/AppCont.cdl +++ b/src/AppCont/AppCont.cdl @@ -41,28 +41,16 @@ is ------------------------------- --- Algorithms: ------------------------------- - - ---Purpose: The two following algorithms are using the same recipe: - -- Minimizing the difference between the approximate result - -- Curve or Surface and respectively a continous MultiLine - -- or a continous surface. generic class LeastSquare; - ---Purpose: makes an approximation of a continous Line described by - -- the tool TheLineTool. ------------------------------------------------------ --- Necessary class for approximation a function f(t): ------------------------------------------------------ deferred class Function; - ---Purpose: This class must be provided by the user to use the - -- approximation algorithm FittingCurve. - class FunctionTool; - ---Purpose: This class is the inteface between the Function - -- class and the tool asked by LeastSquare. --------------------------------------------------------- @@ -70,14 +58,8 @@ is --------------------------------------------------------- deferred class Function2d; - ---Purpose: This class must be provided by the user to use the - -- approximation algorithm FittingCurve2d. - class FunctionTool2d; - ---Purpose: This class is the inteface between the Function2d - -- class and the tool asked by LeastSquare. - class FitFunction instantiates LeastSquare from AppCont diff --git a/src/AppCont/AppCont_Function.cdl b/src/AppCont/AppCont_Function.cdl index aa44a72db0..d24ea7bea9 100644 --- a/src/AppCont/AppCont_Function.cdl +++ b/src/AppCont/AppCont_Function.cdl @@ -17,7 +17,8 @@ deferred class Function from AppCont ---Purpose: deferred class describing a continous 3d function f(u) - + -- This class must be provided by the user to use the + -- approximation algorithm FittingCurve. uses Pnt from gp, Vec from gp diff --git a/src/AppCont/AppCont_Function2d.cdl b/src/AppCont/AppCont_Function2d.cdl index d71a4c89c3..deaa717710 100644 --- a/src/AppCont/AppCont_Function2d.cdl +++ b/src/AppCont/AppCont_Function2d.cdl @@ -17,7 +17,8 @@ deferred class Function2d from AppCont ---Purpose: deferred class describing a continous 2d function f(u) - + -- This class must be provided by the user to use the + -- approximation algorithm FittingCurve2d. uses Pnt2d from gp, Vec2d from gp diff --git a/src/AppCont/AppCont_FunctionTool.cdl b/src/AppCont/AppCont_FunctionTool.cdl index 258f2d6b61..d7f21392f2 100644 --- a/src/AppCont/AppCont_FunctionTool.cdl +++ b/src/AppCont/AppCont_FunctionTool.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class FunctionTool from AppCont - + ---Purpose: This class is the inteface between the Function + -- class and the tool asked by LeastSquare. uses Function from AppCont, Pnt from gp, diff --git a/src/AppCont/AppCont_FunctionTool2d.cdl b/src/AppCont/AppCont_FunctionTool2d.cdl index 8c68dab32b..7ecf8daa23 100644 --- a/src/AppCont/AppCont_FunctionTool2d.cdl +++ b/src/AppCont/AppCont_FunctionTool2d.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class FunctionTool2d from AppCont - + ---Purpose: This class is the inteface between the Function2d + -- class and the tool asked by LeastSquare. uses Function2d from AppCont, Pnt from gp, diff --git a/src/AppCont/AppCont_LeastSquare.cdl b/src/AppCont/AppCont_LeastSquare.cdl index 9eb7e1462c..483448a640 100644 --- a/src/AppCont/AppCont_LeastSquare.cdl +++ b/src/AppCont/AppCont_LeastSquare.cdl @@ -18,8 +18,10 @@ generic class LeastSquare from AppCont(MultiLine as any; LineTool as any) ---as TheToolLine(MultiLine) - ---Purpose: - + ---Purpose: Makes an approximation of a continous Line described by + -- the tool TheLineTool. + -- Minimizing the difference between the approximate result + -- Curve and a continous MultiLine uses Matrix from math, Vector from math, diff --git a/src/AppDef/AppDef.cdl b/src/AppDef/AppDef.cdl index 39d3dfe8eb..b2f1c2e2b9 100644 --- a/src/AppDef/AppDef.cdl +++ b/src/AppDef/AppDef.cdl @@ -43,25 +43,16 @@ uses AppParCurves, Approx, gp, TColgp, TCollection, Standard, MMgt, math, FEmToo is class MultiPointConstraint; - ---Purpose: a MultiPointConstraint is a set of points which have the same range - -- in the MultiLine and the same constraints. - class MultiLine; - ---Purpose: this is the organized set of points. class MyLineTool; - ---Purpose: example of MultiLine tool corresponding to the tools of the packages - -- AppParCurves and Approx. For Approx, the tool will not addd points - -- if the algorithms want some. deferred class SmoothCriterion; class LinearCriteria; class Variational; - ---Purpose: computes the approximation of a Multiline by - -- Variational optimization. --- Classes instanciees: diff --git a/src/AppDef/AppDef_MyLineTool.cdl b/src/AppDef/AppDef_MyLineTool.cdl index 844f0bf2df..f8ef4f689e 100644 --- a/src/AppDef/AppDef_MyLineTool.cdl +++ b/src/AppDef/AppDef_MyLineTool.cdl @@ -15,6 +15,9 @@ -- commercial license or contractual agreement. class MyLineTool from AppDef + ---Purpose: example of MultiLine tool corresponding to the tools of the packages + -- AppParCurves and Approx. For Approx, the tool will not addd points + -- if the algorithms want some. uses MultiLine from AppDef, Pnt from gp, diff --git a/src/AppDef/AppDef_Variational.cdl b/src/AppDef/AppDef_Variational.cdl index ec22c6e73b..6312c06df3 100644 --- a/src/AppDef/AppDef_Variational.cdl +++ b/src/AppDef/AppDef_Variational.cdl @@ -23,7 +23,8 @@ class Variational from AppDef ---Purpose: This class is used to smooth N points with constraints -- by minimization of quadratic criterium but also -- variational criterium in order to obtain " fair Curve " - -- + -- Computes the approximation of a Multiline by + -- Variational optimization. uses Matrix from math, Vector from math, diff --git a/src/AppParCurves/AppParCurves.cdl b/src/AppParCurves/AppParCurves.cdl index 81fc1b5266..5f3bfa0e0d 100644 --- a/src/AppParCurves/AppParCurves.cdl +++ b/src/AppParCurves/AppParCurves.cdl @@ -51,16 +51,8 @@ is generic class LeastSquare; - ---Purpose: computes in parallel the least square resolution of a - -- set of points (MultiLine). The result is a - -- set of Bezier curves (MultiCurve). - - generic class ResolConstraint; - ---Purpose: computes the approximating resolution with constraints - -- starting from a guess solution issued, for example, - -- from the least squares. - -- It uses the Uzawa method from the mathematical package. + generic class ResolConstraint; generic class Function; @@ -69,17 +61,8 @@ is generic class Gradient, Gradient_BFGS, ParLeastSquare, ResConstraint, ParFunction; - ---Purpose: computes the approximation of a MultiLine by the - -- search for a new parameters to minimize the - -- sum||C(ui)-Qi||2 with a gradient method. - - generic class BSpGradient, BSpGradient_BFGS, BSpParLeastSquare, BSpParFunction; - ---Purpose: computes the approximation of a MultiLine by the - -- search for a new parameters to minimize the - -- sum||C(ui)-Qi||2 with a gradient method. - -- The Result is a Bspline set. --- instantiate classes: diff --git a/src/AppParCurves/AppParCurves_BSpGradient.cdl b/src/AppParCurves/AppParCurves_BSpGradient.cdl index def9045d05..64e4dd63d0 100644 --- a/src/AppParCurves/AppParCurves_BSpGradient.cdl +++ b/src/AppParCurves/AppParCurves_BSpGradient.cdl @@ -25,7 +25,7 @@ generic class BSpGradient from AppParCurves -- sum(square(|F(i)-Qi|)) by changing the parameter. -- The algorithm used is from of the mathematical -- package: math_BFGS, a gradient method. - + -- The Result is a Bspline set. uses Vector from math, diff --git a/src/AppParCurves/AppParCurves_LeastSquare.cdl b/src/AppParCurves/AppParCurves_LeastSquare.cdl index 0787af33af..cb7456131c 100644 --- a/src/AppParCurves/AppParCurves_LeastSquare.cdl +++ b/src/AppParCurves/AppParCurves_LeastSquare.cdl @@ -19,12 +19,15 @@ generic class LeastSquare from AppParCurves ToolLine as any) -- as ToolLine(MultiLine) - ---Purpose: This class describes the least square fitting of a + ---Purpose: This class describes the least square fitting of a -- MultiLine using the Householder method from the -- mathematical package. + -- Computes in parallel the least square resolution of a + -- set of points (MultiLine). The result is a + -- set of Bezier curves (MultiCurve). -- The problem to solve is the following one: -- minimizing the sum(|C(ui)- Qi|)2 where Qi are the points of - -- the MultiLine and C(ui) the points of the approximating + -- the MultiLine and C(ui) the points of the approximating -- curves. diff --git a/src/Approx/Approx.cdl b/src/Approx/Approx.cdl index 1ee644ab3b..614157851a 100644 --- a/src/Approx/Approx.cdl +++ b/src/Approx/Approx.cdl @@ -61,11 +61,8 @@ end; generic class ComputeLine, MyGradient; - ---Purpose: Approximate a MultiLine with a cutting. generic class ComputeCLine, MyLeastSquare; - ---Purpose: Approximate a continous MultiLine with a cutting. - -- The Tool of the line is the tool from AppCont. ---------------------------------------------- ---Algorithms for BSpline curves construction: @@ -117,10 +114,7 @@ end; (Function2d from AppCont, FunctionTool2d from AppCont); class SameParameter from Approx ; - ---Purpose: this makes a 3D curve from Adaptor3d and - -- a curve on surface to check and build a 2D - -- BSpline curve that has the same parameterisation - -- as the 3D curve. + class Array1OfAdHSurface instantiates Array1 from TCollection (HSurface from Adaptor3d) ; class HArray1OfAdHSurface instantiates HArray1 from TCollection @@ -133,7 +127,6 @@ end; -- class ApproxPoints from Approx ; -- class ApproxPoints from Approx ; - ---Purpose: -- this approximates a series of points -- Boundary conditions can be given as well -- a given parameterisation diff --git a/src/Approx/Approx_ComputeCLine.cdl b/src/Approx/Approx_ComputeCLine.cdl index d1e203cf76..2000391774 100644 --- a/src/Approx/Approx_ComputeCLine.cdl +++ b/src/Approx/Approx_ComputeCLine.cdl @@ -17,7 +17,8 @@ generic class ComputeCLine from Approx (MultiLine as any; LineTool as any) - + ---Purpose: Approximate a continous MultiLine with a cutting. + -- The Tool of the line is the tool from AppCont. uses ParametrizationType from Approx, SequenceOfReal from TColStd, diff --git a/src/Approx/Approx_ComputeLine.cdl b/src/Approx/Approx_ComputeLine.cdl index 2178b5d3e1..9b79919bcc 100644 --- a/src/Approx/Approx_ComputeLine.cdl +++ b/src/Approx/Approx_ComputeLine.cdl @@ -17,7 +17,7 @@ generic class ComputeLine from Approx (MultiLine as any; LineTool as any) - + ---Purpose: Approximate a MultiLine with a cutting. uses ParametrizationType from Approx, SequenceOfReal from TColStd, diff --git a/src/Aspect/Aspect.cdl b/src/Aspect/Aspect.cdl index 398b9f30d5..308934f265 100644 --- a/src/Aspect/Aspect.cdl +++ b/src/Aspect/Aspect.cdl @@ -93,7 +93,7 @@ is -- G002A study imported CLayer2d; - ---Purpose: Defines the C structure + ---Category: Imported types imported RGBPixel; @@ -101,25 +101,15 @@ is primitive Handle; primitive Drawable; - ---Purpose: - -- To manage Drawable primitive Display; - ---Purpose: - -- To manage Display primitive RenderingContext; - ---Purpose: - -- To manage 2D or 3D graphic context imported GraphicCallbackProc; - ---Purpose: - -- To manage client post display -- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets imported PolygonOffsetMode; - ---Purpose: - -- Enumeration for polygon offset modes --------------------- -- Category: Pointers @@ -214,25 +204,18 @@ is ------------------------------ deferred class ColorMap; - ---Purpose: Defines a color map. ---Category: Classes Color map class ColorCubeColorMap; - ---Purpose: Associates a index and a color in the "ColorCube" space. ---Category: Classes Color map class ColorRampColorMap; - ---Purpose: Associates a index and a color in the linear "ColorRamp" - -- space. ---Category: Classes Color map class GenericColorMap; - ---Purpose: Associates an index and a color. ---Category: Classes Color map class ColorMapEntry; - ---Purpose: Defines an entry in the color map : - -- an index and a color. ---Category: Classes Color map ------------------------------ @@ -240,15 +223,12 @@ is ------------------------------ deferred class Pixel; - ---Purpose: Defines a picture element. ---Category: Classes Pixel class IndexPixel; - ---Purpose: ---Category: Classes Pixel class ColorPixel; - ---Purpose: ---Category: Classes Pixel --------------------------- @@ -256,18 +236,12 @@ is --------------------------- deferred class AspectLine; - ---Purpose: Creates and updates a group of graphic attributes - -- for primitives 'Line' ---Category: Classes Aspect deferred class AspectMarker; - ---Purpose: Creates and updates a group of graphic attributes - -- for primitives 'Marker'. ---Category: Classes Aspect deferred class AspectFillArea; - ---Purpose: Creates and updates a group of graphic attributes - -- for primitives 'Face'. ---Category: Classes Aspect -------------------- @@ -275,79 +249,57 @@ is -------------------- class Background; - ---Purpose: Defines a window background ---Category: Classes class GradientBackground; - ---Purpose: Defines a window gradient background ---Category: Classes class Edge; - ---Purpose: Defines an edge. ---Category: Classes class GenId; - ---Purpose: Creates and controles all identifiers. ---Category: Classes class FontStyle; - ---Purpose: Defines a Font Style ---Category: The classes class FontMapEntry; - ---Purpose: Defines an entry in the Font map : - -- an index and a text Font. ---Category: Classes Font map class FontMap; - ---Purpose: Associates an index and a text Font entry. ---Category: The classes class WidthMapEntry; - ---Purpose: Defines an entry in the Width map : - -- an index and a line Width. ---Category: Classes Width map class WidthMap; - ---Purpose: Associates an index and a line width entry. ---Category: The classes class LineStyle; - ---Purpose: Defines a Line Style ---Category: The classes class TypeMap; - ---Purpose: Associates an index and a line type entry. ---Category: The classes class TypeMapEntry; - ---Purpose: Defines an entry in the Type map : - -- an index and a line style. ---Category: Classes Type map class MarkerStyle; - ---Purpose: Defines a Marker Style ---Category: The classes class MarkMap; - ---Purpose: Associates an index and a Marker entry. ---Category: The classes class MarkMapEntry; - ---Purpose: Defines an entry in the Marker map : - -- an index and a marker style. ---Category: Classes Mark map deferred class Window; - ---Purpose: Defines a window. ---Category: Classes deferred class Driver; - ---Purpose: Defines a virtual driver. ---Category: Classes deferred class WindowDriver; - ---Purpose: Defines a virtual driver associated to a window. ---Category: Classes deferred class Grid; @@ -355,13 +307,10 @@ is class CircularGrid; deferred class ColorScale; - ---Purpose: Defines a color scale for viewer. imported DisplayConnection; - ---Purpose: Creates and provides connection with X server. imported DisplayConnection_Handle; - ---Purpose: Handle for DisplayConnection; ------------------------- -- Category: Enumerations diff --git a/src/Aspect/Aspect_CLayer2d.hxx b/src/Aspect/Aspect_CLayer2d.hxx index 27d49d2f51..10d497dfcf 100644 --- a/src/Aspect/Aspect_CLayer2d.hxx +++ b/src/Aspect/Aspect_CLayer2d.hxx @@ -17,6 +17,7 @@ /*==== */ /*==== Implementation: This is a primitive type implemented with typedef */ /*============================================================================*/ +// Defines the C structure #ifndef _Aspect_CLayer2d_HeaderFile #define _Aspect_CLayer2d_HeaderFile diff --git a/src/Aspect/Aspect_ColorCubeColorMap.cdl b/src/Aspect/Aspect_ColorCubeColorMap.cdl index e33b92a61b..7063bdc6cb 100644 --- a/src/Aspect/Aspect_ColorCubeColorMap.cdl +++ b/src/Aspect/Aspect_ColorCubeColorMap.cdl @@ -19,6 +19,7 @@ class ColorCubeColorMap from Aspect inherits ColorMap from Aspect ---Version: 0.0 ---Purpose: This class defines a ColorCube ColorMap object. + -- Associates a index and a color in the "ColorCube" space. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_ColorRampColorMap.cdl b/src/Aspect/Aspect_ColorRampColorMap.cdl index 2b8cf9c4dc..a39708c1d9 100644 --- a/src/Aspect/Aspect_ColorRampColorMap.cdl +++ b/src/Aspect/Aspect_ColorRampColorMap.cdl @@ -19,6 +19,7 @@ class ColorRampColorMap from Aspect inherits ColorMap from Aspect ---Version: 0.0 ---Purpose: This class defines a ColorRampColorMap object. + -- Associates a index and a color in the linear "ColorRamp" space. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_ColorScale.cdl b/src/Aspect/Aspect_ColorScale.cdl index c3a6fb64d7..f03d8b3c7b 100644 --- a/src/Aspect/Aspect_ColorScale.cdl +++ b/src/Aspect/Aspect_ColorScale.cdl @@ -14,7 +14,7 @@ -- commercial license or contractual agreement. deferred class ColorScale from Aspect inherits TShared from MMgt - + ---Purpose: Defines a color scale for viewer. uses TypeOfColorScaleData from Aspect, diff --git a/src/Aspect/Aspect_Display.hxx b/src/Aspect/Aspect_Display.hxx index 6badfe3275..aba21fb0a9 100644 --- a/src/Aspect/Aspect_Display.hxx +++ b/src/Aspect/Aspect_Display.hxx @@ -17,6 +17,7 @@ /*==== "V3d" */ /*==== Implementation: This is a primitive type implemented with typedef */ /*============================================================================*/ +// To manage Display #ifndef _Aspect_Display_HeaderFile #define _Aspect_Display_HeaderFile diff --git a/src/Aspect/Aspect_DisplayConnection_Handle.hxx b/src/Aspect/Aspect_DisplayConnection_Handle.hxx index fa0676fbf7..aa2a72c7f1 100755 --- a/src/Aspect/Aspect_DisplayConnection_Handle.hxx +++ b/src/Aspect/Aspect_DisplayConnection_Handle.hxx @@ -16,6 +16,8 @@ #include +// Handle for DisplayConnection; + class Aspect_DisplayConnection; DEFINE_STANDARD_HANDLE(Aspect_DisplayConnection, Standard_Transient) typedef Handle(Aspect_DisplayConnection) Aspect_DisplayConnection_Handle; diff --git a/src/Aspect/Aspect_Drawable.hxx b/src/Aspect/Aspect_Drawable.hxx index c63d9b514d..1d81797ddc 100644 --- a/src/Aspect/Aspect_Drawable.hxx +++ b/src/Aspect/Aspect_Drawable.hxx @@ -17,6 +17,7 @@ /*==== "Xw" & "WNT" */ /*==== Implementation: This is a primitive type implemented with typedef */ /*============================================================================*/ +// To manage Drawable #ifndef _Aspect_Drawable_HeaderFile #define _Aspect_Drawable_HeaderFile diff --git a/src/Aspect/Aspect_FontMap.cdl b/src/Aspect/Aspect_FontMap.cdl index 0ddc90602d..3ef3fe2f1e 100644 --- a/src/Aspect/Aspect_FontMap.cdl +++ b/src/Aspect/Aspect_FontMap.cdl @@ -19,6 +19,7 @@ class FontMap from Aspect inherits TShared from MMgt ---Version: 0.0 ---Purpose: This class defines a FontMap object. + -- Associates an index and a text Font entry. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_GenericColorMap.cdl b/src/Aspect/Aspect_GenericColorMap.cdl index 5e21aa8039..e7e2c0752f 100644 --- a/src/Aspect/Aspect_GenericColorMap.cdl +++ b/src/Aspect/Aspect_GenericColorMap.cdl @@ -20,6 +20,7 @@ class GenericColorMap from Aspect inherits ColorMap from Aspect ---Level: Public ---Purpose: This class defines a GenericColorMap object. + -- Associates an index and a color. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_GraphicCallbackProc.hxx b/src/Aspect/Aspect_GraphicCallbackProc.hxx index 2092de81e4..52b56f22c4 100644 --- a/src/Aspect/Aspect_GraphicCallbackProc.hxx +++ b/src/Aspect/Aspect_GraphicCallbackProc.hxx @@ -14,6 +14,8 @@ #ifndef _Aspect_GraphicCallbackProc_HeaderFile #define _Aspect_GraphicCallbackProc_HeaderFile +// To manage client post display + #include #include #include diff --git a/src/Aspect/Aspect_MarkMap.cdl b/src/Aspect/Aspect_MarkMap.cdl index bcfc12da64..6494c7cdc1 100644 --- a/src/Aspect/Aspect_MarkMap.cdl +++ b/src/Aspect/Aspect_MarkMap.cdl @@ -19,6 +19,7 @@ class MarkMap from Aspect inherits TShared from MMgt ---Version: 0.0 ---Purpose: This class defines a MarkMap object. + -- Associates an index and a Marker entry. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_Pixel.cdl b/src/Aspect/Aspect_Pixel.cdl index ccfaeddeb9..21fffadcc8 100644 --- a/src/Aspect/Aspect_Pixel.cdl +++ b/src/Aspect/Aspect_Pixel.cdl @@ -19,6 +19,7 @@ deferred class Pixel from Aspect inherits Storable ---Version: 0.0 ---Purpose: This class defines a Pixel. + -- Defines a picture element. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_PolygonOffsetMode.hxx b/src/Aspect/Aspect_PolygonOffsetMode.hxx index dcad641884..643ecc3e47 100644 --- a/src/Aspect/Aspect_PolygonOffsetMode.hxx +++ b/src/Aspect/Aspect_PolygonOffsetMode.hxx @@ -16,6 +16,8 @@ #ifndef ASPECT_POLYGONOFFSETMODE_HEADER #define ASPECT_POLYGONOFFSETMODE_HEADER +// Enumeration for polygon offset modes + typedef enum { Aspect_POM_Off = 0x00, /* all polygon offset modes disabled */ diff --git a/src/Aspect/Aspect_RenderingContext.hxx b/src/Aspect/Aspect_RenderingContext.hxx index 7604f681f3..0e55dfd50a 100644 --- a/src/Aspect/Aspect_RenderingContext.hxx +++ b/src/Aspect/Aspect_RenderingContext.hxx @@ -17,6 +17,7 @@ /*==== "V3d" */ /*==== Implementation: This is a primitive type implemented with typedef */ /*============================================================================*/ +// To manage 2D or 3D graphic context #ifndef _Aspect_RenderingContext_HeaderFile #define _Aspect_RenderingContext_HeaderFile diff --git a/src/Aspect/Aspect_TypeMap.cdl b/src/Aspect/Aspect_TypeMap.cdl index f60532e141..c5f2e5f579 100644 --- a/src/Aspect/Aspect_TypeMap.cdl +++ b/src/Aspect/Aspect_TypeMap.cdl @@ -19,6 +19,7 @@ class TypeMap from Aspect inherits TShared from MMgt ---Version: 0.0 ---Purpose: This class defines a TypeMap object. + -- Associates an index and a line type entry. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_WidthMap.cdl b/src/Aspect/Aspect_WidthMap.cdl index e0788d4b22..223def10fa 100644 --- a/src/Aspect/Aspect_WidthMap.cdl +++ b/src/Aspect/Aspect_WidthMap.cdl @@ -19,6 +19,7 @@ class WidthMap from Aspect inherits TShared from MMgt ---Version: 0.0 ---Purpose: This class defines a WidthMap object. + -- Associates an index and a line width entry. ---Keywords: ---Warning: ---References: diff --git a/src/Aspect/Aspect_Window.cdl b/src/Aspect/Aspect_Window.cdl index 7e55f5295c..0522b6cecb 100644 --- a/src/Aspect/Aspect_Window.cdl +++ b/src/Aspect/Aspect_Window.cdl @@ -14,7 +14,7 @@ -- commercial license or contractual agreement. deferred class Window from Aspect - + ---Purpose: Defines a window. inherits TShared from MMgt diff --git a/src/BRep/BRep.cdl b/src/BRep/BRep.cdl index 9177b3d954..6f6e9acc01 100644 --- a/src/BRep/BRep.cdl +++ b/src/BRep/BRep.cdl @@ -49,10 +49,7 @@ is -- class TFace; - ---Purpose: The TFace class is inherited from the TFace from - -- TopoDS. It contains a surface, a tolerance and a - -- natural restriction flag. - + -- -- Edge -- @@ -83,92 +80,54 @@ is -- deferred class CurveRepresentation; - ---Purpose: Root for curve representations. Contains a - -- location. class ListOfCurveRepresentation instantiates List from TCollection (CurveRepresentation from BRep); deferred class GCurve; - ---Purpose: Root class for geometric curves representations. - -- Contains a first an a last parameter. class Curve3D; - ---Purpose: Representation by a 3d curve. class CurveOnSurface; - ---Purpose: Representation by a curve in the parametric space - -- of a surface. class CurveOnClosedSurface; - ---Purpose: Representation by two curves in the parametric - -- space of a closed surface. class Polygon3D; - ---Purpose: Representation by a 3D polygon. class PolygonOnTriangulation; - ---Purpose: Representation by an array of indices on a - -- triangulation. - + class PolygonOnClosedTriangulation; - ---Purpose: Representation by two arrays of indices on a - -- triangulation. - + class PolygonOnSurface; - ---Purpose: Representation by 2d polygon in the parametric space - -- of a surface. class PolygonOnClosedSurface; - ---Purpose: Representation by two 2d polygons in the parametric - -- space of the surface. - + class CurveOn2Surfaces; - ---Purpose: Geometric continuity bewtween two surfaces. class TEdge; - ---Purpose: The TEdge class is inherited from the TEdge from - -- TopoDS. It contains a 3d curve and a list of - -- representations. - -- -- Vertex -- deferred class PointRepresentation; - ---Purpose: Root for point representations. Contains a - -- location. - + class ListOfPointRepresentation instantiates List from TCollection (PointRepresentation from BRep); class PointOnCurve; - ---Purpose: Representation by a parameter on a 3D curve. - + deferred class PointsOnSurface; - ---Purpose: Root for points on surface. - + class PointOnCurveOnSurface; - ---Purpose: Representation by a parameter on a curve on a - -- surface. class PointOnSurface; - ---Purpose: Representation by two parameters on a surface. class TVertex; - ---Purpose: The TVertex class is inherited from the TVertex - -- from TopoDS. It contains a 3d point and a - -- location. class Builder; - ---Purpose: The Builder from BRep is inherited from the - -- Builder3D from TopoDS. It is used to build - -- Shapes. class Tool; - ---Purpose: The Tool from BRep is used to access the geometric - -- data. end BRep; diff --git a/src/BRep/BRep_Builder.cdl b/src/BRep/BRep_Builder.cdl index 2d7d48fe4e..b69e54549b 100644 --- a/src/BRep/BRep_Builder.cdl +++ b/src/BRep/BRep_Builder.cdl @@ -17,6 +17,7 @@ class Builder from BRep inherits Builder from TopoDS ---Purpose: A framework providing advanced tolerance control. + -- It is used to build Shapes. -- If tolerance control is required, you are advised to: -- 1. build a default precision for topology, using the -- classes provided in the BRepAPI package diff --git a/src/BRep/BRep_GCurve.cdl b/src/BRep/BRep_GCurve.cdl index d2abb95aaf..f703884ef2 100644 --- a/src/BRep/BRep_GCurve.cdl +++ b/src/BRep/BRep_GCurve.cdl @@ -18,7 +18,7 @@ deferred class GCurve from BRep inherits CurveRepresentation from BRep ---Purpose: Root class for the geometric curves -- representation. Contains a range. - + -- Contains a first and a last parameter. uses Location from TopLoc, diff --git a/src/BRep/BRep_PointOnCurve.cdl b/src/BRep/BRep_PointOnCurve.cdl index 6300c9758a..67e501fb59 100644 --- a/src/BRep/BRep_PointOnCurve.cdl +++ b/src/BRep/BRep_PointOnCurve.cdl @@ -16,7 +16,7 @@ class PointOnCurve from BRep inherits PointRepresentation from BRep - ---Purpose: + ---Purpose: Representation by a parameter on a 3D curve. uses Curve from Geom, diff --git a/src/BRep/BRep_PointOnCurveOnSurface.cdl b/src/BRep/BRep_PointOnCurveOnSurface.cdl index 9ca2bbb35f..c2d9a52ea5 100644 --- a/src/BRep/BRep_PointOnCurveOnSurface.cdl +++ b/src/BRep/BRep_PointOnCurveOnSurface.cdl @@ -15,6 +15,8 @@ -- commercial license or contractual agreement. class PointOnCurveOnSurface from BRep inherits PointsOnSurface from BRep + ---Purpose: Representation by a parameter on a curve on a + -- surface. uses diff --git a/src/BRep/BRep_PointOnSurface.cdl b/src/BRep/BRep_PointOnSurface.cdl index 52febea9b2..f8488f7ac4 100644 --- a/src/BRep/BRep_PointOnSurface.cdl +++ b/src/BRep/BRep_PointOnSurface.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PointOnSurface from BRep inherits PointsOnSurface from BRep + ---Purpose: Representation by two parameters on a surface. uses Surface from Geom, diff --git a/src/BRep/BRep_PointsOnSurface.cdl b/src/BRep/BRep_PointsOnSurface.cdl index 8852693b18..08ea4faaa1 100644 --- a/src/BRep/BRep_PointsOnSurface.cdl +++ b/src/BRep/BRep_PointsOnSurface.cdl @@ -16,7 +16,7 @@ deferred class PointsOnSurface from BRep inherits PointRepresentation from BRep - ---Purpose: + ---Purpose: Root for points on surface. uses diff --git a/src/BRep/BRep_Polygon3D.cdl b/src/BRep/BRep_Polygon3D.cdl index db48670721..2ae655a1d0 100644 --- a/src/BRep/BRep_Polygon3D.cdl +++ b/src/BRep/BRep_Polygon3D.cdl @@ -16,7 +16,7 @@ class Polygon3D from BRep inherits CurveRepresentation from BRep - ---Purpose: + ---Purpose: Representation by a 3D polygon. uses Polygon3D from Poly, diff --git a/src/BRep/BRep_TVertex.cdl b/src/BRep/BRep_TVertex.cdl index 0c09d77746..6ab4201dc2 100644 --- a/src/BRep/BRep_TVertex.cdl +++ b/src/BRep/BRep_TVertex.cdl @@ -19,7 +19,7 @@ class TVertex from BRep inherits TVertex from TopoDS ---Purpose: The TVertex from BRep inherits from the TVertex -- from TopoDS. It contains the geometric data. -- - -- The TVertex contains a 3d point and a tolerance. + -- The TVertex contains a 3d point, location and a tolerance. -- uses Pnt from gp, diff --git a/src/BRepAdaptor/BRepAdaptor.cdl b/src/BRepAdaptor/BRepAdaptor.cdl index 19832df705..1d2cdfc61d 100644 --- a/src/BRepAdaptor/BRepAdaptor.cdl +++ b/src/BRepAdaptor/BRepAdaptor.cdl @@ -49,17 +49,12 @@ uses is class Surface; - ---Purpose: Transforms a Face in a Surface from Adaptor3d. class Curve; - ---Purpose: Transforms an Edge in a Curve from Adaptor3d. class Curve2d; - ---Purpose: Transforms an Edge on a Face in a Curve2d from - -- Adaptor2d. class CompCurve; - ---Purpose: Transforms a Wire in a Curve from Adaptor3d. class HSurface instantiates GenHSurface from Adaptor3d (Surface from BRepAdaptor); diff --git a/src/BRepAlgo/BRepAlgo.cdl b/src/BRepAlgo/BRepAlgo.cdl index 5045898063..4467db41de 100644 --- a/src/BRepAlgo/BRepAlgo.cdl +++ b/src/BRepAlgo/BRepAlgo.cdl @@ -77,11 +77,7 @@ is class Image; class AsDes; class FaceRestrictor; - ---Purpose:Build all the faces limited with a set of non - -- jointing and planars wires - -- The Wires must have correct orientations. - -- - + class BooleanOperations; ---Purpose: class DSAccess; @@ -89,7 +85,7 @@ is class EdgeConnector; ---Purpose: class NormalProjection; - ---Purpose: + -- class Sewing; now it is in BRepBuilderAPI class DataMapOfShapeBoolean instantiates diff --git a/src/BRepAlgoAPI/BRepAlgoAPI.cdl b/src/BRepAlgoAPI/BRepAlgoAPI.cdl index bd68d84e65..a467961d94 100644 --- a/src/BRepAlgoAPI/BRepAlgoAPI.cdl +++ b/src/BRepAlgoAPI/BRepAlgoAPI.cdl @@ -98,20 +98,15 @@ uses is deferred class BooleanOperation; - ---Purpose: Root class for boolean operations. - + class Fuse; - ---Purpose: Perform the boolean operation FUSE. - --- + class Common; - ---Purpose: Perform the boolean operation COMMON. - --- + class Cut; - ---Purpose: Perform the boolean operation CUT. - --- + class Section; - ---Purpose: Perform the operation SECTION. - --- + class Check; ---Purpose: Check shapes on validity for boolean --- operation. diff --git a/src/BRepBlend/BRepBlend.cdl b/src/BRepBlend/BRepBlend.cdl index 61ada2b764..6c0ffa4d9e 100644 --- a/src/BRepBlend/BRepBlend.cdl +++ b/src/BRepBlend/BRepBlend.cdl @@ -105,74 +105,35 @@ is class AppSurface; - ---Purpose: Used to Approximate the surfaces. deferred class AppFuncRoot; - ---Purpose: Root Class Function to approximate by AppSurface class AppFunc; - ---Purpose: Function to approximate by AppSurface for - -- Surface/Surface contact. class AppFuncRst; - ---Purpose: Function to approximate by AppSurface for - -- Curve/Surface contact. class AppFuncRstRst; - ---Purpose: Function to approximate by AppSurface for - -- Curve/Curve contact. class SurfRstEvolRad; - ---Purpose: Function to approximate by AppSurface for - -- Edge/Face and evolutif radius class SurfRstConstRad; - ---Purpose: Copy of CSConstRad with pcurve on surface - -- as support. class RstRstEvolRad; - ---Purpose: Function to approximate by AppSurface for - -- Edge/Edge and evolutif radius - -- + class RstRstConstRad; - ---Purpose: Copy of CSConstRad with a pcurve on surface - -- as support. class SurfPointConstRadInv; - ---Purpose: Function of reframing between a point and a surface. class SurfCurvConstRadInv; - ---Purpose: Function of reframing between a restriction surface of the - -- surface and a curve. class SurfPointEvolRadInv; - ---Purpose: Fonction of reframing between a point and a surface. class CurvPointRadInv; - ---Purpose: Function of reframing between a point and a curve. - -- valid in cases of constant and progressive radius + class SurfCurvEvolRadInv; - ---Purpose: Function of reframing between a surface restriction - -- of the surface and a curve. class SurfRstLineBuilder; - ---Purpose: Construction of a BRepBlend_Line between a surface and - -- a pcurve on surface from an approached - -- starting solution. The output entries of this builder - -- are of the same nature as of the traditional walking - -- but the requirements on the Line are not the same - -- If the determination of validity range is always - -- guaranteed, the criteria of correct repartition of sections - -- before smoothing are not respected. The resulting Line - -- is f(t) oriented. class RstRstLineBuilder; - ---Purpose: Construction of a BRepBlend_Line between two pcurves - -- from an approached starting solution. The output - -- entries of this builder are of the same nature - -- as of a traditional walking, but the requirements - -- to the Line are not the same. If the determination of validity range is always - -- guaranteed, the criteria of correct repartition of sections - -- before smoothing are not respected. The resulting Line - -- is f(t) oriented. + end BRepBlend; diff --git a/src/BRepBlend/BRepBlend_AppFunc.cdl b/src/BRepBlend/BRepBlend_AppFunc.cdl index efe638e604..f352afd1b0 100644 --- a/src/BRepBlend/BRepBlend_AppFunc.cdl +++ b/src/BRepBlend/BRepBlend_AppFunc.cdl @@ -17,6 +17,7 @@ class AppFunc from BRepBlend inherits AppFuncRoot from BRepBlend ---Purpose: Function to approximate by AppSurface + -- for Surface/Surface contact. ---Level: Advanced uses diff --git a/src/BRepBlend/BRepBlend_AppFuncRst.cdl b/src/BRepBlend/BRepBlend_AppFuncRst.cdl index 39c635b521..45cbda0bf3 100644 --- a/src/BRepBlend/BRepBlend_AppFuncRst.cdl +++ b/src/BRepBlend/BRepBlend_AppFuncRst.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class AppFuncRst from BRepBlend inherits AppFuncRoot from BRepBlend - ---Purpose: Function to approximate by AppSurface for Edge/Face + ---Purpose: Function to approximate by AppSurface for Curve/Surface contact. ---Level: Advanced uses diff --git a/src/BRepBlend/BRepBlend_AppFuncRstRst.cdl b/src/BRepBlend/BRepBlend_AppFuncRstRst.cdl index df54895d06..b1afad01f7 100644 --- a/src/BRepBlend/BRepBlend_AppFuncRstRst.cdl +++ b/src/BRepBlend/BRepBlend_AppFuncRstRst.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class AppFuncRstRst from BRepBlend inherits AppFuncRoot from BRepBlend - ---Purpose: Function to approximate by AppSurface for Edge/Face + ---Purpose: Function to approximate by AppSurface for Edge/Face (Curve/Curve contact). ---Level: Advanced uses diff --git a/src/BRepBlend/BRepBlend_CurvPointRadInv.cdl b/src/BRepBlend/BRepBlend_CurvPointRadInv.cdl index 27f1610e2f..d519d5972a 100644 --- a/src/BRepBlend/BRepBlend_CurvPointRadInv.cdl +++ b/src/BRepBlend/BRepBlend_CurvPointRadInv.cdl @@ -18,7 +18,9 @@ class CurvPointRadInv from BRepBlend inherits CurvPointFuncInv from Blend - ---Purpose: This function is used to find a solution on a done + ---Purpose: Function of reframing between a point and a curve. + -- valid in cases of constant and progressive radius. + -- This function is used to find a solution on a done -- point of the curve 1 when using RstRstConsRad or -- CSConstRad... -- The vector used in Value, Values and Derivatives diff --git a/src/BRepBlend/BRepBlend_RstRstConstRad.cdl b/src/BRepBlend/BRepBlend_RstRstConstRad.cdl index c47d886f7e..722b230a55 100644 --- a/src/BRepBlend/BRepBlend_RstRstConstRad.cdl +++ b/src/BRepBlend/BRepBlend_RstRstConstRad.cdl @@ -17,7 +17,8 @@ class RstRstConstRad from BRepBlend inherits RstRstFunction from Blend - ---Purpose: + ---Purpose: Copy of CSConstRad with a pcurve on surface + -- as support. uses Vector from math, Matrix from math, diff --git a/src/BRepBlend/BRepBlend_RstRstEvolRad.cdl b/src/BRepBlend/BRepBlend_RstRstEvolRad.cdl index 74d206585d..f8a5409566 100644 --- a/src/BRepBlend/BRepBlend_RstRstEvolRad.cdl +++ b/src/BRepBlend/BRepBlend_RstRstEvolRad.cdl @@ -17,6 +17,8 @@ class RstRstEvolRad from BRepBlend inherits RstRstFunction from Blend + ---Purpose: Function to approximate by AppSurface for + -- Edge/Edge and evolutif radius uses Vector from math, Matrix from math, diff --git a/src/BRepBlend/BRepBlend_RstRstLineBuilder.cdl b/src/BRepBlend/BRepBlend_RstRstLineBuilder.cdl index 3214ec5fea..a90e82a809 100644 --- a/src/BRepBlend/BRepBlend_RstRstLineBuilder.cdl +++ b/src/BRepBlend/BRepBlend_RstRstLineBuilder.cdl @@ -36,6 +36,15 @@ class RstRstLineBuilder from BRepBlend -- 3) stall as there is a solution of problem -- surf/surf within the domain of the surface -- of support of the restriction. + -- + -- Construction of a BRepBlend_Line between two pcurves + -- from an approached starting solution. The output + -- entries of this builder are of the same nature + -- as of a traditional walking, but the requirements + -- to the Line are not the same. If the determination of validity range is always + -- guaranteed, the criteria of correct repartition of sections + -- before smoothing are not respected. The resulting Line + -- is f(t) oriented. uses Point from Blend, Status from Blend, diff --git a/src/BRepBlend/BRepBlend_SurfCurvConstRadInv.cdl b/src/BRepBlend/BRepBlend_SurfCurvConstRadInv.cdl index 69ab1c6181..5ce1d0106b 100644 --- a/src/BRepBlend/BRepBlend_SurfCurvConstRadInv.cdl +++ b/src/BRepBlend/BRepBlend_SurfCurvConstRadInv.cdl @@ -18,7 +18,9 @@ class SurfCurvConstRadInv from BRepBlend inherits SurfCurvFuncInv from Blend - ---Purpose: Class used to compute a solution of the + ---Purpose: Function of reframing between a restriction surface of the + -- surface and a curve. + -- Class used to compute a solution of the -- surfRstConstRad problem on a done restriction of the -- surface. -- The vector used in Value, Values and Derivatives diff --git a/src/BRepBlend/BRepBlend_SurfCurvEvolRadInv.cdl b/src/BRepBlend/BRepBlend_SurfCurvEvolRadInv.cdl index a91d5b555f..234adf7d4b 100644 --- a/src/BRepBlend/BRepBlend_SurfCurvEvolRadInv.cdl +++ b/src/BRepBlend/BRepBlend_SurfCurvEvolRadInv.cdl @@ -18,9 +18,11 @@ class SurfCurvEvolRadInv from BRepBlend inherits SurfCurvFuncInv from Blend - ---Purpose: Class used to compute a solution of the + ---Purpose: Function of reframing between a surface restriction + -- of the surface and a curve. + -- Class used to compute a solution of the -- surfRstConstRad problem on a done restriction of the - -- surface. + -- surface. -- The vector used in Value, Values and Derivatives -- methods has to be the vector of the parametric -- coordinates wguide, wcurv, wrst where wguide is the diff --git a/src/BRepBlend/BRepBlend_SurfPointConstRadInv.cdl b/src/BRepBlend/BRepBlend_SurfPointConstRadInv.cdl index 75264a0553..2c87ad63bd 100644 --- a/src/BRepBlend/BRepBlend_SurfPointConstRadInv.cdl +++ b/src/BRepBlend/BRepBlend_SurfPointConstRadInv.cdl @@ -18,7 +18,8 @@ class SurfPointConstRadInv from BRepBlend inherits SurfPointFuncInv from Blend - ---Purpose: This function is used to find a solution on a done + ---Purpose: Function of reframing between a point and a surface. + -- This function is used to find a solution on a done -- point of the curve when using SurfRstConsRad or -- CSConstRad... -- The vector used in Value, Values and Derivatives diff --git a/src/BRepBlend/BRepBlend_SurfPointEvolRadInv.cdl b/src/BRepBlend/BRepBlend_SurfPointEvolRadInv.cdl index e2dfdf54b7..3edfb47138 100644 --- a/src/BRepBlend/BRepBlend_SurfPointEvolRadInv.cdl +++ b/src/BRepBlend/BRepBlend_SurfPointEvolRadInv.cdl @@ -18,9 +18,10 @@ class SurfPointEvolRadInv from BRepBlend inherits SurfPointFuncInv from Blend - ---Purpose: This function is used to find a solution on a done + ---Purpose: Function of reframing between a point and a surface. + -- This function is used to find a solution on a done -- point of the curve when using SurfRstConsRad or - -- CSConstRad... + -- CSConstRad... -- The vector used in Value, Values and Derivatives -- methods has to be the vector of the parametric -- coordinates w, U, V where w is the parameter on the diff --git a/src/BRepBlend/BRepBlend_SurfRstConstRad.cdl b/src/BRepBlend/BRepBlend_SurfRstConstRad.cdl index bc9833895b..c2935fbaf6 100644 --- a/src/BRepBlend/BRepBlend_SurfRstConstRad.cdl +++ b/src/BRepBlend/BRepBlend_SurfRstConstRad.cdl @@ -17,6 +17,8 @@ class SurfRstConstRad from BRepBlend inherits SurfRstFunction from Blend + ---Purpose: Copy of CSConstRad with pcurve on surface + -- as support. uses Vector from math, Matrix from math, diff --git a/src/BRepBlend/BRepBlend_SurfRstEvolRad.cdl b/src/BRepBlend/BRepBlend_SurfRstEvolRad.cdl index fb0bb169b9..2d34764e1b 100644 --- a/src/BRepBlend/BRepBlend_SurfRstEvolRad.cdl +++ b/src/BRepBlend/BRepBlend_SurfRstEvolRad.cdl @@ -17,7 +17,8 @@ class SurfRstEvolRad from BRepBlend inherits SurfRstFunction from Blend - ---Purpose: + ---Purpose: Function to approximate by AppSurface for + -- Edge/Face and evolutif radius uses Vector from math, Matrix from math, diff --git a/src/BRepBlend/BRepBlend_SurfRstLineBuilder.cdl b/src/BRepBlend/BRepBlend_SurfRstLineBuilder.cdl index c0b193501c..63a1df9009 100644 --- a/src/BRepBlend/BRepBlend_SurfRstLineBuilder.cdl +++ b/src/BRepBlend/BRepBlend_SurfRstLineBuilder.cdl @@ -34,6 +34,16 @@ class SurfRstLineBuilder from BRepBlend -- 3) stall as there is a solution to the problem -- surf/surf within the domain of the surface -- of support of the restriction. + -- + -- Construction of a BRepBlend_Line between a surface and + -- a pcurve on surface from an approached + -- starting solution. The output entries of this builder + -- are of the same nature as of the traditional walking + -- but the requirements on the Line are not the same + -- If the determination of validity range is always + -- guaranteed, the criteria of correct repartition of sections + -- before smoothing are not respected. The resulting Line + -- is f(t) oriented. uses Point from Blend, Status from Blend, diff --git a/src/BRepBuilderAPI/BRepBuilderAPI.cdl b/src/BRepBuilderAPI/BRepBuilderAPI.cdl index b21c6df577..6eabd734a8 100644 --- a/src/BRepBuilderAPI/BRepBuilderAPI.cdl +++ b/src/BRepBuilderAPI/BRepBuilderAPI.cdl @@ -231,10 +231,8 @@ is end TransitionMode; deferred class Command; - ---Purpose: Root class for all BRepBuilderAPI commands. deferred class MakeShape; - ---Purpose: Root class for all shape constructions. -- -- Construction of topology from geometry @@ -260,10 +258,6 @@ is -- class Sewing; - ---Purpose: Provides a tool to - -- - identify contigous boundaries (for control - -- of continuity: C0, C1, ...) - -- - assemble contigous shapes into one shape. -- -- Construction of composite topologies @@ -284,9 +278,6 @@ is class Transform; class NurbsConvert ; - ---Purpose: converts all 3D analytical representation of surfaces - -- and curves to NURBS execpt for Planes - -- class GTransform; diff --git a/src/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.cdl b/src/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.cdl index 449da1b5bb..e102135b3a 100644 --- a/src/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.cdl +++ b/src/BRepBuilderAPI/BRepBuilderAPI_NurbsConvert.cdl @@ -16,11 +16,12 @@ class NurbsConvert from BRepBuilderAPI inherits ModifyShape from BRepBuilderAPI - ---Purpose: Conversion of the complete geometry of a shape into - -- NURBS geometry. For example, all curves supporting - -- edges of the basis shape are converted into BSpline - -- curves, and all surfaces supporting its faces are - -- converted into BSpline surfaces. + ---Purpose: Conversion of the complete geometry of a shape + -- (all 3D analytical representation of surfaces and curves) + -- into NURBS geometry (execpt for Planes). For example, + -- all curves supporting edges of the basis shape are converted + -- into BSpline curves, and all surfaces supporting its faces are + -- converted into BSpline surfaces. uses diff --git a/src/BRepBuilderAPI/BRepBuilderAPI_Sewing.cdl b/src/BRepBuilderAPI/BRepBuilderAPI_Sewing.cdl index 54a625019e..b6bd3818af 100644 --- a/src/BRepBuilderAPI/BRepBuilderAPI_Sewing.cdl +++ b/src/BRepBuilderAPI/BRepBuilderAPI_Sewing.cdl @@ -26,7 +26,7 @@ class Sewing from BRepBuilderAPI inherits TShared from MMgt ---Purpose: Provides methods to -- -- - identify possible contigous boundaries (for control - -- afterwards) + -- afterwards (of continuity: C0, C1, ...)) -- -- - assemble contigous shapes into one shape. -- Only manifold shapes will be found. Sewing will not diff --git a/src/BRepClass/BRepClass.cdl b/src/BRepClass/BRepClass.cdl index c5e0d30ded..b2d7bdbe75 100644 --- a/src/BRepClass/BRepClass.cdl +++ b/src/BRepClass/BRepClass.cdl @@ -36,19 +36,14 @@ uses is class Edge; - ---Purpose: Stores the Edge and the Face. class Intersector; - ---Purpose: Intersect an Edge with a segment. This class is - -- inherited from IntConicCurveOfGInter from - -- Geom2dInt. class FacePassiveClassifier instantiates Classifier2d from TopClass (Edge from BRepClass, Intersector from BRepClass); class FaceExplorer; - ---Purpose: Exploration of a Face to return UV edges. class FClassifier instantiates FaceClassifier from TopClass (FaceExplorer from BRepClass, @@ -56,8 +51,5 @@ is Intersector from BRepClass); class FaceClassifier; - ---Purpose: Inherited from FClassifier to provide a - -- Constructor with a Face. - end BRepClass; diff --git a/src/BRepClass/BRepClass_FaceClassifier.cdl b/src/BRepClass/BRepClass_FaceClassifier.cdl index 334a46df73..94d80ef6d5 100644 --- a/src/BRepClass/BRepClass_FaceClassifier.cdl +++ b/src/BRepClass/BRepClass_FaceClassifier.cdl @@ -16,7 +16,7 @@ class FaceClassifier from BRepClass inherits FClassifier from BRepClass - ---Purpose: Provides Constructors. + ---Purpose: Provides Constructors with a Face. uses FaceExplorer from BRepClass, diff --git a/src/BRepClass/BRepClass_FaceExplorer.cdl b/src/BRepClass/BRepClass_FaceExplorer.cdl index 76befa826c..c2fa1f8d4f 100644 --- a/src/BRepClass/BRepClass_FaceExplorer.cdl +++ b/src/BRepClass/BRepClass_FaceExplorer.cdl @@ -19,7 +19,7 @@ class FaceExplorer from BRepClass ---Purpose: Provide an exploration of a BRep Face for the - -- classification. + -- classification. Return UV edges. uses Orientation from TopAbs, diff --git a/src/BRepClass/BRepClass_Intersector.cdl b/src/BRepClass/BRepClass_Intersector.cdl index bb29ff47f6..94bb2374dd 100644 --- a/src/BRepClass/BRepClass_Intersector.cdl +++ b/src/BRepClass/BRepClass_Intersector.cdl @@ -17,7 +17,8 @@ class Intersector from BRepClass inherits IntConicCurveOfGInter from Geom2dInt - ---Purpose: Implement the Intersector2d required by the classifier. + ---Purpose: Intersect an Edge with a segment. + -- Implement the Intersector2d required by the classifier. uses Lin2d from gp, diff --git a/src/BRepFill/BRepFill.cdl b/src/BRepFill/BRepFill.cdl index 35d1b90a8d..95af43ce58 100644 --- a/src/BRepFill/BRepFill.cdl +++ b/src/BRepFill/BRepFill.cdl @@ -76,11 +76,7 @@ is class Generator; - ---Purpose: Compute a topological surface ( a shell) using - -- generating wires. The face of the shell will be - -- ruled surfaces through the wires. - -- The wires must have the same number of edges. - + deferred class SectionLaw; class ShapeLaw; class NSections; @@ -94,31 +90,16 @@ is class ACRLaw; class Pipe; - ---Purpose: Computes a topological shape using a wire - -- (spine) and a shape (profile). + class PipeShell; - ---Purpose: Computes a topological shell using some wires -- - -- (spines and profiles) and diplacement option - class Evolved; - ---Purpose: Computes an evolved volum using a generating - -- wire and a profile. class Sweep; - ---Purpose: Computes an Sweep shell using a generating - -- wire, an SectionLaw and an LocationLaw. - class CompatibleWires; - ---Purpose: Computes Wires with good orientation and origin in order - -- to generate a shell not twisted. - class OffsetWire; - ---Purpose: Computes the offset of a Wire or the Wires contained - -- in a Face. - -- The Wire or the Face must be planar. class OffsetAncestors; @@ -136,12 +117,9 @@ is private class TrimSurfaceTool; - ---Purpose: Compute the Pcurves and the 3d curves resulting - -- of the trimming of a face by an extruded surface. private class TrimEdgeTool; - ---Purpose: Geometric Tool using to construct Offset Wires. - + private class SectionPlacement; private class Section; @@ -196,21 +174,9 @@ is class CurveConstraint ; - ---Purpose: same as CurveConstraint from GeomPlate - -- with BRepAdaptor_Surface instead of - -- GeomAdaptor_Surface - -- inherits CurveConstraint from GeomPlate - + class Filling; - ---Purpose: N-Side Filling - -- This algorithm avoids to build a face from: - -- * a set of edges defining the bounds of the face and some - -- constraints the surface of the face has to satisfy - -- * a set of edges and points defining some constraints - -- the support surface has to satisfy - -- * an initial surface to deform for satisfying the constraints - -- * a set of parameters to control the constraints. - + private class FaceAndOrder; private class EdgeFaceAndOrder; diff --git a/src/BRepFill/BRepFill_CompatibleWires.cdl b/src/BRepFill/BRepFill_CompatibleWires.cdl index 946669dcdc..5caea6824b 100644 --- a/src/BRepFill/BRepFill_CompatibleWires.cdl +++ b/src/BRepFill/BRepFill_CompatibleWires.cdl @@ -16,9 +16,9 @@ class CompatibleWires from BRepFill - ---Purpose: Constructs a sequence of Wires agreed each other - -- so that the surface passing through these sections - -- is not twisted + ---Purpose: Constructs a sequence of Wires (with good orientation + -- and origin) agreed each other so that the surface passing + -- through these sections is not twisted uses diff --git a/src/BRepFill/BRepFill_CurveConstraint.cdl b/src/BRepFill/BRepFill_CurveConstraint.cdl index 414785f0ee..cba17ea8ec 100644 --- a/src/BRepFill/BRepFill_CurveConstraint.cdl +++ b/src/BRepFill/BRepFill_CurveConstraint.cdl @@ -14,7 +14,10 @@ -- Alternatively, this file may be used under the terms of Open CASCADE -- commercial license or contractual agreement. -class CurveConstraint from BRepFill inherits CurveConstraint from GeomPlate +class CurveConstraint from BRepFill inherits CurveConstraint from GeomPlate + ---Purpose: same as CurveConstraint from GeomPlate + -- with BRepAdaptor_Surface instead of + -- GeomAdaptor_Surface uses Pnt from gp, diff --git a/src/BRepFill/BRepFill_OffsetWire.cdl b/src/BRepFill/BRepFill_OffsetWire.cdl index bfc1f590bd..5cea4f6d36 100644 --- a/src/BRepFill/BRepFill_OffsetWire.cdl +++ b/src/BRepFill/BRepFill_OffsetWire.cdl @@ -18,7 +18,7 @@ class OffsetWire from BRepFill ---Purpose: Constructs a Offset Wire to a spine (wire or face) -- on the left of spine. - + -- The Wire or the Face must be planar. uses Face from TopoDS, diff --git a/src/BRepFill/BRepFill_PipeShell.cdl b/src/BRepFill/BRepFill_PipeShell.cdl index d477c57b35..fdb4abaf17 100644 --- a/src/BRepFill/BRepFill_PipeShell.cdl +++ b/src/BRepFill/BRepFill_PipeShell.cdl @@ -16,7 +16,9 @@ class PipeShell from BRepFill inherits TShared from MMgt - ---Purpose: Perform general sweeping construction + ---Purpose: Computes a topological shell using some wires + -- (spines and profiles) and diplacement option + -- Perform general sweeping construction uses Dir from gp, Ax2 from gp, diff --git a/src/BRepFill/BRepFill_Sweep.cdl b/src/BRepFill/BRepFill_Sweep.cdl index 27054d236a..6968f12185 100644 --- a/src/BRepFill/BRepFill_Sweep.cdl +++ b/src/BRepFill/BRepFill_Sweep.cdl @@ -18,6 +18,8 @@ class Sweep from BRepFill ---Purpose: Topological Sweep Algorithm + -- Computes an Sweep shell using a generating + -- wire, an SectionLaw and an LocationLaw. ---Level: Advanced uses diff --git a/src/BRepFill/BRepFill_TrimEdgeTool.cdl b/src/BRepFill/BRepFill_TrimEdgeTool.cdl index 8d680b1d6d..491e6d9aa7 100644 --- a/src/BRepFill/BRepFill_TrimEdgeTool.cdl +++ b/src/BRepFill/BRepFill_TrimEdgeTool.cdl @@ -16,7 +16,7 @@ private class TrimEdgeTool from BRepFill - ---Purpose: + ---Purpose: Geometric Tool using to construct Offset Wires. uses diff --git a/src/BRepFill/BRepFill_TrimSurfaceTool.cdl b/src/BRepFill/BRepFill_TrimSurfaceTool.cdl index ce2ce79a15..2695fa3b6d 100644 --- a/src/BRepFill/BRepFill_TrimSurfaceTool.cdl +++ b/src/BRepFill/BRepFill_TrimSurfaceTool.cdl @@ -16,7 +16,8 @@ private class TrimSurfaceTool from BRepFill - ---Purpose: + ---Purpose: Compute the Pcurves and the 3d curves resulting + -- of the trimming of a face by an extruded surface. uses diff --git a/src/BRepLib/BRepLib.cdl b/src/BRepLib/BRepLib.cdl index 93b700a3b2..d950f3eba7 100644 --- a/src/BRepLib/BRepLib.cdl +++ b/src/BRepLib/BRepLib.cdl @@ -93,10 +93,8 @@ is end ShapeModification; deferred class Command; - ---Purpose: Root class for all BRepBuilderAPI commands. deferred class MakeShape; - ---Purpose: Root class for all shape constructions. -- -- Construction of topology from geometry @@ -131,7 +129,6 @@ is class FindSurface; - ---Purpose: Find a surface in a set of edges. class FuseEdges; ---Purpose: diff --git a/src/BRepMAT2d/BRepMAT2d.cdl b/src/BRepMAT2d/BRepMAT2d.cdl index 3051e22d0f..afff536d3d 100644 --- a/src/BRepMAT2d/BRepMAT2d.cdl +++ b/src/BRepMAT2d/BRepMAT2d.cdl @@ -32,19 +32,10 @@ uses is class Explorer; - ---Purpose: Construct an explorer for the computation of the - -- bisecting locus from a Wire, a Face, or a set of - -- curves from Geom2d. class BisectingLocus; - ---Purpose: Constuction of the map of the bisector locus on a - -- set of geometrys from Geom2d. - - ---Purpose: the map of bisecting locus. - + class LinkTopoBilo; - ---Purpose: Constucts links between the Wire or the Face and - -- the BasicElts contained in the bisecting locus. class DataMapOfShapeSequenceOfBasicElt instantiates DataMap from TCollection diff --git a/src/BRepMAT2d/BRepMAT2d_LinkTopoBilo.cdl b/src/BRepMAT2d/BRepMAT2d_LinkTopoBilo.cdl index 1339a8a32d..4d79c763a8 100644 --- a/src/BRepMAT2d/BRepMAT2d_LinkTopoBilo.cdl +++ b/src/BRepMAT2d/BRepMAT2d_LinkTopoBilo.cdl @@ -16,7 +16,7 @@ class LinkTopoBilo from BRepMAT2d - ---Purpose:Constucts links between the Face of the explorer and + ---Purpose:Constucts links between the Wire or the Face of the explorer and -- the BasicElts contained in the bisecting locus. uses diff --git a/src/BRepMesh/BRepMesh.cdl b/src/BRepMesh/BRepMesh.cdl index ba55d7bdaf..dcca4c266a 100644 --- a/src/BRepMesh/BRepMesh.cdl +++ b/src/BRepMesh/BRepMesh.cdl @@ -167,7 +167,6 @@ is enumeration DegreeOfFreedom is imported ClassifierPtr; -- smart pointer on Classifier class IncrementalMesh from BRepMesh; - ---Purpose: meshes faces from a Shape only if necessary. ---- classes moved from MeshShape class GeomTool; diff --git a/src/BRepMesh/BRepMesh_IncrementalMesh.cdl b/src/BRepMesh/BRepMesh_IncrementalMesh.cdl index d766a5363f..218a812b90 100644 --- a/src/BRepMesh/BRepMesh_IncrementalMesh.cdl +++ b/src/BRepMesh/BRepMesh_IncrementalMesh.cdl @@ -19,8 +19,8 @@ class IncrementalMesh from BRepMesh inherits DiscretRoot from BRepMesh ---Purpose: Builds the mesh of a shape with respect of their - -- correctly triangulated parts - -- + -- correctly triangulated parts. + -- Meshes faces from a Shape only if necessary. uses Box from Bnd, diff --git a/src/BRepOffset/BRepOffset.cdl b/src/BRepOffset/BRepOffset.cdl index 60b9c7ea4f..2147e086ba 100644 --- a/src/BRepOffset/BRepOffset.cdl +++ b/src/BRepOffset/BRepOffset.cdl @@ -84,12 +84,6 @@ is class Inter2d; class Offset; - ---Purpose: This class compute elemenary offset surface. - -- Evaluate the offset generated : - -- 1 - from a face. - -- 2 - from an edge. - -- 3 - from a vertex. - -- class Analyse; diff --git a/src/BRepOffset/BRepOffset_Offset.cdl b/src/BRepOffset/BRepOffset_Offset.cdl index 86a5010d51..7408150b70 100644 --- a/src/BRepOffset/BRepOffset_Offset.cdl +++ b/src/BRepOffset/BRepOffset_Offset.cdl @@ -16,8 +16,11 @@ class Offset from BRepOffset - ---Purpose: class for the creation of Offseting. - + ---Purpose: This class compute elemenary offset surface. + -- Evaluate the offset generated : + -- 1 - from a face. + -- 2 - from an edge. + -- 3 - from a vertex. uses Status from BRepOffset, diff --git a/src/BRepOffsetAPI/BRepOffsetAPI.cdl b/src/BRepOffsetAPI/BRepOffsetAPI.cdl index f3ed0d6253..bfe415959f 100644 --- a/src/BRepOffsetAPI/BRepOffsetAPI.cdl +++ b/src/BRepOffsetAPI/BRepOffsetAPI.cdl @@ -46,12 +46,8 @@ is -- class MakePipe; --- inherits MakeSweep from BRepPrimAPI - ---Purpose: To create shape by pipe - - class MakePipeShell; --- inherits MakeSweep from BRepPrimAPI - ---Purpose: Numerous posibilities to create shell by sweeping - + class MakePipeShell; --- inherits MakeSweep from BRepPrimAPI class MakeDraft; --- inherits MakeShape from BRepBuilderAPI @@ -61,8 +57,6 @@ is class FindContigousEdges; - ---Purpose: find the contigous edges of shapes for control - -- (continuity C0, C1, ...) alias Sewing is Sewing from BRepBuilderAPI; ---Purpose: sew the shapes along their common edges @@ -74,13 +68,11 @@ is -- class MakeOffset; --- inherits MakeShape from BRepBuilderAPI - ---Purpose: Offsets to a set of plane wires. - + class MakeOffsetShape; --- inherits MakeShape from BRepBuilderAPI --Purpose: Offset shape to shells or solids. class MakeThickSolid; --- inherits MakeOffsetShape from BRepOffsetAPI - ---Purpose: Thick solid to shells or solids. class MakeEvolved; --- inherits MakeShape from BRepBuilderAPI @@ -100,15 +92,6 @@ is -- class MakeFilling; --- inherits MakeShape from BRepBuilderAPI - ---Purpose: N-Side Filling - -- This algorithm avoids to build a face from: - -- * a set of edges defining the bounds of the face and some - -- constraints the surface of the face has to satisfy - -- * a set of edges and points defining some constraints - -- the support surface has to satisfy - -- * an initial surface to deform for satisfying the constraints - -- * a set of parameters to control the constraints. - class SequenceOfSequenceOfReal instantiates Sequence from TCollection (SequenceOfReal from TColStd); diff --git a/src/BRepPrimAPI/BRepPrimAPI.cdl b/src/BRepPrimAPI/BRepPrimAPI.cdl index 98ee5e727a..879067ffe1 100644 --- a/src/BRepPrimAPI/BRepPrimAPI.cdl +++ b/src/BRepPrimAPI/BRepPrimAPI.cdl @@ -110,7 +110,6 @@ is class MakeWedge; --- inherits MakeShape from BRepBuilderAPI deferred class MakeOneAxis; --- inherits MakeShape from BRepBuilderAPI - ---Purpose: Root class for rotational primitives. class MakeCylinder; --- inherits MakeShape from BRepBuilderAPI diff --git a/src/BRepProj/BRepProj.cdl b/src/BRepProj/BRepProj.cdl index b9e0156702..3e9ee4419b 100644 --- a/src/BRepProj/BRepProj.cdl +++ b/src/BRepProj/BRepProj.cdl @@ -34,9 +34,6 @@ is class Projection; - ---Purpose: provides conical and cylindrical projections of - -- Edge or Wire on a Shape from TopoDS. The result - -- will be a Edge or Wire from TopoDS. - + end BRepProj; diff --git a/src/BRepSweep/BRepSweep.cdl b/src/BRepSweep/BRepSweep.cdl index d727f43fe6..4ae0597786 100644 --- a/src/BRepSweep/BRepSweep.cdl +++ b/src/BRepSweep/BRepSweep.cdl @@ -38,14 +38,10 @@ uses is class Builder; - ---Purpose: Implements the Builder required for Sweep. class Tool; - ---Purpose: Provides an indexation of the subShapes of a Shape - -- from TopoDS. - + class Iterator; - ---Purpose: Iterator on the subShapes of a shape. deferred class NumLinearRegularSweep; diff --git a/src/BRepTools/BRepTools.cdl b/src/BRepTools/BRepTools.cdl index 3d5e7b2fb0..d35496aef9 100644 --- a/src/BRepTools/BRepTools.cdl +++ b/src/BRepTools/BRepTools.cdl @@ -75,49 +75,24 @@ uses is class WireExplorer; - ---Purpose: To explore the 3D or the UV topology of a Face. deferred class Modification; - ---Purpose: Defines geometric modifications on a shape - -- ( on the faces, the edges, the vertices). class Modifier; - ---Purpose: Performs geometric modifications on a shape. class TrsfModification; - ---Purpose: Defines a Modification with a Trsf from gp. - -- Inherited from Modification. class NurbsConvertModification; - ---Purpose: Conversion des entites analytiques d'une shape - -- en NURBS (courbes et surface 3D) - -- Inherited from Modification. class GTrsfModification; - ---Purpose: Defines a Modification with a GTrsf from gp. - -- Inherited from Modification. class Substitution; - ---Purpose: Provides a tool to change subshapes in a shape. class Quilt; - ---Purpose: Provides a tool to glue shapes on edges. - -- for exemple glue faces to make a shell. - -- class Sewing; - ---Purpose: Provides a tool to - -- - identify contigous boundaries (for control - -- of continuity: C0, C1, ...) - -- - assemble contigous shapes into one shape. - - -- - -- Dump, Write, Read tools - class ShapeSet; - ---Purpose: A set of BRep TShapes. Inherited from TopTools. class ReShape; - ---Purpose: Provides tools for modification of shape. class MapOfVertexPnt2d instantiates DataMap from TCollection (Shape from TopoDS, diff --git a/src/BRepTools/BRepTools_Modifier.cdl b/src/BRepTools/BRepTools_Modifier.cdl index 56a2dc23bb..2420f73700 100644 --- a/src/BRepTools/BRepTools_Modifier.cdl +++ b/src/BRepTools/BRepTools_Modifier.cdl @@ -16,7 +16,7 @@ class Modifier from BRepTools - ---Purpose: + ---Purpose: Performs geometric modifications on a shape. uses Shape from TopoDS, Modification from BRepTools, diff --git a/src/BSplCLib/BSplCLib.cdl b/src/BSplCLib/BSplCLib.cdl index 505926146e..6d51752a74 100644 --- a/src/BSplCLib/BSplCLib.cdl +++ b/src/BSplCLib/BSplCLib.cdl @@ -106,14 +106,6 @@ uses TColStd, gp, TColgp, math, GeomAbs is imported EvaluatorFunction ; - ---Purpose: this is a one dimensional function - -- typedef void (*EvaluatorFunction) ( - -- Standard_Integer // Derivative Request - -- Standard_Real * // StartEnd[2] - -- Standard_Real // Parameter - -- Standard_Real & // Result - -- Standard_Integer &) ;// Error Code - -- serves to multiply a given vectorial BSpline by a function enumeration KnotDistribution is NonUniform, Uniform; ---Purpose: This enumeration describes the repartition of the diff --git a/src/BSplCLib/BSplCLib_EvaluatorFunction.hxx b/src/BSplCLib/BSplCLib_EvaluatorFunction.hxx index 7f40728841..7701a3f633 100644 --- a/src/BSplCLib/BSplCLib_EvaluatorFunction.hxx +++ b/src/BSplCLib/BSplCLib_EvaluatorFunction.hxx @@ -19,6 +19,10 @@ #include +// This is a one dimensional function +// NOTE: StartEnd[2] +// Serves to multiply a given vectorial BSpline by a function + // History - C function pointer converted to a virtual class // in order to get rid of usage of static functions and static data class BSplCLib_EvaluatorFunction diff --git a/src/BiTgte/BiTgte.cdl b/src/BiTgte/BiTgte.cdl index 8685cbcb56..f7b5787e4d 100644 --- a/src/BiTgte/BiTgte.cdl +++ b/src/BiTgte/BiTgte.cdl @@ -45,18 +45,13 @@ is end ContactType; class Blend; - ---Purpose: Root class private class CurveOnEdge; - ---Purpose: private class used to create a filler rolling on - -- an edge. private class HCurveOnEdge instantiates GenHCurve from Adaptor3d(CurveOnEdge from BiTgte); private class CurveOnVertex; - ---Purpose: private class used to create a filler rolling on - -- an edge. private class HCurveOnVertex instantiates GenHCurve from Adaptor3d(CurveOnVertex from BiTgte); diff --git a/src/BiTgte/BiTgte_Blend.cdl b/src/BiTgte/BiTgte_Blend.cdl index fbf732ddc1..17229b5f2f 100644 --- a/src/BiTgte/BiTgte_Blend.cdl +++ b/src/BiTgte/BiTgte_Blend.cdl @@ -16,7 +16,7 @@ class Blend from BiTgte - ---Purpose: + ---Purpose: Root class uses diff --git a/src/BiTgte/BiTgte_CurveOnEdge.cdl b/src/BiTgte/BiTgte_CurveOnEdge.cdl index 4ae39c15e0..0d7f1be249 100644 --- a/src/BiTgte/BiTgte_CurveOnEdge.cdl +++ b/src/BiTgte/BiTgte_CurveOnEdge.cdl @@ -16,7 +16,8 @@ private class CurveOnEdge from BiTgte inherits Curve from Adaptor3d - ---Purpose: + ---Purpose: private class used to create a filler rolling on + -- an edge. uses Array1OfReal from TColStd, diff --git a/src/BiTgte/BiTgte_CurveOnVertex.cdl b/src/BiTgte/BiTgte_CurveOnVertex.cdl index df44323e87..f9ac9c35bb 100644 --- a/src/BiTgte/BiTgte_CurveOnVertex.cdl +++ b/src/BiTgte/BiTgte_CurveOnVertex.cdl @@ -16,7 +16,8 @@ private class CurveOnVertex from BiTgte inherits Curve from Adaptor3d - ---Purpose: + ---Purpose: private class used to create a filler rolling on + -- an edge. uses Array1OfReal from TColStd, diff --git a/src/BinMDataStd/BinMDataStd.cdl b/src/BinMDataStd/BinMDataStd.cdl index 461ffe872e..880479738d 100644 --- a/src/BinMDataStd/BinMDataStd.cdl +++ b/src/BinMDataStd/BinMDataStd.cdl @@ -23,8 +23,8 @@ uses BinMDF, CDM is - ---Purpose: Storage/Retrieval drivers for TDataStd attributes - -- ======================================= + ---Category: Storage/Retrieval drivers for TDataStd attributes + -- ======================================= class NameDriver; diff --git a/src/BinMDataXtd/BinMDataXtd.cdl b/src/BinMDataXtd/BinMDataXtd.cdl index f7e87372eb..7bb68fffa4 100644 --- a/src/BinMDataXtd/BinMDataXtd.cdl +++ b/src/BinMDataXtd/BinMDataXtd.cdl @@ -25,8 +25,8 @@ uses BinMDF, CDM is - ---Purpose: Storage/Retrieval drivers for TDataXtd attributes - -- ======================================= + ---Category: Storage/Retrieval drivers for TDataXtd attributes + -- ======================================= class PointDriver; diff --git a/src/BinMPrsStd/BinMPrsStd.cdl b/src/BinMPrsStd/BinMPrsStd.cdl index 24e5c4339e..f434bbc3fb 100644 --- a/src/BinMPrsStd/BinMPrsStd.cdl +++ b/src/BinMPrsStd/BinMPrsStd.cdl @@ -23,8 +23,8 @@ uses BinMDF, CDM is - ---Purpose: Storage-Retrieval drivers for graphic attributes from - -- TPrsStd + ---Category: Storage-Retrieval drivers for graphic attributes from + -- TPrsStd class AISPresentationDriver; diff --git a/src/Bisector/Bisector.cdl b/src/Bisector/Bisector.cdl index 4250067188..8dee2f96f6 100644 --- a/src/Bisector/Bisector.cdl +++ b/src/Bisector/Bisector.cdl @@ -38,23 +38,13 @@ is deferred class Curve; class BisecAna; - --- Purpose: This class provides the bisecting line between two - -- geometric elements.The elements are Circles,Lines or - -- Points. class BisecPC; - ---Purpose: This class provides the bisecting line between a point - -- a Curve. - + class BisecCC; - ---Purpose: This class provides the bisecting line between two - -- Curves. class Bisec; - ---Purpose: This class provides the bisecting line between two - -- geometris elelements. The bisecting line is - -- trimmed by a point, - + class Inter; class PointOnBis; diff --git a/src/Bisector/Bisector_BisecAna.cdl b/src/Bisector/Bisector_BisecAna.cdl index c61ac43dc8..db5248e2bb 100644 --- a/src/Bisector/Bisector_BisecAna.cdl +++ b/src/Bisector/Bisector_BisecAna.cdl @@ -16,7 +16,9 @@ class BisecAna from Bisector - --- Purpose : + --- Purpose : This class provides the bisecting line between two + -- geometric elements.The elements are Circles,Lines or + -- Points. inherits diff --git a/src/Bnd/Bnd.cdl b/src/Bnd/Bnd.cdl index a688d53735..b7653aca11 100644 --- a/src/Bnd/Bnd.cdl +++ b/src/Bnd/Bnd.cdl @@ -63,8 +63,6 @@ uses Standard, is class Box; - ---Purpose: A box parallel to the main axes. - -- A 3D Bounding. class Array1OfBox instantiates Array1 from TCollection (Box from Bnd); class HArray1OfBox instantiates HArray1 from TCollection @@ -80,8 +78,6 @@ is class Box; class Box2d; - ---Purpose: A rectangle parallel to the main axes. - -- A 2D Bounding. class Array1OfBox2d instantiates Array1 from TCollection (Box2d from Bnd); class HArray1OfBox2d instantiates HArray1 from TCollection @@ -90,15 +86,7 @@ is class Box; class BoundSortBox2d; - ---Purpose: A tool to sort a set of Box2d and compare with an - -- other Box2d to find the list of touched items. - - class BoundSortBox; - ---Purpose: A tool to sort a set of Box and compare with an - -- other Box to find the list of touched items. - - class SeqOfBox instantiates Sequence from TCollection (Box from Bnd); ---Purpose: This sequence used to store the bounding boxes of sub-Shapes. diff --git a/src/BndLib/BndLib.cdl b/src/BndLib/BndLib.cdl index f4873e2119..b3664fe4db 100644 --- a/src/BndLib/BndLib.cdl +++ b/src/BndLib/BndLib.cdl @@ -43,10 +43,8 @@ uses TColgp,Bnd,gp,GeomAbs,Standard, Geom2d, Geom, Adaptor3d ,Adaptor2d is class Add3dCurve; - ---Purpose: Bounding box for a curve in 3d. class Add2dCurve; - ---Purpose: Bounding box for a curve in 2d. class AddSurface; ---Purpose: Bounding box for a surface trimmed or not diff --git a/src/CDF/CDF.cdl b/src/CDF/CDF.cdl index aacd79340a..e9ffe73b08 100644 --- a/src/CDF/CDF.cdl +++ b/src/CDF/CDF.cdl @@ -55,9 +55,7 @@ is -- deferred class MetaDataDriver; - ---Purpose: this class list the method that must be available for - -- a specific DBMS - + exception MetaDataDriverError inherits Failure from Standard; ---Purpose: this exception is used in the deferred methods. -- Programmer implementing such methods may use this diff --git a/src/CDF/CDF_MetaDataDriver.cdl b/src/CDF/CDF_MetaDataDriver.cdl index 67f2ba9cad..106bc35432 100644 --- a/src/CDF/CDF_MetaDataDriver.cdl +++ b/src/CDF/CDF_MetaDataDriver.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. deferred class MetaDataDriver from CDF inherits Transient from Standard - + ---Purpose: this class list the method that must be available for + -- a specific DBMS uses Document from CDM, MetaData from CDM, diff --git a/src/CDM/CDM.cdl b/src/CDM/CDM.cdl index 11fb431ba1..f9caf62d78 100644 --- a/src/CDM/CDM.cdl +++ b/src/CDM/CDM.cdl @@ -32,12 +32,11 @@ is deferred class Document; class ReferenceIterator; - + class NullMessageDriver; - ---Purpose: a MessageDriver that writes nowhere. class COutMessageDriver; - ---Purpose: aMessageDriver for output to COUT (only ASCII strings) + ---Category: classes to manager automatic naming of documents. diff --git a/src/CDM/CDM_COutMessageDriver.cdl b/src/CDM/CDM_COutMessageDriver.cdl index dc29b4a196..d5ae48f61a 100644 --- a/src/CDM/CDM_COutMessageDriver.cdl +++ b/src/CDM/CDM_COutMessageDriver.cdl @@ -14,6 +14,7 @@ -- commercial license or contractual agreement. class COutMessageDriver from CDM inherits MessageDriver from CDM + ---Purpose: aMessageDriver for output to COUT (only ASCII strings) is Write (me:mutable; aString: ExtString from Standard); diff --git a/src/CDM/CDM_NullMessageDriver.cdl b/src/CDM/CDM_NullMessageDriver.cdl index d15d5b5af2..fe036ad117 100644 --- a/src/CDM/CDM_NullMessageDriver.cdl +++ b/src/CDM/CDM_NullMessageDriver.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class NullMessageDriver from CDM inherits MessageDriver from CDM + ---Purpose: a MessageDriver that writes nowhere. is Create returns NullMessageDriver from CDM; diff --git a/src/CPnts/CPnts.cdl b/src/CPnts/CPnts.cdl index 9ebb322748..c9fe4e9a40 100644 --- a/src/CPnts/CPnts.cdl +++ b/src/CPnts/CPnts.cdl @@ -29,26 +29,14 @@ is imported RealFunction; - ---Purpose: typedef Standard_Real (*CPnts_RealFunction) - -- (const Standard_Real, const Standard_Address) - -- - -- A pointer on a function for MyGaussFunction private class MyGaussFunction; - ---Purpose: for implementation, compute values for Gauss private class MyRootFunction; - ---Purpose: for implementation, compute Length and Derivative - -- of the curve for Newton. class AbscissaPoint; - ---Purpose: - -- This algorithm computes a point and its parameter - -- as the distance between this and a given point is the abscissa class UniformDeflection; - --- Purpose : This Algorithm computes a distribution of points - -- with a given chordal deviation on a parametrized curve. end CPnts; diff --git a/src/CPnts/CPnts_MyGaussFunction.cdl b/src/CPnts/CPnts_MyGaussFunction.cdl index 05d84681c5..62e72601e9 100644 --- a/src/CPnts/CPnts_MyGaussFunction.cdl +++ b/src/CPnts/CPnts_MyGaussFunction.cdl @@ -16,6 +16,7 @@ private class MyGaussFunction from CPnts inherits Function from math + ---Purpose: for implementation, compute values for Gauss uses RealFunction from CPnts diff --git a/src/CPnts/CPnts_MyRootFunction.cdl b/src/CPnts/CPnts_MyRootFunction.cdl index 73d5d47a8b..fdb75e6c9e 100644 --- a/src/CPnts/CPnts_MyRootFunction.cdl +++ b/src/CPnts/CPnts_MyRootFunction.cdl @@ -20,6 +20,7 @@ inherits FunctionWithDerivative from math ---Purpose: Implements a function for the Newton algorithm to find the -- solution of Integral(F) = L +-- (compute Length and Derivative of the curve for Newton) uses MyGaussFunction from CPnts, diff --git a/src/CPnts/CPnts_RealFunction.hxx b/src/CPnts/CPnts_RealFunction.hxx index 7cb326fe93..d0853b012e 100644 --- a/src/CPnts/CPnts_RealFunction.hxx +++ b/src/CPnts/CPnts_RealFunction.hxx @@ -19,6 +19,8 @@ #include +//! A pointer on a function for MyGaussFunction + typedef Standard_Real (*CPnts_RealFunction)(const Standard_Real, const Standard_Address); diff --git a/src/CPnts/CPnts_UniformDeflection.cdl b/src/CPnts/CPnts_UniformDeflection.cdl index 9aaccf1ec7..a338530e9b 100644 --- a/src/CPnts/CPnts_UniformDeflection.cdl +++ b/src/CPnts/CPnts_UniformDeflection.cdl @@ -16,8 +16,9 @@ class UniformDeflection from CPnts - ---Purpose : This classe defines an algorithm to create a set of points at the - -- positions of constant deflection of a given curve or a trimmed + ---Purpose : This class defines an algorithm to create a set of points + -- (with a given chordal deviation) at the + -- positions of constant deflection of a given parametrized curve or a trimmed -- circle. -- The continuity of the curve must be at least C2. -- diff --git a/src/CSLib/CSLib.cdl b/src/CSLib/CSLib.cdl index 707488b8a0..6b78088e07 100644 --- a/src/CSLib/CSLib.cdl +++ b/src/CSLib/CSLib.cdl @@ -86,19 +86,8 @@ is -- -- D1NuIsParallelD1Nv : The angle between D1Nu and D1Nv is Null. - class Class2d; - ---Purpose: - -- - -- *** Class2d : Low level algorithm for 2d classification - -- this class was moved from package BRepTopAdaptor + class Class2d; - - - - - --- Purpose : - -- The following functions computes the normal to a surface - private class NormalPolyDef; --- Purpose : -- The following functions computes the normal to a surface diff --git a/src/CSLib/CSLib_Class2d.cdl b/src/CSLib/CSLib_Class2d.cdl index 726390ba7f..63e1876c97 100644 --- a/src/CSLib/CSLib_Class2d.cdl +++ b/src/CSLib/CSLib_Class2d.cdl @@ -16,6 +16,10 @@ class Class2d from CSLib + ---Purpose: + -- *** Class2d : Low level algorithm for 2d classification + -- this class was moved from package BRepTopAdaptor + uses Pnt2d from gp, Array1OfPnt2d from TColgp diff --git a/src/ChFi3d/ChFi3d.cdl b/src/ChFi3d/ChFi3d.cdl index 72ad90d20b..f7c43fe65f 100644 --- a/src/ChFi3d/ChFi3d.cdl +++ b/src/ChFi3d/ChFi3d.cdl @@ -48,17 +48,12 @@ uses ChFiDS, is deferred class Builder; - ---Purpose: Structure and methods common for the construction - -- of fillets and chamfers 3d. class ChBuilder; - ---Purpose: Tool constructing chamfers on a solid. class FilBuilder; - ---Purpose: Outil de construction de conges sur un solide. - + private class SearchSing; - ---Purpose: Searches singularities on fillet enumeration FilletShape is Rational, diff --git a/src/ChFi3d/ChFi3d_ChBuilder.cdl b/src/ChFi3d/ChFi3d_ChBuilder.cdl index 896165096b..f74bb767fc 100644 --- a/src/ChFi3d/ChFi3d_ChBuilder.cdl +++ b/src/ChFi3d/ChFi3d_ChBuilder.cdl @@ -16,7 +16,7 @@ class ChBuilder from ChFi3d inherits Builder from ChFi3d - ---Purpose: construction tool for 3D chamfers on edges. + ---Purpose: construction tool for 3D chamfers on edges (on a solid). uses Shape from TopoDS, diff --git a/src/ChFi3d/ChFi3d_FilBuilder.cdl b/src/ChFi3d/ChFi3d_FilBuilder.cdl index 273a44bb5d..2ca484853b 100644 --- a/src/ChFi3d/ChFi3d_FilBuilder.cdl +++ b/src/ChFi3d/ChFi3d_FilBuilder.cdl @@ -16,7 +16,7 @@ class FilBuilder from ChFi3d inherits Builder from ChFi3d - ---Purpose: Tool of construction of fillets 3d on edges. + ---Purpose: Tool of construction of fillets 3d on edges (on a solid). uses Shape from TopoDS, diff --git a/src/ChFi3d/ChFi3d_SearchSing.cdl b/src/ChFi3d/ChFi3d_SearchSing.cdl index c3509fdc59..6b99e3457a 100644 --- a/src/ChFi3d/ChFi3d_SearchSing.cdl +++ b/src/ChFi3d/ChFi3d_SearchSing.cdl @@ -16,7 +16,8 @@ private class SearchSing from ChFi3d inherits FunctionWithDerivative from math - ---Purpose: F(t) = (C1(t) - C2(t)).(C1'(t) - C2'(t)); + ---Purpose: Searches singularities on fillet. + -- F(t) = (C1(t) - C2(t)).(C1'(t) - C2'(t)); uses Curve from Geom diff --git a/src/ChFiDS/ChFiDS.cdl b/src/ChFiDS/ChFiDS.cdl index 9463b177bd..8ffe019654 100644 --- a/src/ChFiDS/ChFiDS.cdl +++ b/src/ChFiDS/ChFiDS.cdl @@ -52,8 +52,6 @@ is class Regul; - ---Purpose: Grouping of indices of a curve and of faces/surfaces - -- that it relies on coding of regularities. class Regularities instantiates List from TCollection (Regul from ChFiDS); @@ -70,20 +68,12 @@ is (CircSection from ChFiDS,SecArray1 from ChFiDS); class Map; - ---Purpose: encapsulation of IndexedDataMapOfShapeListOfShape - class CommonPoint; - ---Purpose: point start/end of fillet common to 2 adjacent filets - -- and to an edge on one of 2 faces participating - -- in the construction of the fillet class FaceInterference; - ---Purpose: interference face/fillet class SurfData; - ---Purpose: data structure for all information related to the - -- fillet and to 2 faces vis a vis class SequenceOfSurfData instantiates Sequence from TCollection (SurfData from ChFiDS); @@ -93,7 +83,6 @@ is SequenceOfSurfData from ChFiDS); class Stripe; - ---Purpose: Data caracterising a band of fillet. class ListOfStripe instantiates List from TCollection (Stripe from ChFiDS); @@ -104,31 +93,20 @@ is ShapeMapHasher from TopTools); class StripeMap; - ---Purpose: encapsulation of IndexedDataMapOfVertexListOfStripe class ElSpine; - ---Purpose: Spin elementary calculated approximation d un - -- troncon de spine. - + class HElSpine instantiates GenHCurve from Adaptor3d (ElSpine from ChFiDS); class ListOfHElSpine instantiates List from TCollection (HElSpine from ChFiDS); class Spine; - ---Purpose: list of edges allowing the construction of fillet - -- or chamfer. Such edges are mutually tangent - -- and cross tangent faces. - class FilSpine; --- inherits Sp - ---Purpose: Contains more information relative to the vector. - class ChamfSpine; --- inherits Sp - ---Purpose: Contains characteristics of the chamfer. - -- pour tous les chanfreins - + class SequenceOfSpine instantiates Sequence from TCollection(Spine from ChFiDS); diff --git a/src/ChFiDS/ChFiDS_CommonPoint.cdl b/src/ChFiDS/ChFiDS_CommonPoint.cdl index 7f07cb45a3..16e4681cd9 100644 --- a/src/ChFiDS/ChFiDS_CommonPoint.cdl +++ b/src/ChFiDS/ChFiDS_CommonPoint.cdl @@ -16,7 +16,9 @@ class CommonPoint from ChFiDS - ---Purpose: + ---Purpose: point start/end of fillet common to 2 adjacent filets + -- and to an edge on one of 2 faces participating + -- in the construction of the fillet uses Orientation from TopAbs, Vertex from TopoDS, diff --git a/src/ChFiDS/ChFiDS_Spine.cdl b/src/ChFiDS/ChFiDS_Spine.cdl index e77a2d95af..f9deaf3c96 100644 --- a/src/ChFiDS/ChFiDS_Spine.cdl +++ b/src/ChFiDS/ChFiDS_Spine.cdl @@ -17,7 +17,7 @@ class Spine from ChFiDS inherits TShared from MMgt ---Purpose: Contains information necessary for construction of - -- a 3D fillet : + -- a 3D fillet or chamfer: -- -- -- - guideline composed of edges of the solid, tangents diff --git a/src/ChFiDS/ChFiDS_Stripe.cdl b/src/ChFiDS/ChFiDS_Stripe.cdl index 876c448b8b..62f44ab73f 100644 --- a/src/ChFiDS/ChFiDS_Stripe.cdl +++ b/src/ChFiDS/ChFiDS_Stripe.cdl @@ -16,7 +16,7 @@ class Stripe from ChFiDS inherits TShared - ---Purpose: data structure associe au coin + ---Purpose: Data characterising a band of fillet. uses HData from ChFiDS, Spine from ChFiDS, diff --git a/src/ChFiDS/ChFiDS_StripeMap.cdl b/src/ChFiDS/ChFiDS_StripeMap.cdl index 8cb5ca8e4c..5c65c63f35 100644 --- a/src/ChFiDS/ChFiDS_StripeMap.cdl +++ b/src/ChFiDS/ChFiDS_StripeMap.cdl @@ -16,7 +16,7 @@ class StripeMap from ChFiDS - ---Purpose: + ---Purpose: encapsulation of IndexedDataMapOfVertexListOfStripe uses IndexedDataMapOfVertexListOfStripe from ChFiDS, diff --git a/src/ChFiDS/ChFiDS_SurfData.cdl b/src/ChFiDS/ChFiDS_SurfData.cdl index f9e2897d2e..6fa80a5302 100644 --- a/src/ChFiDS/ChFiDS_SurfData.cdl +++ b/src/ChFiDS/ChFiDS_SurfData.cdl @@ -16,7 +16,8 @@ class SurfData from ChFiDS inherits TShared from MMgt - ---Purpose: + ---Purpose: data structure for all information related to the + -- fillet and to 2 faces vis a vis uses Pnt2d from gp, diff --git a/src/ChFiKPart/ChFiKPart.cdl b/src/ChFiKPart/ChFiKPart.cdl index 7dee6a542a..112b5a93db 100644 --- a/src/ChFiKPart/ChFiKPart.cdl +++ b/src/ChFiKPart/ChFiKPart.cdl @@ -44,9 +44,6 @@ is MapIntegerHasher from TColStd); class ComputeData; - ---Purpose: Contient toutes les methodes de classe destinees a - -- remplir une SurfData dans les cas particuliers - -- enumeres ci-dessus. end ChFiKPart; diff --git a/src/Convert/Convert.cdl b/src/Convert/Convert.cdl index bb57909ab2..4cac164568 100644 --- a/src/Convert/Convert.cdl +++ b/src/Convert/Convert.cdl @@ -16,7 +16,7 @@ package Convert - --- Purpose: + --- Purpose: --The Convert package provides algorithms to convert the following into a BSpline curve or surface: -- - a bounded curve based on an elementary 2D curve (line, circle or conic) from the gp package, -- - a bounded surface based on an elementary surface (cylinder, cone, sphere or torus) from the gp package, @@ -27,7 +27,7 @@ package Convert -- or the surface by calling the appropriate constructor provided by the classes -- Geom2d_BSplineCurve, Geom_BSplineCurve or Geom_BSplineSurface. -uses TColStd, +uses TColStd, TColgp, StdFail, gp, @@ -109,7 +109,7 @@ enumeration ParameterisationType is QuasiAngular, RationalC1, Polynomial; - + imported CosAndSinEvalFunction ; @@ -119,70 +119,32 @@ enumeration ParameterisationType is -- const TColStd_Array1OfReal& -- const TColStd_Array1OfInteger& -- Standard_Real Result[2] - -- - + -- + deferred class ConicToBSplineCurve; - --- Purpose : - -- Super class of the following classes : - class CircleToBSplineCurve; - --- Purpose : Converts a circle into a B-spline curve. - class EllipseToBSplineCurve; - --- Purpose : Converts an ellipse into a B-spline curve. - class HyperbolaToBSplineCurve; - --- Purpose : Converts an hyperbola into a B-spline curve. - class ParabolaToBSplineCurve; - --- Purpose : Converts a parabola into a B-spline curve. - - - deferred class ElementarySurfaceToBSplineSurface; - -- Super class of the following classes : - class CylinderToBSplineSurface; - --- Purpose : Converts a bounded cylinder into a B-spline surface. - class ConeToBSplineSurface; - --- Purpose : Converts a bounded cone into a B-spline surface. - class TorusToBSplineSurface; - --- Purpose : Converts a torus into a B-spline surface. - class SphereToBSplineSurface; - --- Purpose : Converts a sphere into a B-spline surface. - - class SequenceOfArray1OfPoles instantiates Sequence from TCollection( HArray1OfPnt from TColgp); - + class CompBezierCurvesToBSplineCurve; - ---Purpose: Converts a list of connecting BezierCurves - -- into a B-spline curve. - + alias SequenceOfArray1OfPoles2d is SequenceOfArray1OfPnt2d from TColgp; - - + class CompBezierCurves2dToBSplineCurve2d; - ---Purpose: Converts a list of connecting BezierCurves - -- into a B-spline curve. class CompPolynomialToPoles; - ---Purpose: Convert a serie of Polynomial N-Dimensional - -- Curves that are have continuity CM to an - -- N-Dimensional Bspline Curve that has continuity - -- CM - + class GridPolynomialToPoles; - ---Purpose: Convert a grid of Polynomial Surfaces - -- that are have continuity CM to an - -- Bspline Surface that has continuity - -- CM - - + end Convert; diff --git a/src/Convert/Convert_CompPolynomialToPoles.cdl b/src/Convert/Convert_CompPolynomialToPoles.cdl index c7a8980bf5..afeed348dc 100644 --- a/src/Convert/Convert_CompPolynomialToPoles.cdl +++ b/src/Convert/Convert_CompPolynomialToPoles.cdl @@ -16,8 +16,10 @@ class CompPolynomialToPoles from Convert - ---Purpose: To convert an function (curve) polynomial by span in a BSpline. - -- + ---Purpose: Convert a serie of Polynomial N-Dimensional Curves + -- that are have continuity CM to an N-Dimensional Bspline Curve + -- that has continuity CM. + -- (to convert an function (curve) polynomial by span in a BSpline) -- This class uses the following arguments : -- NumCurves : the number of Polynomial Curves -- Continuity: the requested continuity for the n-dimensional Spline diff --git a/src/Convert/Convert_GridPolynomialToPoles.cdl b/src/Convert/Convert_GridPolynomialToPoles.cdl index 78e6fb40b1..743af1b6b0 100644 --- a/src/Convert/Convert_GridPolynomialToPoles.cdl +++ b/src/Convert/Convert_GridPolynomialToPoles.cdl @@ -15,8 +15,10 @@ -- commercial license or contractual agreement. class GridPolynomialToPoles from Convert - - ---Purpose: + ---Purpose: Convert a grid of Polynomial Surfaces + -- that are have continuity CM to an + -- Bspline Surface that has continuity + -- CM uses Array1OfReal from TColStd, HArray1OfReal from TColStd, diff --git a/src/DBRep/DBRep.cdl b/src/DBRep/DBRep.cdl index 596802f183..c5dd6256fb 100644 --- a/src/DBRep/DBRep.cdl +++ b/src/DBRep/DBRep.cdl @@ -41,27 +41,22 @@ uses is - class Edge; - ---Purpose: Display of an edge. Edge + color. + class Edge; class ListOfEdge instantiates List from TCollection(Edge from DBRep); class Face; - ---Purpose: Display of a face. Face + Array of iso + color. class ListOfFace instantiates List from TCollection(Face from DBRep); class HideData; - ---Purpose: Hidden lines data for a view class ListOfHideData instantiates List from TCollection(HideData from DBRep); class DrawableShape; - ---Purpose: Drawable structure to display a shape. Contains a - -- list of edges and a list of faces. class IsoBuilder; ---Purpose: Creation of isoparametric curves. diff --git a/src/DBRep/DBRep_DrawableShape.cdl b/src/DBRep/DBRep_DrawableShape.cdl index 92d6a761d3..4d819bbf51 100644 --- a/src/DBRep/DBRep_DrawableShape.cdl +++ b/src/DBRep/DBRep_DrawableShape.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class DrawableShape from DBRep inherits Drawable3D from Draw - ---Purpose: + ---Purpose: Drawable structure to display a shape. Contains a + -- list of edges and a list of faces. uses Shape from TopoDS, diff --git a/src/DBRep/DBRep_Edge.cdl b/src/DBRep/DBRep_Edge.cdl index 7e7865cf61..d481718d4f 100644 --- a/src/DBRep/DBRep_Edge.cdl +++ b/src/DBRep/DBRep_Edge.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class Edge from DBRep inherits TShared from MMgt - + ---Purpose: Display of an edge. Edge + color. uses Edge from TopoDS, Color from Draw diff --git a/src/DBRep/DBRep_Face.cdl b/src/DBRep/DBRep_Face.cdl index cb3087f75f..eaaf850e3b 100644 --- a/src/DBRep/DBRep_Face.cdl +++ b/src/DBRep/DBRep_Face.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class Face from DBRep inherits TShared from MMgt - + ---Purpose: Display of a face. Face + Array of iso + color. uses Face from TopoDS, IsoType from GeomAbs, diff --git a/src/DDF/DDF.cdl b/src/DDF/DDF.cdl index f0b5ecf73d..0fbc9101db 100644 --- a/src/DDF/DDF.cdl +++ b/src/DDF/DDF.cdl @@ -40,13 +40,10 @@ is -- ---------------------------------------------------------------------- class Data; - ---Purpose : Encapsulates a data framework from TDF. class Browser; - ---Purpose : Browses a data framework from TDF. class Transaction; - ---Purpose: Encapsulates a Transaction from TDF. class TransactionStack instantiates List from TCollection (Transaction from DDF); diff --git a/src/DDF/DDF_Browser.cdl b/src/DDF/DDF_Browser.cdl index 2c26e0226e..6cb3528942 100644 --- a/src/DDF/DDF_Browser.cdl +++ b/src/DDF/DDF_Browser.cdl @@ -22,7 +22,7 @@ class Browser from DDF inherits Drawable3D from Draw - ---Purpose: Browses a data framework. + ---Purpose: Browses a data framework from TDF. uses diff --git a/src/DDF/DDF_Data.cdl b/src/DDF/DDF_Data.cdl index 919038b228..6848feea21 100644 --- a/src/DDF/DDF_Data.cdl +++ b/src/DDF/DDF_Data.cdl @@ -22,7 +22,7 @@ class Data from DDF inherits Drawable3D from Draw - ---Purpose : Encapsulates a data framework in a drawable object + ---Purpose : Encapsulates a data framework from TDF in a drawable object uses diff --git a/src/DDataStd/DDataStd.cdl b/src/DDataStd/DDataStd.cdl index dd5a2d80a4..7f9bf82596 100644 --- a/src/DDataStd/DDataStd.cdl +++ b/src/DDataStd/DDataStd.cdl @@ -32,16 +32,9 @@ uses Draw, is - ---Purpose: attribute display presentation - -- ============================== - class DrawPresentation; class DrawDriver; - ---Purpose: root class of drivers to build draw variables from TDF_Label. - - ---Purpose: attribute tree presentation - -- =========================== class TreeBrowser; ---Purpose: Used to browse tree nodes. diff --git a/src/DDataStd/DDataStd_DrawDriver.cdl b/src/DDataStd/DDataStd_DrawDriver.cdl index 82a2194e85..8a7db45d6c 100644 --- a/src/DDataStd/DDataStd_DrawDriver.cdl +++ b/src/DDataStd/DDataStd_DrawDriver.cdl @@ -16,7 +16,8 @@ class DrawDriver from DDataStd inherits TShared from MMgt - ---Purpose: priority rule to display standard attributes is : + ---Purpose: Root class of drivers to build draw variables from TDF_Label. + -- Priority rule to display standard attributes is : -- * 1 Constraint -- * 2 Object -- * 3 Datum (Point,Axis,Plane) diff --git a/src/Draw/Draw.cdl b/src/Draw/Draw.cdl index bd3876b141..b4acd3761f 100644 --- a/src/Draw/Draw.cdl +++ b/src/Draw/Draw.cdl @@ -97,26 +97,19 @@ is class Grid; class Box; - ---Purpose: a 3d box - + class SequenceOfDrawable3D instantiates Sequence from TCollection (Drawable3D); class ProgressIndicator; imported PInterp; - ---Purpose: typedef Tcl_Interp * Draw_PInterp; - + primitive CommandFunction; - ---Purpose: typedef Standard_Integer (*Draw_CommandFunction) - -- (Draw_Interpretor&, Standard_Integer, char**) imported Interpretor; - ---Purpose: Encapsulate the Tcl interpretor to add commands. class Printer; - ---Purpose: Implements a printer class to connect Message_Messenger - -- tool to Draw_Interpretor output. class VMap instantiates DataMap from TCollection(Integer, diff --git a/src/Draw/Draw_Box.cdl b/src/Draw/Draw_Box.cdl index 091715d7d2..d1cb552216 100644 --- a/src/Draw/Draw_Box.cdl +++ b/src/Draw/Draw_Box.cdl @@ -16,7 +16,7 @@ class Box from Draw inherits Drawable3D from Draw - ---Purpose: + ---Purpose: a 3d box uses Pnt from gp, Color from Draw, diff --git a/src/Draw/Draw_Printer.cdl b/src/Draw/Draw_Printer.cdl index a178ef012d..bb296b10c4 100644 --- a/src/Draw/Draw_Printer.cdl +++ b/src/Draw/Draw_Printer.cdl @@ -15,7 +15,8 @@ class Printer from Draw inherits Printer from Message - ---Purpose: Implementation of Printer class with output directed to Draw_Interpretor + ---Purpose: Implementation of Printer class with output + -- (Message_Messenge) directed to Draw_Interpretor uses diff --git a/src/DrawDim/DrawDim.cdl b/src/DrawDim/DrawDim.cdl index ccc7e53164..285c80908d 100644 --- a/src/DrawDim/DrawDim.cdl +++ b/src/DrawDim/DrawDim.cdl @@ -34,18 +34,11 @@ is deferred class Dimension; - - ---Purpose: Dimension between planes and cylinder - -- ===================================== - + class Angle; class Distance; class Radius; - - ---Purpose: Dimensions between point, line and circle ON a plane - -- ==================================================== - deferred class PlanarDimension; class PlanarAngle; diff --git a/src/DrawDim/DrawDim_Dimension.cdl b/src/DrawDim/DrawDim_Dimension.cdl index 61fdc4596f..85891e4d95 100644 --- a/src/DrawDim/DrawDim_Dimension.cdl +++ b/src/DrawDim/DrawDim_Dimension.cdl @@ -16,7 +16,7 @@ deferred class Dimension from DrawDim inherits Drawable3D from Draw - ---Purpose: + ---Purpose: Dimension between planes and cylinder uses Real from Standard, diff --git a/src/DrawDim/DrawDim_PlanarDimension.cdl b/src/DrawDim/DrawDim_PlanarDimension.cdl index 7cad824d02..2665f0e9da 100644 --- a/src/DrawDim/DrawDim_PlanarDimension.cdl +++ b/src/DrawDim/DrawDim_PlanarDimension.cdl @@ -16,7 +16,7 @@ deferred class PlanarDimension from DrawDim inherits Dimension from DrawDim - ---Purpose: + ---Purpose: Dimensions between point, line and circle ON a plane uses Face from TopoDS diff --git a/src/FEmTool/FEmTool.cdl b/src/FEmTool/FEmTool.cdl index 9eacb72a2f..7025193cde 100644 --- a/src/FEmTool/FEmTool.cdl +++ b/src/FEmTool/FEmTool.cdl @@ -28,22 +28,18 @@ uses is class Assembly; - - ---Purpose: To define Criterium (or Energy) on finite element + deferred class ElementaryCriterion; class LinearTension; class LinearFlexion; class LinearJerk; - - ---Purpose: To define sparse Matrix + + deferred class SparseMatrix; class ProfileMatrix; - ---Purpose: Do define one curves with Finite Element class Curve; - ---Purpose: To define set of functions for calculating matrix - -- elements of RefMatrix by Gauss integration. class ElementsOfRefMatrix; -- instantiate classes diff --git a/src/FEmTool/FEmTool_ElementsOfRefMatrix.cdl b/src/FEmTool/FEmTool_ElementsOfRefMatrix.cdl index 0b568165ed..5620a77c42 100644 --- a/src/FEmTool/FEmTool_ElementsOfRefMatrix.cdl +++ b/src/FEmTool/FEmTool_ElementsOfRefMatrix.cdl @@ -18,7 +18,7 @@ class ElementsOfRefMatrix from FEmTool inherits FunctionSet from math ---Purpose: this class describes the functions needed for -- calculating matrix elements of RefMatrix for linear - -- criteriums (Tension, Flexsion and Jerk). + -- criteriums (Tension, Flexsion and Jerk) by Gauss integration. -- Each function from set gives value Pi(u)'*Pj(u)' or -- Pi(u)''*Pj(u)'' or Pi(u)'''*Pj(u)''' for each i and j, -- where Pi(u) is i-th basis function of expansion and diff --git a/src/FEmTool/FEmTool_LinearJerk.cdl b/src/FEmTool/FEmTool_LinearJerk.cdl index 31077c5de4..5b27b7ded8 100644 --- a/src/FEmTool/FEmTool_LinearJerk.cdl +++ b/src/FEmTool/FEmTool_LinearJerk.cdl @@ -16,7 +16,7 @@ class LinearJerk from FEmTool inherits ElementaryCriterion from FEmTool - ---Purpose: Criterion of LinearFlexion To Hermit-Jacobi elements + ---Purpose: Criterion of LinearJerk To Hermit-Jacobi elements uses Vector from math, diff --git a/src/GC/GC.cdl b/src/GC/GC.cdl index 5501845de5..02b7bcdc9e 100644 --- a/src/GC/GC.cdl +++ b/src/GC/GC.cdl @@ -35,31 +35,22 @@ private deferred class Root; --------------------------------------------------------------------------- class MakeLine; - ---Purpose: Makes a Line from Geom. class MakeCircle; - ---Purpose: Makes a Circle from Geom. class MakeHyperbola; - ---Purpose: Makes an hyperbola from Geom. class MakeEllipse; - ---Purpose: Makes an ellipse from Geom. class MakeSegment; - ---Purpose: Makes a segment of Line from the 2 points and . class MakeArcOfCircle; - ---Purpose: Makes an arc of circle (TrimmedCurve from Geom). class MakeArcOfEllipse; - ---Purpose: Makes an arc of Ellipse (TrimmedCurve from Geom). class MakeArcOfHyperbola; - ---Purpose: Makes an arc of hyperbola (TrimmedCurve from Geom). class MakeArcOfParabola; - ---Purpose: Makes an arc of parabola (TrimmedCurve from Geom). --------------------------------------------------------------------------- -- Constructions of planes from Geom. @@ -72,33 +63,23 @@ class MakePlane; --------------------------------------------------------------------------- class MakeCylindricalSurface; - ---Purpose: Makes a cylindricalSurface from Geom. class MakeConicalSurface; - ---Purpose: Makes a ConicalSurface from Geom. class MakeTrimmedCylinder; - ---Purpose: Makes a cylindricalSurface from Geom class MakeTrimmedCone; - ---Purpose: Makes a ConicalSurface from Geom --------------------------------------------------------------------------- -- Constructions of Transformation from Geom. --------------------------------------------------------------------------- class MakeTranslation; - ---Purpose: Returns a translation transformation of vector . class MakeMirror; - ---Purpose: Returns a symmetry transformation of center

. class MakeRotation; - ---Purpose: Returns a rotation transformation around the axis - -- and of angle . class MakeScale; - ---Purpose: Returns a scaling transformation with the center point - -- and the scaling value . end GC; diff --git a/src/GC/GC_MakeScale.cdl b/src/GC/GC_MakeScale.cdl index d3207f4423..c27143e590 100644 --- a/src/GC/GC_MakeScale.cdl +++ b/src/GC/GC_MakeScale.cdl @@ -20,7 +20,8 @@ from GC ---Purpose: This class implements an elementary construction algorithm for -- a scaling transformation in 3D space. The result is a - -- Geom_Transformation transformation. + -- Geom_Transformation transformation (a scaling transformation with + -- the center point and the scaling value ). -- A MakeScale object provides a framework for: -- - defining the construction of the transformation, -- - implementing the construction algorithm, and diff --git a/src/GC/GC_MakeSegment.cdl b/src/GC/GC_MakeSegment.cdl index 519148aff4..ca6dcc0456 100644 --- a/src/GC/GC_MakeSegment.cdl +++ b/src/GC/GC_MakeSegment.cdl @@ -16,14 +16,16 @@ class MakeSegment from GC inherits Root from GC - --- Purpose: Implements construction algorithms for a line - -- segment in 3D space. The result is a Geom_TrimmedCurve curve. - -- A MakeSegment object provides a framework for: - -- - defining the construction of the line segment, - -- - implementing the construction algorithm, and - -- - consulting the results. In particular, the Value - -- function returns the constructed line segment. - + --- Purpose: Implements construction algorithms for a line + -- segment in 3D space. + -- Makes a segment of Line from the 2 points and . + -- The result is a Geom_TrimmedCurve curve. + -- A MakeSegment object provides a framework for: + -- - defining the construction of the line segment, + -- - implementing the construction algorithm, and + -- - consulting the results. In particular, the Value + -- function returns the constructed line segment. + uses Pnt from gp, Real from Standard, Lin from gp, diff --git a/src/GC/GC_MakeTranslation.cdl b/src/GC/GC_MakeTranslation.cdl index 6e72513d30..f87647128a 100644 --- a/src/GC/GC_MakeTranslation.cdl +++ b/src/GC/GC_MakeTranslation.cdl @@ -18,13 +18,13 @@ class MakeTranslation from GC - ---Purpose: This class mplements elementary construction algorithms for a - -- translation in 3D space. The result is a - -- Geom_Transformation transformation. - -- A MakeTranslation object provides a framework for: - -- - defining the construction of the transformation, - -- - implementing the construction algorithm, and - -- - consulting the result. + ---Purpose: This class implements elementary construction algorithms for a + -- translation in 3D space. The result is a + -- Geom_Transformation transformation. + -- A MakeTranslation object provides a framework for: + -- - defining the construction of the transformation, + -- - implementing the construction algorithm, and + -- - consulting the result. uses Pnt from gp, Transformation from Geom, diff --git a/src/GCE2d/GCE2d.cdl b/src/GCE2d/GCE2d.cdl index ac844be742..dbfd352c82 100644 --- a/src/GCE2d/GCE2d.cdl +++ b/src/GCE2d/GCE2d.cdl @@ -36,50 +36,36 @@ private deferred class Root; --------------------------------------------------------------------------- class MakeLine; - ---Purpose: Makes a Line from Geom2d. class MakeCircle; - ---Purpose: Makes a Circle from Geom2d. class MakeHyperbola; - ---Purpose: Makes an hyperbola from Geom2d. class MakeEllipse; - ---Purpose: Makes an Ellipse from Geom2d. class MakeParabola; - ---Purpose: Makes a parabola from Geom2d. class MakeSegment; - ---Purpose: Makes a segment of Line (TrimmedCurve from Geom2d). class MakeArcOfCircle; - ---Purpose: Makes an arc of circle (TrimmedCurve from Geom2d). class MakeArcOfEllipse; - ---Purpose: Makes an arc of ellipse (TrimmedCurve from Geom2d). class MakeArcOfParabola; - ---Purpose: Makes an arc of parabola (TrimmedCurve from Geom2d). class MakeArcOfHyperbola; - ---Purpose: Makes an arc of hyperbola (TrimmedCurve from Geom2d). --------------------------------------------------------------------------- -- Constructions of Transformation from Geom2d. --------------------------------------------------------------------------- class MakeTranslation; - ---Purpose: Returns a translation transformation. class MakeMirror; - ---Purpose: Returns a symmetry transformation. class MakeRotation; - ---Purpose: Returns a rotation transformation. class MakeScale; - ---Purpose: Returns a scaling transformation. end GCE2d; diff --git a/src/GCE2d/GCE2d_MakeCircle.cdl b/src/GCE2d/GCE2d_MakeCircle.cdl index 71436c61dd..f936b45cd9 100644 --- a/src/GCE2d/GCE2d_MakeCircle.cdl +++ b/src/GCE2d/GCE2d_MakeCircle.cdl @@ -17,7 +17,7 @@ class MakeCircle from GCE2d inherits Root from GCE2d ---Purpose : This class implements the following algorithms used - -- to create Cirlec from Geom2d. + -- to create Circle from Geom2d. -- -- * Create a Circle parallel to another and passing -- though a point. diff --git a/src/GCE2d/GCE2d_MakeEllipse.cdl b/src/GCE2d/GCE2d_MakeEllipse.cdl index 1e2ddec9c4..7db14ad90b 100644 --- a/src/GCE2d/GCE2d_MakeEllipse.cdl +++ b/src/GCE2d/GCE2d_MakeEllipse.cdl @@ -17,7 +17,7 @@ class MakeEllipse from GCE2d inherits Root from GCE2d ---Purpose :This class implements the following algorithms used to - -- create Ellipse from gp. + -- create Ellipse from Geom2d. -- * Create an Ellipse from two apex and the center. -- Defines an ellipse in 2D space. -- The parametrization range is [0,2*PI]. diff --git a/src/GProp/GProp.cdl b/src/GProp/GProp.cdl index e108a9c888..aac5d18e76 100644 --- a/src/GProp/GProp.cdl +++ b/src/GProp/GProp.cdl @@ -70,44 +70,18 @@ enumeration ValueType class GProps; - --- Purpose : - -- Computes the global properties of a compound geometric - -- system in 3d space. It gives facilities to compose the - -- properties of hetegogeneous elements of the system - -- (PGProps, CGProps, SGProps, VGProps or GProps). A density - -- can be associated with each component of the system. - class PGProps; - --- Purpose : - -- Computes the global properties of a set of points in 3d. - -- This class inherits GProps. class CelGProps; - ---Purpose : - -- Computes the global properties of a gp curve in 3d - -- This class inherits GProps. class SelGProps; - ---Purpose : - -- Computes the global properties and the area of a bounded - -- elementary surface in 3d. This class inherits GProps. class VelGProps; - ---Purpose : - -- Computes the global properties and the volume of a region - -- of space. the region of space is defined by an elementary - -- surface. This class inherits GProps. - class PrincipalProps; - ---Purpose : - -- Returns the principal inertia properties of a GProps. - - - --- Purpose : -- The following abstract classes define templates -- with the minimum of methods required to implement -- the computation of the global properties for a curve diff --git a/src/GProp/GProp_SelGProps.cdl b/src/GProp/GProp_SelGProps.cdl index 5cbe2d6771..793fe29ce5 100644 --- a/src/GProp/GProp_SelGProps.cdl +++ b/src/GProp/GProp_SelGProps.cdl @@ -17,8 +17,8 @@ class SelGProps from GProp inherits GProps ---Purpose: - -- Computes the global properties of an elementary - -- surface (surface of the gp package) + -- Computes the global properties of a bounded + -- elementary surface in 3d (surface of the gp package) uses Cylinder from gp, Cone from gp, diff --git a/src/GProp/GProp_VelGProps.cdl b/src/GProp/GProp_VelGProps.cdl index 18d31deffd..8091060641 100644 --- a/src/GProp/GProp_VelGProps.cdl +++ b/src/GProp/GProp_VelGProps.cdl @@ -17,9 +17,9 @@ class VelGProps from GProp inherits GProps --- Purpose : - -- Computes the global properties of a geometric solid - -- (3D closed region of space) - -- The solid can be elementary(definition in the gp package) + -- Computes the global properties and the volume of a geometric solid + -- (3D closed region of space) + -- The solid can be elementary(definition in the gp package) uses Cone from gp, diff --git a/src/GccAna/GccAna.cdl b/src/GccAna/GccAna.cdl index a8255b6179..3c3122ecfc 100644 --- a/src/GccAna/GccAna.cdl +++ b/src/GccAna/GccAna.cdl @@ -36,58 +36,33 @@ is exception NoSolution inherits Failure from Standard; class Lin2dTanPar; - ---Purpose : Creates a 2d line TANgent to an 2d entity and PARallel - -- to another 2d line. class Lin2dTanPer; - ---Purpose : Creates a 2d line TANgent to an 2d entity and PERpendicular - -- to another 2d entity. class Lin2dTanObl; - ---Purpose : Creates a 2d line TANgent to an 2d entity and OBLic - -- to another 2d entity. class Lin2d2Tan; - ---Purpose : Creates a 2d line TANgent to 2 2d entities. class Lin2dBisec; - ---Purpose : Creates a 2d line BISECting line of 2 2d lines. class Circ2dTanCen; - ---Purpose : Creates a 2d circle TANgent to a 2d entity and CENtered - -- on a 2d point. class Circ2d3Tan; - ---Purpose : Creates a 2d circle TANgent to 3 2d entities. class Circ2d2TanRad; - ---Purpose : Creates a 2d circle TANgent to 2 2d entities with - -- the given RADius. class Circ2d2TanOn; - ---Purpose : Creates a 2d circle TANgent to a 2d entity and centered - -- ON a 2d entity (not a point). class Circ2dTanOnRad; - ---Purpose : Creates a 2d circle TANgent to a 2d entity and centered - -- ON a 2d entity (not a point) with the given radius. class Pnt2dBisec; - ---Purpose : Creates a 2d line BISECting line of 2 2d points. class Circ2dBisec; - ---Purpose : Creates a 2d line BISECting line of 2 2d circles. class CircLin2dBisec; - ---Purpose : Creates a 2d line BISECting line of a 2d circle - -- and a 2d line. class CircPnt2dBisec; - ---Purpose : Creates a 2d line BISECting line of a 2d circle - -- and a 2d point. class LinPnt2dBisec; - ---Purpose : Creates a 2d line BISECting line of a 2d line - -- and a 2d point. end GccAna; diff --git a/src/Geom2dAdaptor/Geom2dAdaptor.cdl b/src/Geom2dAdaptor/Geom2dAdaptor.cdl index edfe9106b1..d4f7ff559d 100644 --- a/src/Geom2dAdaptor/Geom2dAdaptor.cdl +++ b/src/Geom2dAdaptor/Geom2dAdaptor.cdl @@ -33,7 +33,6 @@ is class Curve; - ---Purpose: Similar to Curve2d from Adaptor2d with a Curve from Geom2d. private class GHCurve instantiates GenHCurve2d from Adaptor2d (Curve from Geom2dAdaptor); diff --git a/src/Geom2dConvert/Geom2dConvert.cdl b/src/Geom2dConvert/Geom2dConvert.cdl index 30af5c5f7f..7ae91e2768 100644 --- a/src/Geom2dConvert/Geom2dConvert.cdl +++ b/src/Geom2dConvert/Geom2dConvert.cdl @@ -44,25 +44,11 @@ is class BSplineCurveKnotSplitting; - --- Purpose : - -- This algorithm searches the knot values corresponding to the - -- splitting of a given B-spline curve into several arcs with - -- the same continuity. The continuity order is given at the - -- construction time. It is possible to compute the curve arcs - -- corresponding to this splitting with the method of package - -- SplitBSplineCurve. - - class BSplineCurveToBezierCurve; - --- Purpose : - -- This algorithm converts a B-spline curve from the package Geom - -- into several Bezier curves. class CompCurveToBSplineCurve; - --- Purpose : - -- This algorithm converts and concat sevral curve in a - -- B-spline curve. + class ApproxCurve; ---Purpose : -- Convert a curve to BSpline by Approximation -- diff --git a/src/Geom2dConvert/Geom2dConvert_BSplineCurveKnotSplitting.cdl b/src/Geom2dConvert/Geom2dConvert_BSplineCurveKnotSplitting.cdl index 5a49175aaf..f1dd78b222 100644 --- a/src/Geom2dConvert/Geom2dConvert_BSplineCurveKnotSplitting.cdl +++ b/src/Geom2dConvert/Geom2dConvert_BSplineCurveKnotSplitting.cdl @@ -22,7 +22,8 @@ class BSplineCurveKnotSplitting from Geom2dConvert -- If you require curves with a minimum continuity for -- your computation, it is useful to know the points -- between which an arc has a continuity of a given - -- order. For a BSpline curve, the discontinuities are + -- order. The continuity order is given at the construction time. + -- For a BSpline curve, the discontinuities are -- localized at the knot values. Between two knot values -- the BSpline is infinitely and continuously -- differentiable. At a given knot, the continuity is equal diff --git a/src/Geom2dConvert/Geom2dConvert_CompCurveToBSplineCurve.cdl b/src/Geom2dConvert/Geom2dConvert_CompCurveToBSplineCurve.cdl index 49e48786f4..b7bf11d156 100644 --- a/src/Geom2dConvert/Geom2dConvert_CompCurveToBSplineCurve.cdl +++ b/src/Geom2dConvert/Geom2dConvert_CompCurveToBSplineCurve.cdl @@ -16,7 +16,7 @@ class CompCurveToBSplineCurve from Geom2dConvert - ---Purpose: Concat sevral curve in an BSplineCurve + ---Purpose: This algorithm converts and concat several curve in an BSplineCurve uses ParameterisationType from Convert, diff --git a/src/Geom2dLProp/Geom2dLProp.cdl b/src/Geom2dLProp/Geom2dLProp.cdl index 78ea1c0640..d135efd61b 100644 --- a/src/Geom2dLProp/Geom2dLProp.cdl +++ b/src/Geom2dLProp/Geom2dLProp.cdl @@ -41,8 +41,6 @@ is private class FuncCurExt; private class FuncCurNul; class NumericCurInf2d; - ---Purpose: Computes the locals extremas of curvature and the - -- inflections of a bounded curve in 2d. end Geom2dLProp; diff --git a/src/GeomAPI/GeomAPI.cdl b/src/GeomAPI/GeomAPI.cdl index d2de45dc10..82594493c7 100644 --- a/src/GeomAPI/GeomAPI.cdl +++ b/src/GeomAPI/GeomAPI.cdl @@ -99,12 +99,9 @@ is --- Approximation: -- class PointsToBSpline; - ---Purpose: To fit a curve. - + class PointsToBSplineSurface; - ---Purpose: To fit a surface. - - + --- Interpolation: -- class Interpolate; @@ -116,10 +113,8 @@ is ------------------------------------------------------------------ class IntSS; - ---Purpose: To intersect two surfaces. class IntCS; - ---Purpose: To intersect a curve and a surface. ------------------------------------------------------------------ diff --git a/src/GeomAdaptor/GeomAdaptor.cdl b/src/GeomAdaptor/GeomAdaptor.cdl index 7bdde11234..55008f583d 100644 --- a/src/GeomAdaptor/GeomAdaptor.cdl +++ b/src/GeomAdaptor/GeomAdaptor.cdl @@ -32,19 +32,13 @@ uses is class Curve; - ---Purpose: creation of the loaded curve the curve is C1 by piece. - -- Inherits Curve from Adaptor3d class Surface; - ---Purpose: creation of the loaded surface the surface is C1 by piece - -- Inherits Surface from Adaptor3d private class GHSurface instantiates GenHSurface from Adaptor3d (Surface from GeomAdaptor); class HSurface; - ---Purpose: Inherited from GHSurface. Provides a surface - -- handled by reference. private class GHCurve instantiates GenHCurve from Adaptor3d (Curve from GeomAdaptor); diff --git a/src/GeomAdaptor/GeomAdaptor_Curve.cdl b/src/GeomAdaptor/GeomAdaptor_Curve.cdl index 65d6c2d2da..1c5774db2e 100644 --- a/src/GeomAdaptor/GeomAdaptor_Curve.cdl +++ b/src/GeomAdaptor/GeomAdaptor_Curve.cdl @@ -18,7 +18,8 @@ class Curve from GeomAdaptor inherits Curve from Adaptor3d ---Purpose: This class provides an interface between the services provided by any -- curve from the package Geom and those required of the curve by algorithms which use it. - + -- Creation of the loaded curve the curve is C1 by piece. + uses Vec from gp, Pnt from gp, Circ from gp, diff --git a/src/GeomAdaptor/GeomAdaptor_HSurface.cdl b/src/GeomAdaptor/GeomAdaptor_HSurface.cdl index 0ca55fc2ff..e1eb2b8814 100644 --- a/src/GeomAdaptor/GeomAdaptor_HSurface.cdl +++ b/src/GeomAdaptor/GeomAdaptor_HSurface.cdl @@ -19,6 +19,7 @@ class HSurface from GeomAdaptor inherits GHSurface from GeomAdaptor ---Purpose: An interface between the services provided by any -- surface from the package Geom and those required -- of the surface by algorithms which use it. + -- Provides a surface handled by reference. uses Surface from Geom, diff --git a/src/GeomAdaptor/GeomAdaptor_Surface.cdl b/src/GeomAdaptor/GeomAdaptor_Surface.cdl index 76b12834c5..8742473a41 100644 --- a/src/GeomAdaptor/GeomAdaptor_Surface.cdl +++ b/src/GeomAdaptor/GeomAdaptor_Surface.cdl @@ -19,7 +19,7 @@ class Surface from GeomAdaptor inherits Surface from Adaptor3d ---Purpose: An interface between the services provided by any -- surface from the package Geom and those required -- of the surface by algorithms which use it. - + -- Creation of the loaded surface the surface is C1 by piece uses Pnt from gp, Vec from gp, diff --git a/src/GeomConvert/GeomConvert.cdl b/src/GeomConvert/GeomConvert.cdl index e3330579f6..7fafd94666 100644 --- a/src/GeomConvert/GeomConvert.cdl +++ b/src/GeomConvert/GeomConvert.cdl @@ -62,47 +62,19 @@ uses Standard, is class BSplineCurveKnotSplitting; - --- Purpose : This algorithm searches the knot values corresponding to the - -- splitting of a given B-spline curve into several arcs with - -- the same continuity. The continuity order is given at the - -- construction time. It is possible to compute the curve arcs - -- corresponding to this splitting with the method of package - -- SplitBSplineCurve. - class BSplineSurfaceKnotSplitting; - --- Purpose : - -- This algorithm searches the knot values corresponding to the - -- splitting of a given B-spline surface into several patches with - -- the same continuity. The continuity order is given at the - -- construction time. It is possible to compute the surface patches - -- corresponding to the splitting with the method of package - -- SplitBSplineSurface. - class BSplineCurveToBezierCurve; - --- Purpose : - -- This algorithm converts a B-spline curve from the package Geom - -- into several Bezier curves. - + class CompCurveToBSplineCurve; - --- Purpose : - -- This algorithm converts and concat sevral curve in a - -- B-spline curve. class BSplineSurfaceToBezierSurface; - --- Purpose : - -- This algorithm converts a B-spline surface from the package Geom - -- into several Bezier surfaces. class CompBezierSurfacesToBSplineSurface; - ---Purpose: Convert a grid of Bezier Surfaces - -- that are have continuity CM to an - -- Bspline Surface that has continuity CM - + class ApproxSurface; - ---Purpose: Convert a surface from Geom by an approximation method - -- + class ApproxCurve; ---Purpose: Convert a curve from Geom by an approximation method -- diff --git a/src/GeomConvert/GeomConvert_BSplineCurveKnotSplitting.cdl b/src/GeomConvert/GeomConvert_BSplineCurveKnotSplitting.cdl index e98834d6b6..3d86ef5c41 100644 --- a/src/GeomConvert/GeomConvert_BSplineCurveKnotSplitting.cdl +++ b/src/GeomConvert/GeomConvert_BSplineCurveKnotSplitting.cdl @@ -22,7 +22,8 @@ class BSplineCurveKnotSplitting from GeomConvert -- If you require curves with a minimum continuity for -- your computation, it is useful to know the points -- between which an arc has a continuity of a given - -- order. For a BSpline curve, the discontinuities are + -- order. The continuity order is given at the construction time. + -- For a BSpline curve, the discontinuities are -- localized at the knot values. Between two knot values -- the BSpline is infinitely and continuously -- differentiable. At a given knot, the continuity is equal diff --git a/src/GeomConvert/GeomConvert_BSplineSurfaceKnotSplitting.cdl b/src/GeomConvert/GeomConvert_BSplineSurfaceKnotSplitting.cdl index 0aadb1a73a..c81bd2a65a 100644 --- a/src/GeomConvert/GeomConvert_BSplineSurfaceKnotSplitting.cdl +++ b/src/GeomConvert/GeomConvert_BSplineSurfaceKnotSplitting.cdl @@ -17,7 +17,10 @@ class BSplineSurfaceKnotSplitting from GeomConvert --- Purpose : An algorithm to determine isoparametric curves along -- which a BSpline surface should be split in order to - -- obtain patches of the same continuity. + -- obtain patches of the same continuity. The continuity order is given at the + -- construction time. It is possible to compute the surface patches + -- corresponding to the splitting with the method of package + -- SplitBSplineSurface. -- For a B-spline surface the discontinuities are localised at -- the knot values. Between two knots values the B-spline is -- infinitely continuously differentiable. For each parametric diff --git a/src/GeomConvert/GeomConvert_CompBezierSurfacesToBSplineSurface.cdl b/src/GeomConvert/GeomConvert_CompBezierSurfacesToBSplineSurface.cdl index 7a93beffe0..c567b7c832 100644 --- a/src/GeomConvert/GeomConvert_CompBezierSurfacesToBSplineSurface.cdl +++ b/src/GeomConvert/GeomConvert_CompBezierSurfacesToBSplineSurface.cdl @@ -17,7 +17,8 @@ class CompBezierSurfacesToBSplineSurface from GeomConvert ---Purpose: An algorithm to convert a grid of adjacent - -- non-rational Bezier surfaces into a BSpline surface. + -- non-rational Bezier surfaces (with continuity CM) into a + -- BSpline surface (with continuity CM). -- A CompBezierSurfacesToBSplineSurface object -- provides a framework for: -- - defining the grid of adjacent Bezier surfaces diff --git a/src/GeomConvert/GeomConvert_CompCurveToBSplineCurve.cdl b/src/GeomConvert/GeomConvert_CompCurveToBSplineCurve.cdl index 4306692767..1f9f580e60 100644 --- a/src/GeomConvert/GeomConvert_CompCurveToBSplineCurve.cdl +++ b/src/GeomConvert/GeomConvert_CompCurveToBSplineCurve.cdl @@ -20,7 +20,7 @@ class CompCurveToBSplineCurve from GeomConvert - ---Purpose: Concat several curve in an BSplineCurve + ---Purpose: Algorithm converts and concat several curve in an BSplineCurve uses ParameterisationType from Convert, diff --git a/src/GeomFill/GeomFill.cdl b/src/GeomFill/GeomFill.cdl index 7797099f20..1421b014d3 100644 --- a/src/GeomFill/GeomFill.cdl +++ b/src/GeomFill/GeomFill.cdl @@ -65,7 +65,6 @@ is IsGuideACWithContact, IsGuidePlanWithContact, IsDiscreteTrihedron end; class Filling; - ---Purpose: Root class for Filling; class Stretch; @@ -75,26 +74,15 @@ is class BezierCurves; - ---Purpose: class for Filling BezierCurves. - -- WARNING: - -- Some problems may appear with the rational Curves. - + class BSplineCurves; - ---Purpose: class for Filling BSplineCurves. - -- WARNING: - -- Some problems may appear with the rational Curves. - + class Profiler; - ---Purpose: class for evaluation of the Common BSpline Profile - -- from a sequence a BSplineCurves. - + class SectionGenerator; - ---Purpose: class for instantiation of AppBlend . - -- inherits Profiler. class Line; - ---Purpose: class for instantiation of AppBlend - + class AppSurf instantiates AppSurf from AppBlend ( SectionGenerator from GeomFill, Line from GeomFill); @@ -103,8 +91,6 @@ is class SweepSectionGenerator; - ---Purpose: class for instantiation of AppBlend. - -- evaluate the sections of a sweep surface. class AppSweep instantiates AppSurf from AppBlend ( SweepSectionGenerator from GeomFill, @@ -114,74 +100,34 @@ is class Generator; - ---Purpose: Create a surface using generating lines. Inherits - -- profiler. The surface will be a BSplineSurface - -- passing by all the curves described in the - -- generator. The VDegree of the resulting surface is - -- 1. class Pipe; - ---Purpose: Create a pipe surface. --- Family of classes providing algorithms to fill a contour with -- constraints of tangency. - --- class Draft; - ---Purpose: Depouille - + class Tensor; class ConstrainedFilling; - ---Purpose: class for filling a contour of 2, 3 or 4 curves with - -- tangency constaints. The only FillingStyle used is - -- Coons. - -- deferred class Boundary; -- inherits TShared - ---Purpose: Root class defining the methods we need to make a - -- constrained boundary. Any new type of constrained - -- boundary must inherit this class. - -- - + class DegeneratedBound; -- inherits Boundary - ---Purpose: class defining a degenerated boundary for a - -- constrained filling with a point and no other - -- constraint. Only used to simulate an ordinary bound, - -- may not be usefull and desapear soon. - -- - + class SimpleBound; -- inherits Boundary - ---Purpose: class defining a boundary for a constrained filling - -- with a 3d curve and no other constraint. Contains - -- fields to allow a reparametrization of curve. - -- - + class BoundWithSurf; -- inherits Boundary - ---Purpose: class defining a boundary for a constrained filling - -- with a curve and a normals field along a surface. - -- Contains fields to allow a reparametrization of curve - -- and normals field. - -- class CoonsAlgPatch; -- inherits TShared - ---Purpose: class defining an algorithmic patch based on 4 Curves. deferred class TgtField; -- inherits TShared - ---Purpose: Root class defining the methods we need to definine an - -- algorithmic tgte field. class TgtOnCoons; -- inherits TgteField - ---Purpose: Class defining an algorithmic tgte field along a - -- boundary of a CoonsAlgPatch. class CornerState; - ---Purpose: Class (should be a structure) storing the informations - -- about continuity, normals parallelism, coons - -- conditions and bounds tangents angle on the corner of - -- contour to be filled. -- -- instantiation of Sequence of Trsf diff --git a/src/GeomFill/GeomFill_BoundWithSurf.cdl b/src/GeomFill/GeomFill_BoundWithSurf.cdl index 62622f6e61..cd25692d60 100644 --- a/src/GeomFill/GeomFill_BoundWithSurf.cdl +++ b/src/GeomFill/GeomFill_BoundWithSurf.cdl @@ -23,6 +23,8 @@ class BoundWithSurf from GeomFill inherits Boundary from GeomFill -- the computations are done with a CurveOnSurf and a -- normals field defined by the normalized normal to -- the surface along the PCurve. + -- Contains fields to allow a reparametrization of curve + -- and normals field. uses Pnt from gp, diff --git a/src/GeomFill/GeomFill_Boundary.cdl b/src/GeomFill/GeomFill_Boundary.cdl index a6d8184968..49060fe71f 100644 --- a/src/GeomFill/GeomFill_Boundary.cdl +++ b/src/GeomFill/GeomFill_Boundary.cdl @@ -18,6 +18,7 @@ deferred class Boundary from GeomFill inherits TShared from MMgt ---Purpose: Root class to define a boundary which will form part of a -- contour around a gap requiring filling. + -- Any new type of constrained boundary must inherit this class. -- The GeomFill package provides two classes to define constrained boundaries: -- - GeomFill_SimpleBound to define an unattached boundary -- - GeomFill_BoundWithSurf to define a boundary attached to a surface. diff --git a/src/GeomFill/GeomFill_ConstrainedFilling.cdl b/src/GeomFill/GeomFill_ConstrainedFilling.cdl index 4146fdef10..9839251d25 100644 --- a/src/GeomFill/GeomFill_ConstrainedFilling.cdl +++ b/src/GeomFill/GeomFill_ConstrainedFilling.cdl @@ -21,6 +21,7 @@ class ConstrainedFilling from GeomFill -- constraints and optionally, as tangency constraints. -- The algorithm accepts three or four curves as the -- boundaries of the target surface. + -- The only FillingStyle used is Coons. -- A ConstrainedFilling object provides a framework for: -- - defining the boundaries of the surface -- - implementing the construction algorithm diff --git a/src/GeomFill/GeomFill_CoonsAlgPatch.cdl b/src/GeomFill/GeomFill_CoonsAlgPatch.cdl index 5db378c5bd..3c278cecfa 100644 --- a/src/GeomFill/GeomFill_CoonsAlgPatch.cdl +++ b/src/GeomFill/GeomFill_CoonsAlgPatch.cdl @@ -17,7 +17,7 @@ class CoonsAlgPatch from GeomFill inherits TShared from MMgt ---Purpose: Provides evaluation methods on an algorithmic - -- patch defined by its boundaries and blending + -- patch (based on 4 Curves) defined by its boundaries and blending -- functions. uses diff --git a/src/GeomFill/GeomFill_DegeneratedBound.cdl b/src/GeomFill/GeomFill_DegeneratedBound.cdl index b05e607cab..1de3adf3b8 100644 --- a/src/GeomFill/GeomFill_DegeneratedBound.cdl +++ b/src/GeomFill/GeomFill_DegeneratedBound.cdl @@ -17,7 +17,10 @@ class DegeneratedBound from GeomFill inherits Boundary from GeomFill ---Purpose: Description of a degenerated boundary (a point). - + -- Class defining a degenerated boundary for a + -- constrained filling with a point and no other + -- constraint. Only used to simulate an ordinary bound, + -- may not be usefull and desapear soon. uses Pnt from gp, Vec from gp diff --git a/src/GeomFill/GeomFill_Filling.cdl b/src/GeomFill/GeomFill_Filling.cdl index f669379a36..029dc9c7bd 100644 --- a/src/GeomFill/GeomFill_Filling.cdl +++ b/src/GeomFill/GeomFill_Filling.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class Filling from GeomFill - + ---Purpose: Root class for Filling; uses Array1OfPnt from TColgp, diff --git a/src/GeomFill/GeomFill_Line.cdl b/src/GeomFill/GeomFill_Line.cdl index 788b92e548..26876bf82b 100644 --- a/src/GeomFill/GeomFill_Line.cdl +++ b/src/GeomFill/GeomFill_Line.cdl @@ -16,7 +16,7 @@ class Line from GeomFill - ---Purpose: + ---Purpose: class for instantiation of AppBlend inherits TShared from MMgt diff --git a/src/GeomFill/GeomFill_SimpleBound.cdl b/src/GeomFill/GeomFill_SimpleBound.cdl index 5ae42d5582..3392f9836b 100644 --- a/src/GeomFill/GeomFill_SimpleBound.cdl +++ b/src/GeomFill/GeomFill_SimpleBound.cdl @@ -19,6 +19,7 @@ class SimpleBound from GeomFill inherits Boundary from GeomFill ---Purpose: Defines a 3d curve as a boundary for a -- GeomFill_ConstrainedFilling algorithm. -- This curve is unattached to an existing surface.D + -- Contains fields to allow a reparametrization of curve. uses Pnt from gp, diff --git a/src/GeomLib/GeomLib.cdl b/src/GeomLib/GeomLib.cdl index 389971598d..cc19f58dd9 100644 --- a/src/GeomLib/GeomLib.cdl +++ b/src/GeomLib/GeomLib.cdl @@ -59,37 +59,18 @@ is Array1 from TCollection (Mat from gp); class MakeCurvefromApprox; - ---Purpose: This class is used to create the curves ( 2d or - -- 3d) rational or not created by the class - -- ApproxAFunction from AdvApprox. - - class Interpolate ; - ---Purpose: this class compute the poles of a curve given some - -- parameters, points to interpolate and boundary conditions - -- in 3d - class DenominatorMultiplier ; - ---Purpose: this defines an evaluator for a function of 2 variables - -- that will be used by CancelDenominatorDerivative in one - -- direction. + class DenominatorMultiplier ; class CheckBSplineCurve ; - ---Purpose: Checks for the end tangents : wether or not those - -- are reversed regarding the third or n-3rd control - -- - -- + class Check2dBSplineCurve ; - - ---Purpose: Checks for the end tangents : wether or not those - -- are reversed class IsPlanarSurface; class Tool; - ---Purpose: provides various methods with Geom2d and Geom curves - --- and surfaces. private class PolyFunc; diff --git a/src/GeomLib/GeomLib_Check2dBSplineCurve.cdl b/src/GeomLib/GeomLib_Check2dBSplineCurve.cdl index 8b24016ded..26a67dda0d 100644 --- a/src/GeomLib/GeomLib_Check2dBSplineCurve.cdl +++ b/src/GeomLib/GeomLib_Check2dBSplineCurve.cdl @@ -16,9 +16,8 @@ class Check2dBSplineCurve from GeomLib - ---Purpose: this class is used to construct the BSpline curve - -- from an Approximation ( ApproxAFunction from AdvApprox). - + ---Purpose: Checks for the end tangents : wether or not those + -- are reversed uses Pnt2d from gp, diff --git a/src/GeomLib/GeomLib_CheckBSplineCurve.cdl b/src/GeomLib/GeomLib_CheckBSplineCurve.cdl index f5ac72aa1c..d47f262194 100644 --- a/src/GeomLib/GeomLib_CheckBSplineCurve.cdl +++ b/src/GeomLib/GeomLib_CheckBSplineCurve.cdl @@ -16,9 +16,8 @@ class CheckBSplineCurve from GeomLib - ---Purpose: this class is used to construct the BSpline curve - -- from an Approximation ( ApproxAFunction from AdvApprox). - + ---Purpose: Checks for the end tangents : wether or not those + -- are reversed regarding the third or n-3rd control uses Pnt from gp, diff --git a/src/GeomLib/GeomLib_DenominatorMultiplier.cdl b/src/GeomLib/GeomLib_DenominatorMultiplier.cdl index 98892c86f5..e05290d8c5 100644 --- a/src/GeomLib/GeomLib_DenominatorMultiplier.cdl +++ b/src/GeomLib/GeomLib_DenominatorMultiplier.cdl @@ -16,9 +16,9 @@ class DenominatorMultiplier from GeomLib - ---Purpose: this class is used to construct the BSpline curve - -- from an Approximation ( ApproxAFunction from AdvApprox). - + ---Purpose: this defines an evaluator for a function of 2 variables + -- that will be used by CancelDenominatorDerivative in one + -- direction. uses diff --git a/src/GeomLib/GeomLib_Tool.cdl b/src/GeomLib/GeomLib_Tool.cdl index f036f62ea1..ce75c4f4b1 100644 --- a/src/GeomLib/GeomLib_Tool.cdl +++ b/src/GeomLib/GeomLib_Tool.cdl @@ -15,7 +15,8 @@ class Tool from GeomLib ----Purpose: The methods of this class compute the parameter(s) of a given point on a +---Purpose: Provides various methods with Geom2d and Geom curves and surfaces. +-- The methods of this class compute the parameter(s) of a given point on a -- curve or a surface. The point must be located either -- on the curve (surface) itself or relatively to the latter at -- a distance less than the tolerance value. diff --git a/src/GeomPlate/GeomPlate.cdl b/src/GeomPlate/GeomPlate.cdl index e046e34ea9..9e76d07511 100644 --- a/src/GeomPlate/GeomPlate.cdl +++ b/src/GeomPlate/GeomPlate.cdl @@ -48,10 +48,7 @@ uses gp, is class BuildPlateSurface ; - ---Purpose: - -- this class computes the plate surface corresponding to the constraints. - - + class Array1OfHCurveOnSurface instantiates Array1 from TCollection ( HCurveOnSurface from Adaptor3d); @@ -84,27 +81,14 @@ is class BuildAveragePlane; - --- Purpose: - -- this class computes the initial surface (average plane) in the cases when the initial surface is not - -- given. class Surface; - ---Purpose: - -- this class describes the characteristics of the plate surface - + class MakeApprox; - ---Purpose: - -- this class converts a GeomPlate_Surface to a Geom_BSplineSurface class PlateG0Criterion; - ---Purpose: - -- inherits class Criterion from AdvApp2Var ; - -- this class contains a specific G0 criterion for GeomPlate_MakeApprox class PlateG1Criterion; - ---Purpose: - -- inherits class Criterion from AdvApp2Var ; - -- this class contains a specific G1 criterion for GeomPlate_MakeApprox class Aij; diff --git a/src/GeomPlate/GeomPlate_BuildAveragePlane.cdl b/src/GeomPlate/GeomPlate_BuildAveragePlane.cdl index 700f869526..1ce3d96b42 100644 --- a/src/GeomPlate/GeomPlate_BuildAveragePlane.cdl +++ b/src/GeomPlate/GeomPlate_BuildAveragePlane.cdl @@ -24,6 +24,8 @@ class BuildAveragePlane from GeomPlate ---Purpose: This class computes an average inertial plane with an -- array of points. + -- Computes the initial surface (average plane) in the cases + -- when the initial surface is not given. uses Jacobi from math, diff --git a/src/GeomPlate/GeomPlate_PlateG0Criterion.cdl b/src/GeomPlate/GeomPlate_PlateG0Criterion.cdl index 975ce91f75..abb27ae96d 100644 --- a/src/GeomPlate/GeomPlate_PlateG0Criterion.cdl +++ b/src/GeomPlate/GeomPlate_PlateG0Criterion.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class PlateG0Criterion from GeomPlate inherits Criterion from AdvApp2Var - + ---Purpose: + -- this class contains a specific G0 criterion for GeomPlate_MakeApprox uses SequenceOfXY,SequenceOfXYZ from TColgp, diff --git a/src/GeomPlate/GeomPlate_PlateG1Criterion.cdl b/src/GeomPlate/GeomPlate_PlateG1Criterion.cdl index ed7904c833..65be6d09da 100644 --- a/src/GeomPlate/GeomPlate_PlateG1Criterion.cdl +++ b/src/GeomPlate/GeomPlate_PlateG1Criterion.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class PlateG1Criterion from GeomPlate inherits Criterion from AdvApp2Var - + ---Purpose: + -- this class contains a specific G1 criterion for GeomPlate_MakeApprox uses SequenceOfXY,SequenceOfXYZ from TColgp, diff --git a/src/GeomTools/GeomTools.cdl b/src/GeomTools/GeomTools.cdl index fc4d076949..1fbe341b90 100644 --- a/src/GeomTools/GeomTools.cdl +++ b/src/GeomTools/GeomTools.cdl @@ -36,11 +36,9 @@ is -- Dump, Write, Read tools class SurfaceSet; - ---Purpose: A set of Surfaces from Geom. - + class CurveSet; - ---Purpose: A set of Curves from Geom. - + class Curve2dSet; ---Purpose: A set of Curves from Geom2d. diff --git a/src/Graphic3d/Graphic3d.cdl b/src/Graphic3d/Graphic3d.cdl index e08f81ae17..9122586122 100644 --- a/src/Graphic3d/Graphic3d.cdl +++ b/src/Graphic3d/Graphic3d.cdl @@ -360,19 +360,15 @@ is imported BufferType; imported CBitFields20; - ---Purpose: Defines the C structure ---Category: Imported types imported CBitFields16; - ---Purpose: Defines the C structure ---Category: Imported types imported CBitFields8; - ---Purpose: Defines the C structure ---Category: Imported types imported CBitFields4; - ---Purpose: Defines the C structure ---Category: Imported types imported CAspectFillArea; @@ -381,7 +377,6 @@ is imported CAspectText; imported CStructure; - ---Purpose: Defines the C structure ---Category: Imported types pointer CStructurePtr to CStructure from Graphic3d; @@ -389,27 +384,21 @@ is imported CStructure_Handle; imported CLight; - ---Purpose: Defines the C structure ---Category: Imported types imported CPick; - ---Purpose: Defines the C structure ---Category: Imported types imported CPlane; - ---Purpose: Defines the C structure ---Category: Imported types imported CBounds; - ---Purpose: Defines the C structure ---Category: Imported types imported CUserDraw; - ---Purpose: Defines the C structure ---Category: Imported types imported CView; - ---Purpose: Defines the C structure ---Category: Imported types imported RenderingParams; @@ -417,17 +406,12 @@ is ---Category: Imported types imported CGraduatedTrihedron; - ---Purpose: Defines the C structure of a graduated trihedron. ---Category: Imported types imported ClipPlane; - ---Purpose: Describes geometrical and auxiliary properties of clipping - -- planes applied on rendering by graphical driver. ---Category: Imported types imported ClipPlane_Handle; - ---Purpose: CDL-compatibility handle type definition for - -- clip plane objects. imported CTexture; @@ -452,88 +436,65 @@ is -------------------- deferred class ArrayOfPrimitives; - ---Purpose: Contains basic methods for array allocation and filling class ArrayOfPoints; - ---Purpose: Contains points array definition class ArrayOfPolylines; - ---Purpose: Contains polylines array definition class ArrayOfSegments; - ---Purpose: Contains segments array definition class ArrayOfPolygons; - ---Purpose: Contains polygons array definition class ArrayOfTriangles; - ---Purpose: Contains triangles array definition class ArrayOfTriangleStrips; - ---Purpose: Contains triangles strip array definition class ArrayOfTriangleFans; - ---Purpose: Contains triangles fan array definition class ArrayOfQuadrangles; - ---Purpose: Contains quatrangles array definition class ArrayOfQuadrangleStrips; - ---Purpose: Contains quadrangles strip array definition class AspectLine3d; - ---Purpose: Grouping line attributes ---Category: Classes class AspectFillArea3d; - ---Purpose: Grouping face attributes ---Category: Classes class AspectMarker3d; - ---Purpose: Grouping marker attributes ---Category: Classes class AspectText3d; - ---Purpose: Grouping text attributes. ---Category: Classes deferred class Group; - ---Purpose: For grouping together primitives in a structure ---Category: Classes class MaterialAspect; - ---Purpose: Aspect attributes of a 3d face. ---Category: Classes class Structure; - ---Purpose: Graphic object. ---Category: Classes pointer StructurePtr to Structure from Graphic3d; deferred class GraphicDriver; - ---Purpose: Defines a graphic driver for 3d interface deferred class StructureManager; - ---Purpose: Visualiser with which the graphic objects are associated. ---Category: Classes pointer StructureManagerPtr to StructureManager from Graphic3d; deferred class DataStructureManager; - ---Purpose: Visualiser with which the graphic objects are associated. ---Category: Classes deferred class Plotter; - ---Purpose: Defines the minimal plotter. ---Category: The classes class Vector; - ---Purpose: 3d vector ---Category: Classes imported Vertex; - ---Purpose: 3d vertex ---Category: Classes --------------------------------- diff --git a/src/Graphic3d/Graphic3d_ArrayOfPoints.cdl b/src/Graphic3d/Graphic3d_ArrayOfPoints.cdl index 459a4b0211..1f9bf64ceb 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfPoints.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfPoints.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfPoints from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains points array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfPolygons.cdl b/src/Graphic3d/Graphic3d_ArrayOfPolygons.cdl index 5947f07599..65fba3f010 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfPolygons.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfPolygons.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfPolygons from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains polygons array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfPolylines.cdl b/src/Graphic3d/Graphic3d_ArrayOfPolylines.cdl index f0a7d0cda9..eb55b45cdd 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfPolylines.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfPolylines.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfPolylines from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains polylines array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfQuadrangleStrips.cdl b/src/Graphic3d/Graphic3d_ArrayOfQuadrangleStrips.cdl index efd12f612e..a08c3cf78f 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfQuadrangleStrips.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfQuadrangleStrips.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfQuadrangleStrips from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains quadrangles strip array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfQuadrangles.cdl b/src/Graphic3d/Graphic3d_ArrayOfQuadrangles.cdl index 7316322269..a8343d4c0b 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfQuadrangles.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfQuadrangles.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfQuadrangles from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains quatrangles array definition uses Color from Quantity, diff --git a/src/Graphic3d/Graphic3d_ArrayOfSegments.cdl b/src/Graphic3d/Graphic3d_ArrayOfSegments.cdl index 5b3daef983..c71193bbd3 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfSegments.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfSegments.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfSegments from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains segments array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfTriangleFans.cdl b/src/Graphic3d/Graphic3d_ArrayOfTriangleFans.cdl index 60ea54bc13..7c93e1c427 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfTriangleFans.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfTriangleFans.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfTriangleFans from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains triangles fan array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfTriangleStrips.cdl b/src/Graphic3d/Graphic3d_ArrayOfTriangleStrips.cdl index 39711de824..ec73618b0f 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfTriangleStrips.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfTriangleStrips.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfTriangleStrips from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains triangles strip array definition is diff --git a/src/Graphic3d/Graphic3d_ArrayOfTriangles.cdl b/src/Graphic3d/Graphic3d_ArrayOfTriangles.cdl index c0a6e6c367..109ebeeb63 100644 --- a/src/Graphic3d/Graphic3d_ArrayOfTriangles.cdl +++ b/src/Graphic3d/Graphic3d_ArrayOfTriangles.cdl @@ -13,6 +13,7 @@ -- commercial license or contractual agreement. class ArrayOfTriangles from Graphic3d inherits ArrayOfPrimitives from Graphic3d + ---Purpose: Contains triangles array definition is diff --git a/src/Graphic3d/Graphic3d_CGraduatedTrihedron.hxx b/src/Graphic3d/Graphic3d_CGraduatedTrihedron.hxx index 8c0402d960..44061de7b8 100644 --- a/src/Graphic3d/Graphic3d_CGraduatedTrihedron.hxx +++ b/src/Graphic3d/Graphic3d_CGraduatedTrihedron.hxx @@ -25,6 +25,7 @@ class Visual3d_View; +//! Defines the C structure of a graduated trihedron. class Graphic3d_CGraduatedTrihedron { public: diff --git a/src/Graphic3d/Graphic3d_ClipPlane_Handle.hxx b/src/Graphic3d/Graphic3d_ClipPlane_Handle.hxx index 86b17276d0..f085f57647 100755 --- a/src/Graphic3d/Graphic3d_ClipPlane_Handle.hxx +++ b/src/Graphic3d/Graphic3d_ClipPlane_Handle.hxx @@ -17,6 +17,7 @@ #define _Graphic3d_ClipPlane_Handle_HeaderFile #include +//! CDL-compatibility handle type definition for clip plane objects. typedef Handle(Graphic3d_ClipPlane) Graphic3d_ClipPlane_Handle; #endif diff --git a/src/Graphic3d/Graphic3d_GraphicDriver.cdl b/src/Graphic3d/Graphic3d_GraphicDriver.cdl index 0541027e6c..140d92e9a2 100644 --- a/src/Graphic3d/Graphic3d_GraphicDriver.cdl +++ b/src/Graphic3d/Graphic3d_GraphicDriver.cdl @@ -19,7 +19,7 @@ deferred class GraphicDriver from Graphic3d inherits TShared ---Version: ---Purpose: This class allows the definition of a graphic driver - -- (currently only OpenGl driver is used). + -- for 3d interface (currently only OpenGl driver is used). ---Keywords: OpenGl diff --git a/src/Graphic3d/Graphic3d_MaterialAspect.cdl b/src/Graphic3d/Graphic3d_MaterialAspect.cdl index 45fe0d1b70..14ee809672 100644 --- a/src/Graphic3d/Graphic3d_MaterialAspect.cdl +++ b/src/Graphic3d/Graphic3d_MaterialAspect.cdl @@ -29,6 +29,7 @@ class MaterialAspect from Graphic3d ---Version: ---Purpose: This class allows the definition of the type of a surface. + -- Aspect attributes of a 3d face. -- Keywords: Material, FillArea, Shininess, Ambient, Color, Diffuse, -- Specular, Transparency, Emissive, ReflectionMode, -- BackFace, FrontFace, Reflection, Absorbtion diff --git a/src/HLRAlgo/HLRAlgo.cdl b/src/HLRAlgo/HLRAlgo.cdl index 49e2c0231e..8b5b54ce06 100644 --- a/src/HLRAlgo/HLRAlgo.cdl +++ b/src/HLRAlgo/HLRAlgo.cdl @@ -61,26 +61,19 @@ is (BiPoint from HLRAlgo); class PolyShellData; - ---Purpose: All the PolyData of a Shell - + class PolyInternalData; - ---Purpose: to Update OutLines. - + class PolyInternalSegment; - ---Purpose: to Update OutLines. - + class PolyInternalNode; - ---Purpose: to Update OutLines. - + class PolyData; - ---Purpose: Data structure of a set of Triangles. - + class PolyHidingData; - ---Purpose: Data structure of a set of Hiding Triangles. - + class TriangleData; - ---Purpose: Data structure of a triangle. - + class Array1OfPHDat instantiates Array1 from TCollection (PolyHidingData from HLRAlgo); @@ -110,22 +103,15 @@ is Array1OfTData from HLRAlgo); class PolyAlgo; - ---Purpose: to remove Hidden lines on Triangulations. - + class EdgeStatus; - ---Purpose: This class describes the visible-hidden Status of - -- an Edge and its parametric bounds. - + class Projector; - ---Purpose: To transform and project Points and Planes. - + class Intersection; - ---Purpose: Parameter and State (above, on or under the face). class Coincidence; - ---Purpose: A coincidence describes the geometry of the edge - -- of the hiding face around the intersection. - + class Interference instantiates Interference from TopBas (Intersection from HLRAlgo, Coincidence from HLRAlgo); @@ -134,11 +120,9 @@ is (Interference from HLRAlgo); class EdgesBlock; - ---Purpose: A set of oriented Edges. (A wire). - + class WiresBlock; - ---Purpose: A set of Wires. (A face). - + class EdgeIterator; ---Purpose: Iterator on the visible or hidden parts of an -- EdgeStatus. diff --git a/src/HLRAlgo/HLRAlgo_PolyData.cdl b/src/HLRAlgo/HLRAlgo_PolyData.cdl index 2d5f8f34bc..a143f1f583 100644 --- a/src/HLRAlgo/HLRAlgo_PolyData.cdl +++ b/src/HLRAlgo/HLRAlgo_PolyData.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PolyData from HLRAlgo inherits TShared from MMgt + ---Purpose: Data structure of a set of Triangles. uses Address from Standard, diff --git a/src/HLRAlgo/HLRAlgo_PolyHidingData.cdl b/src/HLRAlgo/HLRAlgo_PolyHidingData.cdl index 40dd41f195..9797e10a00 100644 --- a/src/HLRAlgo/HLRAlgo_PolyHidingData.cdl +++ b/src/HLRAlgo/HLRAlgo_PolyHidingData.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PolyHidingData from HLRAlgo + ---Purpose: Data structure of a set of Hiding Triangles. uses Address from Standard, diff --git a/src/HLRAlgo/HLRAlgo_PolyInternalData.cdl b/src/HLRAlgo/HLRAlgo_PolyInternalData.cdl index f8dcdeb386..72ad262a39 100644 --- a/src/HLRAlgo/HLRAlgo_PolyInternalData.cdl +++ b/src/HLRAlgo/HLRAlgo_PolyInternalData.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PolyInternalData from HLRAlgo inherits TShared from MMgt + ---Purpose: to Update OutLines. uses Address from Standard, diff --git a/src/HLRAlgo/HLRAlgo_PolyInternalNode.cdl b/src/HLRAlgo/HLRAlgo_PolyInternalNode.cdl index 26b0166d2e..d4d96d15d2 100644 --- a/src/HLRAlgo/HLRAlgo_PolyInternalNode.cdl +++ b/src/HLRAlgo/HLRAlgo_PolyInternalNode.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PolyInternalNode from HLRAlgo inherits TShared from MMgt + ---Purpose: to Update OutLines. uses Address from Standard, diff --git a/src/HLRAlgo/HLRAlgo_PolyInternalSegment.cdl b/src/HLRAlgo/HLRAlgo_PolyInternalSegment.cdl index b9950c8489..ed40b2d94c 100644 --- a/src/HLRAlgo/HLRAlgo_PolyInternalSegment.cdl +++ b/src/HLRAlgo/HLRAlgo_PolyInternalSegment.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PolyInternalSegment from HLRAlgo + ---Purpose: to Update OutLines. uses Address from Standard, diff --git a/src/HLRAlgo/HLRAlgo_PolyShellData.cdl b/src/HLRAlgo/HLRAlgo_PolyShellData.cdl index ada2877d66..f74762b37c 100644 --- a/src/HLRAlgo/HLRAlgo_PolyShellData.cdl +++ b/src/HLRAlgo/HLRAlgo_PolyShellData.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class PolyShellData from HLRAlgo inherits TShared from MMgt + ---Purpose: All the PolyData of a Shell uses Address from Standard, diff --git a/src/HLRAlgo/HLRAlgo_Projector.cdl b/src/HLRAlgo/HLRAlgo_Projector.cdl index 1b1eeee10b..8291c3d1e1 100644 --- a/src/HLRAlgo/HLRAlgo_Projector.cdl +++ b/src/HLRAlgo/HLRAlgo_Projector.cdl @@ -16,6 +16,7 @@ class Projector from HLRAlgo ---Purpose: Implements a projector object. +-- To transform and project Points and Planes. -- This object is designed to be used in the -- removal of hidden lines and is returned by the -- Prs3d_Projector::Projector function. diff --git a/src/HLRAlgo/HLRAlgo_TriangleData.cdl b/src/HLRAlgo/HLRAlgo_TriangleData.cdl index 7306122804..3c6d646e40 100644 --- a/src/HLRAlgo/HLRAlgo_TriangleData.cdl +++ b/src/HLRAlgo/HLRAlgo_TriangleData.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class TriangleData from HLRAlgo + ---Purpose: Data structure of a triangle. uses Address from Standard, diff --git a/src/HLRBRep/HLRBRep.cdl b/src/HLRBRep/HLRBRep.cdl index 349a5c627d..a4aac4ab46 100644 --- a/src/HLRBRep/HLRBRep.cdl +++ b/src/HLRBRep/HLRBRep.cdl @@ -122,12 +122,9 @@ is class InternalAlgo; class Algo; - ---Purpose: Inherited from InternalAlgo to provide methods - -- with Shape from TopoDS. - + class PolyAlgo; - ---Purpose: to remove Hidden lines on Shapes with Triangulations. - + class BiPoint; class BiPnt2D; diff --git a/src/HLRBRep/HLRBRep_Algo.cdl b/src/HLRBRep/HLRBRep_Algo.cdl index 0f0c902e93..fd609c4799 100644 --- a/src/HLRBRep/HLRBRep_Algo.cdl +++ b/src/HLRBRep/HLRBRep_Algo.cdl @@ -16,7 +16,8 @@ class Algo from HLRBRep inherits InternalAlgo from HLRBRep - ---Purpose: A framework to compute a shape as seen in a projection plane. This is done by + ---Purpose: Inherited from InternalAlgo to provide methods with Shape from TopoDS. + -- A framework to compute a shape as seen in a projection plane. This is done by -- calculating the visible and the hidden parts of the shape. -- HLRBRep_Algo works with three types of entity: -- - shapes to be visualized diff --git a/src/HLRBRep/HLRBRep_PolyAlgo.cdl b/src/HLRBRep/HLRBRep_PolyAlgo.cdl index aa9de4fadb..73d27f43c0 100644 --- a/src/HLRBRep/HLRBRep_PolyAlgo.cdl +++ b/src/HLRBRep/HLRBRep_PolyAlgo.cdl @@ -16,7 +16,8 @@ class PolyAlgo from HLRBRep inherits TShared from MMgt - ---Purpose: A framework to compute the shape as seen in + ---Purpose: to remove Hidden lines on Shapes with Triangulations. + -- A framework to compute the shape as seen in -- a projection plane. This is done by calculating -- the visible and the hidden parts of the shape. -- HLRBRep_PolyAlgo works with three types of entity: diff --git a/src/HLRTest/HLRTest.cdl b/src/HLRTest/HLRTest.cdl index 10b3e4454b..101c2176dd 100644 --- a/src/HLRTest/HLRTest.cdl +++ b/src/HLRTest/HLRTest.cdl @@ -35,14 +35,11 @@ is class ShapeData; class DrawableEdgeTool; - ---Purpose: Used to display the results. class DrawablePolyEdgeTool; - ---Purpose: Used to display the results. class Projector; - ---Purpose: Draw Variable Projector to test - + class OutLiner; ---Purpose: Draw Variable Outliner to test diff --git a/src/HLRTest/HLRTest_DrawableEdgeTool.cdl b/src/HLRTest/HLRTest_DrawableEdgeTool.cdl index 1def3542c1..51dfb30bd8 100644 --- a/src/HLRTest/HLRTest_DrawableEdgeTool.cdl +++ b/src/HLRTest/HLRTest_DrawableEdgeTool.cdl @@ -16,7 +16,7 @@ class DrawableEdgeTool from HLRTest inherits Drawable3D from Draw - ---Purpose: + ---Purpose: Used to display the results. uses Boolean from Standard, diff --git a/src/HLRTest/HLRTest_DrawablePolyEdgeTool.cdl b/src/HLRTest/HLRTest_DrawablePolyEdgeTool.cdl index 23eca60a7b..84200d562f 100644 --- a/src/HLRTest/HLRTest_DrawablePolyEdgeTool.cdl +++ b/src/HLRTest/HLRTest_DrawablePolyEdgeTool.cdl @@ -16,7 +16,7 @@ class DrawablePolyEdgeTool from HLRTest inherits Drawable3D from Draw - ---Purpose: + ---Purpose: Used to display the results. uses Boolean from Standard, diff --git a/src/HLRTest/HLRTest_Projector.cdl b/src/HLRTest/HLRTest_Projector.cdl index f7841127a3..088d9a437e 100644 --- a/src/HLRTest/HLRTest_Projector.cdl +++ b/src/HLRTest/HLRTest_Projector.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class Projector from HLRTest inherits Drawable3D from Draw - ---Purpose: + ---Purpose: Draw Variable Projector to test. uses OStream, diff --git a/src/Hatch/Hatch.cdl b/src/Hatch/Hatch.cdl index d0563a2427..b50d32de9f 100644 --- a/src/Hatch/Hatch.cdl +++ b/src/Hatch/Hatch.cdl @@ -42,19 +42,15 @@ is private class Parameter; - ---Purpose: Used by the Hatcher to store a parameter on a - -- line. - + private class SequenceOfParameter instantiates Sequence from TCollection (Parameter from Hatch); private class Line; - ---Purpose: Used by the Hatcher to store a line. private class SequenceOfLine instantiates Sequence from TCollection (Line from Hatch); class Hatcher; - ---Purpose: The Hatching algorithm. end Hatch; diff --git a/src/IGESAppli/IGESAppli.cdl b/src/IGESAppli/IGESAppli.cdl index a27637525b..ebf777f776 100644 --- a/src/IGESAppli/IGESAppli.cdl +++ b/src/IGESAppli/IGESAppli.cdl @@ -40,108 +40,42 @@ uses is class Node; - -- Type 134, Form 0 - ---Purpose : Geometric point used in the definition of a finite - -- element. class FiniteElement; - -- Type 136, Form 0 - ---Purpose : Used to define a finite element with the help of an - -- element topology. class NodalDisplAndRot; - -- Type 138, Form 0 - ---Purpose : Used to communicate finite element post processing - -- data. class NodalResults; - -- Type 146 - ---Purpose : Used to store the Analysis Data results per FEM Node class ElementResults; - -- Type 148 - ---Purpose : Used to find the results of FEM analysis class Flow; - -- Type 402, Form 18 - ---Purpose : Represents a single signal or a single fluid flow path - -- starting from a starting Connect Point Entity and - -- including additional intermediate connect points. class PipingFlow; - -- Type 402, Form 20 - ---Purpose : Represents a single fluid flow path class RegionRestriction; - -- Type 406, Form 2 - ---Purpose : Defines regions to set an application's restriction - -- over a region. class LevelFunction; - -- Type 406, Form 3 - ---Purpose : Used to transfer the meaning or intended use of a level - -- in the sending system class LineWidening; - -- Type 406, Form 5 - ---Purpose : Defines the characteristics of entities when they are - -- used to define locations of items. class DrilledHole; - -- Type 406, Form 6 - ---Purpose : Identifies an entity representing a drilled hole - -- through a printed circuit board. class ReferenceDesignator; - -- Type 406, Form 7 - ---Purpose : Used to attach a text string containing the value of - -- a component reference designator to an entity being - -- used to represent a component. class PinNumber; - -- Type 406, Form 8 - ---Purpose : Used to attach a text string representing a component - -- pin number to an entity being used to represent an - -- electrical component's pin class PartNumber; - -- Type 406, Form 9 - ---Purpose : Attaches a set of text strings that define the common - -- part numbers to an entity being used to represent a - -- physical component class FlowLineSpec; - -- Type 406, Form 14 - ---Purpose : Attaches one or more text strings to entities being - -- used to represent a flow line class LevelToPWBLayerMap; - -- Type 406, Form 24 - ---Purpose : Used to correlate an exchange file level number with - -- its corresponding native level identifier, physical PWB - -- layer number and predefined functional level - -- identification class PWBArtworkStackup; - -- Type 406, Form 25 - ---Purpose : Used to communicate which exchange file levels are to - -- be combined in order to create the artwork for a - -- printed wire board (PWB). This property should be - -- attached to the entity defining the printed wire - -- assembly (PWA) or if no such entity exists, then the - -- property should stand alone in the file. class PWBDrilledHole; - -- Type 406, Form 26 - ---Purpose : Used to identify an entity that locates a drilled hole - -- and to specify the characteristics of the drilled hole class NodalConstraint; - -- Type 418, Form 0 - ---Purpose : Relates loads and/or constraints to specific nodes in - -- the Finite Element Model by creating a relation between - -- Node entities and Tabular Data Property that contains - -- the load or constraint data -- Tools for Entities -- diff --git a/src/IGESBasic/IGESBasic.cdl b/src/IGESBasic/IGESBasic.cdl index 6bd20a61be..aab1fd9476 100644 --- a/src/IGESBasic/IGESBasic.cdl +++ b/src/IGESBasic/IGESBasic.cdl @@ -33,89 +33,36 @@ uses is class SubfigureDef; - -- Type 308, Form 0 - ---Purpose : Permits a single definition of a detail to be - -- utilized in multiple instances in the creation - -- of the whole picture. class Group; - -- Type 402, Form 1 - ---Purpose : Allows a collection of a set of entities to be - -- maintained as a single entity. class GroupWithoutBackP; - -- Type 402, Form 7 - ---Purpose : Allows a collection of a set of entities to be - -- maintained as a single entity, but without back - -- pointers. class SingleParent; - -- Type 402, Form 9 - ---Purpose : Defines a logical structure of one independent - -- (parent) entity and one or more subordinate - -- (children) entities. class ExternalRefFileIndex; - -- Type 402, Form 12 - ---Purpose : Contains a list of the symbolic names used by the - -- referencing files and the DE pointers to the - -- corresponding definitions within the referenced file class OrderedGroup; - -- Type 402, Form 14 - ---Purpose : Allows a collection of a set of entities to be - -- maintained as a single entity, but the group is - -- ordered. class OrderedGroupWithoutBackP; - -- Type 402, Form 15 - ---Purpose : Allows a collection of a set of entities to be - -- maintained as a single entity, but the group is - -- ordered and there are no back pointers. class Hierarchy; - -- Type 406, Form 10 - ---Purpose : Provides an ability to control the hierarchy of each - -- directory entry attribute. class ExternalReferenceFile; - -- Type 406, Form 12 - ---Purpose : References definitions residing in another file. class Name; - -- Type 406, Form 15 - ---Purpose : Used to specify an user defined name. class AssocGroupType; - -- Type 406, Form 23 - ---Purpose : Used to assign an unambiguous identification to - -- a Group Associativity. class SingularSubfigure; - -- Type 408, Form 0 - ---Purpose : Defines the occurrence of a single instance of the - -- defined Subfigure. class ExternalRefFileName; - -- Type 416, Form 0-2 - ---Purpose : Used when single definition from the reference file is - -- required or for external logical references where an - -- entity in one file relates to an entity in another file class ExternalRefFile; - -- Type 416, Form 1 - ---Purpose : Used when entire reference file is to be instanced class ExternalRefName; - -- Type 416, Form 3 - ---Purpose : Used when it is assumed that a copy of the subfigure - -- exists in native form on the receiving system class ExternalRefLibName; - -- Type 416, Form 4 - ---Purpose : Used when it is assumed that a copy of the subfigure - -- exists in native form in a library on the receiving - -- system -- Tools for Entities -- diff --git a/src/IGESBasic/IGESBasic_OrderedGroup.cdl b/src/IGESBasic/IGESBasic_OrderedGroup.cdl index 62cbe6aa42..f1a913a71b 100644 --- a/src/IGESBasic/IGESBasic_OrderedGroup.cdl +++ b/src/IGESBasic/IGESBasic_OrderedGroup.cdl @@ -19,7 +19,9 @@ class OrderedGroup from IGESBasic inherits Group ---Purpose: defines OrderedGroup, Type <402> Form <14> -- in package IGESBasic -- this class defines an Ordered Group with back pointers - -- + -- Allows a collection of a set of entities to be + -- maintained as a single entity, but the group is + -- ordered. -- It inherits from Group uses diff --git a/src/IGESBasic/IGESBasic_OrderedGroupWithoutBackP.cdl b/src/IGESBasic/IGESBasic_OrderedGroupWithoutBackP.cdl index df58c14592..dbaf9c5a9f 100644 --- a/src/IGESBasic/IGESBasic_OrderedGroupWithoutBackP.cdl +++ b/src/IGESBasic/IGESBasic_OrderedGroupWithoutBackP.cdl @@ -18,7 +18,9 @@ class OrderedGroupWithoutBackP from IGESBasic inherits Group ---Purpose: defines OrderedGroupWithoutBackP, Type <402> Form <15> -- in package IGESBasic - -- + -- Allows a collection of a set of entities to be + -- maintained as a single entity, but the group is + -- ordered and there are no back pointers. -- It inherits from Group uses diff --git a/src/IGESCAFControl/IGESCAFControl.cdl b/src/IGESCAFControl/IGESCAFControl.cdl index 1246d2c284..21e65df1d8 100644 --- a/src/IGESCAFControl/IGESCAFControl.cdl +++ b/src/IGESCAFControl/IGESCAFControl.cdl @@ -33,7 +33,6 @@ uses is class Reader; - ---Purpose: Provides a tool for reading IGES file class Writer; ---Purpose: Provides a tool for writing IGES file diff --git a/src/IGESDefs/IGESDefs.cdl b/src/IGESDefs/IGESDefs.cdl index df3d64c874..4dc20ef0c7 100644 --- a/src/IGESDefs/IGESDefs.cdl +++ b/src/IGESDefs/IGESDefs.cdl @@ -33,47 +33,18 @@ uses is class AssociativityDef; - -- Type 302, Form 5001-9999 - ---Purpose : This class permits the preprocessor to define an - -- associativity schema. i.e., by using it preprocessor - -- defines the type of relationship. class MacroDef; - -- Type 306, Form 0 - ---Purpose : This Class specifies the action of a specific MACRO. - -- After specification MACRO can be used as necessary - -- by means of MACRO class instance entity. class UnitsData; - -- Type 316, Form 0 - ---Purpose : This class stores data about a model's - -- fundamental units. class AttributeDef; - -- Type 322, Form 0,1,2 - ---Purpose : This is class is used to support the concept of well - -- defined collection of attributes, whether it is a table - -- or a single row of attributes. class TabularData; - -- Type 406, Form 11 - ---Purpose : This Class is used to provide a Structure to accomodate - -- point form data. class GenericData; - -- Type 406, Form 27 - ---Purpose : This Class is used to communicate information which is - -- defined by the system operator while creating the model. - -- The information is system specific and does not map into - -- one of the predefined properties or associativities. - -- Properties and property values can be defined by multiple - -- instances of this property. class AttributeTable; - -- Type 422, Form 0,1 - ---Purpose : This class is used to represent an occurence of - -- Attribute Table. This Class may be independent - -- or dependent or pointed at by other Entities. -- Tools for Entities -- diff --git a/src/IGESDimen/IGESDimen.cdl b/src/IGESDimen/IGESDimen.cdl index 5155f6246d..98fc7c7548 100644 --- a/src/IGESDimen/IGESDimen.cdl +++ b/src/IGESDimen/IGESDimen.cdl @@ -37,126 +37,50 @@ uses is class CenterLine; - -- Type 106, Form 20-21 - ---Purpose : Is an entity appearing as crosshairs or as a - -- construction between 2 positions class Section; - -- Type 106, Form 31-38 - ---Purpose : Contains information to display sectioned sides class WitnessLine; - -- Type 106, Form 40 - ---Purpose : Contains one or more straight line segments associated - -- with drafting entities of various types class AngularDimension; - -- Type 202, Form 0 - ---Purpose : Used to dimension angles class CurveDimension; - -- Type 204, Form 0 - ---Purpose : Used to dimension curves class DiameterDimension; - -- Type 206, Form 0 - ---Purpose : Used for dimensioning diameters class FlagNote; - -- Type 208, Form 0 - ---Purpose : Is label information formatted in different ways class GeneralLabel; - -- Type 210, Form 0 - ---Purpose : Used for general labeling with leaders class GeneralNote; - -- Type 212, Form 0-8, 100-102, 105 - ---Purpose : Used for formatting boxed text in different ways class NewGeneralNote; - -- Type 213, Form 0 - ---Purpose : Further attributes for formatting text strings class LeaderArrow; - -- Type 214, Form 1-12 - ---Purpose : Consists of one or more line segments except when - -- leader is part of an angular dimension, with links to - -- presumed text item class LinearDimension; - -- Type 216, Form 0 - ---Purpose : Used for linear dimensioning class OrdinateDimension; - -- Type 218, Form 0, 1 - ---Purpose : The ordinate dimension entity is used to - -- indicate dimensions from a common base line. - -- Dimensioning is only permitted along the XT - -- or YT axis. class PointDimension; - -- Type 220 - ---Purpose : A Point Dimension Entity consists of a leader, text, and - -- an optional circle or hexagon enclosing the text class RadiusDimension; - -- Type 222, Form 0, 1 - ---Purpose : A Radius Dimension Entity consists of a General Note, a - -- leader, and an arc center point. A second form of this - -- entity accounts for the occasional need to have two - -- leader entities referenced. class GeneralSymbol; - -- Type 228, Form 0 - ---Purpose : A General Symbol entity consists of zero or one(Form 0) - -- or one(all other forms), one or more geometry entities - -- which define a symbol, and zero, one or more associated - -- leaders. class SectionedArea; - -- Type 230 - ---Purpose : A sectioned area is a portion of a design which is to be - -- filled with a pattern of lines. class DimensionedGeometry; - -- Type 402, Form 13 - ---Purpose : This associativity links a dimension entity with the - -- geometry entities it is dimensioning. - -- This entity has been replaced by the new form of - -- Dimensioned Geometry Associativity Entity (Type 402, - -- Form 21) and should no longer be used by preprocessors. class NewDimensionedGeometry; - -- Type 402, Form 21 - ---Purpose : This Associativity links a dimension entity with the - -- geometry entities it is dimensioning, so that later, - -- in the receiving database, the dimension can be - -- automatically recalculated and redrawn should the - -- geometry be changed. class DimensionUnits; - -- Type 406, Form 28 - ---Purpose : The Dimension Units Property describes the units and - -- formatting details of the nominal value of a dimension. class DimensionTolerance; - -- Type 406, Form 29 - ---Purpose : The Dimension Tolerance Property provides tolerance - -- information for a dimension. This information can be used - -- by the receiving system to regenerate the dimension. class DimensionDisplayData; - -- Type 406, Form 30 - ---Purpose : The Dimensional Display Data Property is optional but when - -- present must be referenced by a dimension entity. The - -- information it contains could be extracted from the text, - -- leader and witness line data with difficulty. class BasicDimension; - -- Type 406, Form 31 - ---Purpose : The basic Dimension Property indicates that the referencing - -- dimension entity is to be displayed with a box around text. -- Tools for Entities -- diff --git a/src/IGESDraw/IGESDraw.cdl b/src/IGESDraw/IGESDraw.cdl index df91bb7f65..b576e23076 100644 --- a/src/IGESDraw/IGESDraw.cdl +++ b/src/IGESDraw/IGESDraw.cdl @@ -39,94 +39,32 @@ uses is class ConnectPoint; - -- type <132> form <0> - ---Purpose : Connect Point Entity describes a point of connection for - -- zero, one or more entities. It is referenced from Composite - -- curve, or Network Subfigure Definition/Instance, or the Flow - -- Associative Instance, or it may stand alone. class NetworkSubfigureDef; - -- type <320> form <0> - ---Purpose : This class differs from the ordinary subfigure definition - -- in that it defines a specialized subfigure, one whose - -- instances may participate in networks. class ViewsVisible; - -- type <402> form <3> - ---Purpose : If an entity is to be displayed in more than one views, - -- this class instance is used, which contains the Visible - -- views and the associated entity Displays. class ViewsVisibleWithAttr; - -- type <402> form <4> - ---Purpose : This class is extension of Class ViewsVisible. It is used - -- for those entities that are visible in multiple views, but - -- must have a different line font, color number, or - -- line weight in each view. class LabelDisplay; - -- type <402> form <5> - ---Purpose : Permits one or more displays for the - -- entity labels of an entity class Planar; - -- type <402> form <16> - ---Purpose : Indicates that a collection of entities is coplanar. The - -- entities may be geometric, annotative, and/or structural. class SegmentedViewsVisible; - -- type <402> form <19> - ---Purpose : Permits the association of display parameters with the - -- segments of curves in a given view class Drawing; - -- type <404> form <0> - ---Purpose : Specifies a drawing as a collection of annotation entities - -- defined in drawing space, and views which together - -- constitute a single representation of a part class DrawingWithRotation; - -- type <404> form <1> - ---Purpose : Permits rotation, in addition to transformation and - -- scaling, between the view and drawing coordinate systems class View; - -- type <410> form <0> - ---Purpose : Used to define a framework for specifying a viewing - -- orientation of an object in three dimensional model - -- space (X,Y,Z). The framework is also used to support - -- the projection of all or part of model space onto a - -- view volume. class RectArraySubfigure; - -- type <412> form 0 - ---Purpose : Used to produce copies of an object called the base entity, - -- arranging them in equally spaced rows and columns class CircArraySubfigure; - -- type <414> form <0> - ---Purpose : Used to produce copies of an object called the base entity, - -- arranging them around the edge of an imaginary circle - -- whose center and radius are specified class NetworkSubfigure; - -- type <420> form <0> - ---Purpose : Used to specify each instance of Network Subfigure - -- definition Entity (Type <320>). class PerspectiveView; - -- type <410> form <1> - ---Purpose : Supports a perspective view. - -- Any geometric projection is defined by a view plane - -- and the projectors that pass through the view plane. - -- Projectors can be visualized as rays of light that - -- form an image by passing through the viewed object - -- and striking the view plane. - -- The projectors are defined via a point called the - -- Center-of-Projection or the eye-point. - -- A perspective view is formed by all projectors that - -- emanate from the Center-of-Projection and pass - -- through the view plane. -- Tools for Entities -- diff --git a/src/IGESGeom/IGESGeom.cdl b/src/IGESGeom/IGESGeom.cdl index 9ad24a1f13..7b5fee4512 100644 --- a/src/IGESGeom/IGESGeom.cdl +++ b/src/IGESGeom/IGESGeom.cdl @@ -34,96 +34,50 @@ uses is class CircularArc; - -- Type 100, Form 0 - ---Purpose : Defines IGES CircularArc class CompositeCurve; - -- Type 102, Form 0 - ---Purpose : Defines IGES CompositeCurve class ConicArc; - -- Type 104, Form 0-3 - ---Purpose : Defines a ConicArc class CopiousData; - -- Type 106, Form 1-3,11-13,63 - ---Purpose : Defines a CopiousData class Plane; - -- Type 108, Form -1,0,1 - ---Purpose : Defines IGES Plane class Line; - -- Type 110, Form 0 - ---Purpose : Defines IGES Line class SplineCurve; - -- Type 112, Form 0 - ---Purpose : Defines IGES SplineCurve class SplineSurface; - -- Type 114, Form 0 - -- Purpose : Defines IGES SplineSurface class Point; - -- Type 116, Form 0 - ---Purpose : Defines IGES Point class RuledSurface; - -- Type 118, Form 0,1 - ---Purpose : Defines IGES RuledSurface class SurfaceOfRevolution; - -- Type 120, Form 0 - ---Purpose : Defines IGES SurfaceOfRevolution class TabulatedCylinder; - -- Type 122, Form 0 - ---Purpose : Defines IGES TabulatedCylinder class Direction; - -- Type 123, Form 0 - ---Purpose : Defines IGES Direction class TransformationMatrix; - -- Type 124, Form 0 - ---Purpose : Defines IGES TransformationMatrix class Flash; - -- Type 125, Form 0-4 - ---Purpose : Defines IGES Flash class BSplineCurve; - -- Type 126, Form 0-5 - ---Purpose : Defines IGES BSplineCurve class BSplineSurface; - -- Type 128, Form 0-9 - ---Purpose : Defines IGES BSplineSurface class OffsetCurve; - -- Type 130, Form 0 - ---Purpose : Defines IGES OffsetCurve class OffsetSurface; - -- Type 140, Form 0 - ---Purpose : Defines IGES OffsetSurface class Boundary; - -- Type 141, Form 0 - ---Purpose : Defines IGES Boundary class CurveOnSurface; - -- Type 142, Form 0 - ---Purpose : Defines IGES CurveOnSurface class BoundedSurface; - -- Type 143, Form 0 - ---Purpose : Defines IGES BoundedSurface class TrimmedSurface; - -- Type 144, Form 0 - ---Purpose : Defines IGES TrimmedSurface -- Tools for Entities -- diff --git a/src/IGESGraph/IGESGraph.cdl b/src/IGESGraph/IGESGraph.cdl index ffcb38361f..89a2528bf6 100644 --- a/src/IGESGraph/IGESGraph.cdl +++ b/src/IGESGraph/IGESGraph.cdl @@ -35,85 +35,32 @@ uses is class LineFontDefTemplate; - -- type <304> form <1> - ---Purpose : Line Font Def can be defined as a repetition of Template - -- figure that is displayed at regularly spaced locations - -- along a planar anchoring curve. The anchoring curve - -- itself has no visual purpose. class LineFontDefPattern; - -- type <304> form <2> - ---Purpose : Line Font Def may be defined by repetition of a basic - -- pattern of visible-blank(or, on-off) segments - -- superimposed on a line or a curve. The line or curve - -- is then displayed according to the basic pattern. class TextFontDef; - -- type <310> - ---Purpose : Used to define the appearance of characters in a text - -- font. It may be used to describe a complete font or a - -- modification to a subset of characters in another font. class TextDisplayTemplate; - -- type <312> form <0, 1> - ---Purpose : Used to set parameters for display of information - -- which has been logically included in another entity - -- as a parameter value. class Color; - -- type <314> - ---Purpose : The Color Definition Entity is used to communicate the - -- relationship of primary colors to the intensity level of - -- the respective graphics devices as a percent of full - -- intensity range. class DefinitionLevel; - -- type <406> form <1> - ---Purpose : Indicates the no. of levels on which an entity is - -- defined. class NominalSize; - -- type <406> form <13> - ---Purpose : Specifies a value, a name, and optionally a - -- reference to an engineering standard. class DrawingSize; - -- type <406> form <16> - ---Purpose : Specifies the drawing size in drawing units. The - -- origin of the drawing is defined to be (0,0) in - -- drawing space. class DrawingUnits; - -- type <406> form <17> - ---Purpose : Specifies the drawing space units as outlined - -- in the Drawing entity. class IntercharacterSpacing; - -- type <406> form <18> - ---Purpose : Specifies the gap between letters when fixed-pitch - -- spacing is used. class LineFontPredefined; - -- type <406> form <19> - ---Purpose : Provides the ability to specify a line font pattern - -- from a predefined list rather than from - -- Directory Entry Field 4. class HighLight; - -- type <406> form <20> - ---Purpose : Attaches information that an entity is to be - -- displayed in some system dependent manner. class Pick; - -- type <406> form <21> - ---Purpose : Attaches information that an entity may be picked - -- by whatever pick device is used in the receiving - -- system. class UniformRectGrid; - -- type <406> form <22> - ---Purpose : Stores sufficient information for the creation of - -- a uniform rectangular grid within a drawing. -- Tools for Entities -- diff --git a/src/IGESSolid/IGESSolid.cdl b/src/IGESSolid/IGESSolid.cdl index 88648929b2..4db868a617 100644 --- a/src/IGESSolid/IGESSolid.cdl +++ b/src/IGESSolid/IGESSolid.cdl @@ -35,126 +35,52 @@ uses is class Block; - -- Type 150 Form 0 - ---Purpose : The Block is a rectangular parallelopiped, defined with - -- one vertex at (X1, Y1, Z1) and three edges lying along - -- the local +X, +Y, +Z axes. class RightAngularWedge; - -- Type 152 Form 0 - ---Purpose : A right angular wedge is a triangular/trapezoidal prism class Cylinder; - -- Type 154 - ---Purpose : Defines a cylinder class ConeFrustum; - -- Type 156 Form 0 - ---Purpose : The Cone Frustum is defined by the center of the - -- larger circular face of the frustum, its radius, a unit - -- vector in the axis direction, a height in this direction - -- and a second circular face with radius which is lesser - -- than the first face. class Sphere; - -- Type 158 Form 0 - ---Purpose : Defines a sphere. class Torus; - -- Type 160 Form 0 - ---Purpose : A Torus is a solid formed by revolving a circular disc - -- about a specified coplanar axis. class SolidOfRevolution; - -- Type 162 Form 0,1 - ---Purpose : This entity is defined by revolving the area determined - -- by a planar curve about a specified axis through a given - -- fraction of full rotation. class SolidOfLinearExtrusion; - -- Type 164 - ---Purpose : Solid of linear extrusion is defined by translating an - -- area determined by a planar curve class Ellipsoid; - -- Type 168 Form 0 - ---Purpose : The ellipsoid is a solid bounded by the surface defined - -- by: - -- X^2 Y^2 Z^2 - -- ----- + ----- + ----- = 1 - -- LX^2 LY^2 LZ^2 class BooleanTree; - -- Type 180 Form 0 - ---Purpose : The Boolean tree describes a binary tree structure - -- composed of regularized Boolean operations and operands, - -- in post-order notation. class SelectedComponent; - -- Type 182 Form 0 - ---Purpose : The Selected Component entity provides a means of - -- selecting one component of a disjoint CSG solid class SolidAssembly; - -- Type 184 Form 0 - ---Purpose : Solid assembly is a collection of items which possess a - -- shared fixed geometric relationship. class ManifoldSolid; - -- Type 186 Form 0 - ---Purpose : A manifold solid is a bounded, closed, and finite volume - -- in three dimensional Euclidean space class PlaneSurface; - -- Type 190 Form 0,1 - ---Purpose : A plane surface entity is defined by a point on the - -- surface and a normal to it. class CylindricalSurface; - -- Type 192 - ---Purpose : Defines a cylindrical surface class ConicalSurface; - -- Type 194 Form 0,1 - ---Purpose : Defines a conical surface class SphericalSurface; - -- Type 196 Form 0,1 - ---Purpose : Defines a spherical surface class ToroidalSurface; - -- Type 198 Form 0,1 - ---Purpose : Defines a toroidal surface class SolidInstance; - -- Type 430 Form 0 - ---Purpose : This provides a mechanism for replicating a solid - -- representation. class VertexList; - -- Type 502 Form 1 - ---Purpose : It contains one or more vertices. class EdgeList; - -- Type 504 - ---Purpose : It contains one or more edge tuples. class Loop; - -- Type 508 Form 1 - ---Purpose : A Loop entity specifies a bound of a face. It represents - -- a connected collection of face boundaries, seams, and - -- poles of a single face. class Face; - -- Type 510 Form 1 - ---Purpose : Face entity is a bound (partial) which has finite area class Shell; - -- Type 514 Form 1 - ---Purpose : Shell entity is a connected entity of dimensionality 2 - -- which divides R3 into two arcwise connected open subsets, - -- one of which is finite. Inside of the shell is defined to - -- be the finite region. -- Tool for Entities -- @@ -191,7 +117,6 @@ is class SpecificModule; class TopoBuilder; - ---Purpose : a tool to build BREP IGES Entities -- Instantiations diff --git a/src/IGESSolid/IGESSolid_EdgeList.cdl b/src/IGESSolid/IGESSolid_EdgeList.cdl index 6223011f16..ca04a21a51 100644 --- a/src/IGESSolid/IGESSolid_EdgeList.cdl +++ b/src/IGESSolid/IGESSolid_EdgeList.cdl @@ -19,6 +19,7 @@ class EdgeList from IGESSolid inherits IGESEntity ---Purpose: defines EdgeList, Type <504> Form <1> -- in package IGESSolid -- EdgeList is defined as a segment joining two vertices + -- It contains one or more edge tuples. uses diff --git a/src/IGESSolid/IGESSolid_VertexList.cdl b/src/IGESSolid/IGESSolid_VertexList.cdl index af764217ef..949075d1ed 100644 --- a/src/IGESSolid/IGESSolid_VertexList.cdl +++ b/src/IGESSolid/IGESSolid_VertexList.cdl @@ -20,6 +20,7 @@ class VertexList from IGESSolid inherits IGESEntity -- in package IGESSolid -- A vertex is a point in R3. A vertex is the bound of an -- edge and can participate in the bounds of a face. + -- It contains one or more vertices. uses diff --git a/src/IntCurve/IntCurve.cdl b/src/IntCurve/IntCurve.cdl index 73b736a270..056f8aa42c 100644 --- a/src/IntCurve/IntCurve.cdl +++ b/src/IntCurve/IntCurve.cdl @@ -68,7 +68,6 @@ uses Standard , math, gp, TColgp, GeomAbs, is class IntConicConic; - ---Purpose: Intersection between 2 conics from gp. generic class DistBetweenPCurvesGen; @@ -83,15 +82,12 @@ is generic class ProjPCurGen,TheCurveLocator,TheLocateExtPC; generic class IntConicCurveGen,TheIntersector; - ---Purpose: Intersection between a conic from gp and a bounded parametric curve. generic class IntCurveCurveGen,TheProjPCur, TheIntConicCurve, IntConicCurve, TheIntPCurvePCurve; - - ---Purpose: Intersection between 2 2d curves. - + private class ProjectOnPConicTool; class PConic; diff --git a/src/IntCurve/IntCurve_IntConicCurveGen.cdl b/src/IntCurve/IntCurve_IntConicCurveGen.cdl index aa2f157de9..f3b3b89f04 100644 --- a/src/IntCurve/IntCurve_IntConicCurveGen.cdl +++ b/src/IntCurve/IntCurve_IntConicCurveGen.cdl @@ -24,7 +24,7 @@ inherits Intersection from IntRes2d ---Purpose: Generic algorithm to intersect a conic from gp and - -- a parametric curve. This class uses the class + -- a bounded parametric curve. This class uses the class -- IConicTool from IntCurve, and Domain from -- IntCurve. The template class for the PCurveTool -- is given in the package IntImpParGen (ParTool). diff --git a/src/IntPatch/IntPatch.cdl b/src/IntPatch/IntPatch.cdl index 09352d024c..3400f34ecb 100644 --- a/src/IntPatch/IntPatch.cdl +++ b/src/IntPatch/IntPatch.cdl @@ -50,9 +50,6 @@ is class ArcFunction; class InterferencePolyhedron; - ---Purpose: Compute the interference between two polyhedron. Points - -- of intersection , polylines of intersection and zones of - -- tangence. -- implicite/implicite diff --git a/src/IntPatch/IntPatch_InterferencePolyhedron.cdl b/src/IntPatch/IntPatch_InterferencePolyhedron.cdl index 7b08e3fc6b..c079083c0d 100644 --- a/src/IntPatch/IntPatch_InterferencePolyhedron.cdl +++ b/src/IntPatch/IntPatch_InterferencePolyhedron.cdl @@ -17,7 +17,8 @@ class InterferencePolyhedron from IntPatch inherits Interference from Intf ---Purpose: Computes the interference between two polyhedra or the - -- self interference of a polyhedron. + -- self interference of a polyhedron. Points of intersection, + -- polylines of intersection and zones of tangence. uses Pnt from gp, XYZ from gp, diff --git a/src/IntPolyh/IntPolyh.cdl b/src/IntPolyh/IntPolyh.cdl index 415653bdc1..138fed1f0f 100644 --- a/src/IntPolyh/IntPolyh.cdl +++ b/src/IntPolyh/IntPolyh.cdl @@ -66,18 +66,12 @@ is imported ArrayOfTriangles from IntPolyh; class Intersection; - ---Purpose: the main algorithm. Algorythm outputs are -- - -- lines and points like discribe in the last - -- paragraph. The Algorythm provides direct acces to - -- the elements of those lines and points. Other - -- classes of this package are for internal use and - -- only concern the algorithmic part. + ------------------------------------------------------------ ---- Internal classes and algorithms ------------------------------------------------------------ class Couple; - ---Purpose: couple of triangles class Point; @@ -92,7 +86,6 @@ is class MaillageAffinage; - ---Purpose: Provide the algorythms used in the package class SectionLine; diff --git a/src/IntPolyh/IntPolyh_Couple.cdl b/src/IntPolyh/IntPolyh_Couple.cdl index 5ce3607b13..ff48b8c264 100644 --- a/src/IntPolyh/IntPolyh_Couple.cdl +++ b/src/IntPolyh/IntPolyh_Couple.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class Couple from IntPolyh - + ---Purpose: couple of triangles uses diff --git a/src/IntPolyh/IntPolyh_Intersection.cdl b/src/IntPolyh/IntPolyh_Intersection.cdl index 99139c3030..d1315eff78 100644 --- a/src/IntPolyh/IntPolyh_Intersection.cdl +++ b/src/IntPolyh/IntPolyh_Intersection.cdl @@ -23,7 +23,12 @@ -- times. class Intersection from IntPolyh - + ---Purpose: the main algorithm. Algorythm outputs are + -- lines and points like discribe in the last + -- paragraph. The Algorythm provides direct acces to + -- the elements of those lines and points. Other + -- classes of this package are for internal use and + -- only concern the algorithmic part. uses diff --git a/src/IntPolyh/IntPolyh_MaillageAffinage.cdl b/src/IntPolyh/IntPolyh_MaillageAffinage.cdl index e4d303fdee..88af8c8c30 100644 --- a/src/IntPolyh/IntPolyh_MaillageAffinage.cdl +++ b/src/IntPolyh/IntPolyh_MaillageAffinage.cdl @@ -23,7 +23,7 @@ -- modified by ofv Thu Apr 8 14:45:35 2004 fip class MaillageAffinage from IntPolyh - + ---Purpose: Provide the algorythms used in the package uses Box from Bnd, diff --git a/src/IntTools/IntTools.cdl b/src/IntTools/IntTools.cdl index 082b74bf71..aacf176a37 100644 --- a/src/IntTools/IntTools.cdl +++ b/src/IntTools/IntTools.cdl @@ -58,60 +58,40 @@ is class CompareRange; class EdgeEdge; - ---Purpose: class provides the Edge/Edge algorithm class EdgeFace; - ---Purpose: class provides the Edge/Face algorithm class FClass2d; - ---Purpose: class provides classification of a point in a face class LineConstructor; - ---Purpose: class provides post-processing of results of - --- surfaces intersection ----- class MarkedRangeSet; - ---Purpose: auxiliary class for range management class BaseRangeSample; - ---Purpose: base class for range index management - + class CurveRangeSample; - ---Purpose: class for range index management of curve - + class SurfaceRangeSample; - ---Purpose: class for range index management of surface class CurveRangeLocalizeData; - - class SurfaceRangeLocalizeData; - - class BeanFaceIntersector; - ---Purpose: class provides computing ranges of parameters - --- of edge/face intersection. - ----- + class SurfaceRangeLocalizeData; + + class BeanFaceIntersector; + + class Curve; - ---Purpose: class is a container of - --- one 3d curve - --- two 2d curves - ----- class PntOnFace; class PntOn2Faces; class TopolTool; - ---Purpose: class redefines TopolTool from Adaptor3d class FaceFace; - ---Purpose: class provides the Face/Face algorithm - --- class Tools; - ---Purpose: class is a container of usefull geometrical and - --- topological algorithms - + generic class CArray1; --- --- I n s t a n t i a t i o n s @@ -169,8 +149,7 @@ is List from TCollection(Box from Bnd); class CurveRangeSampleMapHasher; - ---Purpose: class for range index management of curve - + class SurfaceRangeSampleMapHasher; class MapOfCurveSample instantiates diff --git a/src/IntTools/IntTools_BaseRangeSample.cdl b/src/IntTools/IntTools_BaseRangeSample.cdl index 7b79b5c826..15d3df5ea7 100644 --- a/src/IntTools/IntTools_BaseRangeSample.cdl +++ b/src/IntTools/IntTools_BaseRangeSample.cdl @@ -14,7 +14,7 @@ -- commercial license or contractual agreement. class BaseRangeSample from IntTools - + ---Purpose: base class for range index management is Create diff --git a/src/IntTools/IntTools_Curve.cdl b/src/IntTools/IntTools_Curve.cdl index 47abfdedb8..f5a71724e1 100644 --- a/src/IntTools/IntTools_Curve.cdl +++ b/src/IntTools/IntTools_Curve.cdl @@ -14,7 +14,9 @@ -- commercial license or contractual agreement. class Curve from IntTools - + ---Purpose: class is a container of + -- one 3d curve + -- two 2d curves uses Curve from Geom, diff --git a/src/IntTools/IntTools_CurveRangeSample.cdl b/src/IntTools/IntTools_CurveRangeSample.cdl index e8370872cd..f33fa367e5 100644 --- a/src/IntTools/IntTools_CurveRangeSample.cdl +++ b/src/IntTools/IntTools_CurveRangeSample.cdl @@ -14,6 +14,8 @@ -- commercial license or contractual agreement. class CurveRangeSample from IntTools inherits BaseRangeSample from IntTools + ---Purpose: class for range index management of curve + uses Range from IntTools is diff --git a/src/IntTools/IntTools_CurveRangeSampleMapHasher.cdl b/src/IntTools/IntTools_CurveRangeSampleMapHasher.cdl index b3ee6471c2..31b2073a91 100644 --- a/src/IntTools/IntTools_CurveRangeSampleMapHasher.cdl +++ b/src/IntTools/IntTools_CurveRangeSampleMapHasher.cdl @@ -14,6 +14,7 @@ -- commercial license or contractual agreement. class CurveRangeSampleMapHasher from IntTools + ---Purpose: class for range index management of curve uses CurveRangeSample from IntTools diff --git a/src/IntTools/IntTools_LineConstructor.cdl b/src/IntTools/IntTools_LineConstructor.cdl index 544f6b954d..4157b4ba57 100644 --- a/src/IntTools/IntTools_LineConstructor.cdl +++ b/src/IntTools/IntTools_LineConstructor.cdl @@ -17,6 +17,8 @@ class LineConstructor from IntTools ---Purpose: Splits given Line. + -- Class provides post-processing of results of + -- surfaces intersection uses Line from IntPatch, TopolTool from Adaptor3d, diff --git a/src/IntTools/IntTools_SurfaceRangeSample.cdl b/src/IntTools/IntTools_SurfaceRangeSample.cdl index f59612f481..57c1861ddf 100644 --- a/src/IntTools/IntTools_SurfaceRangeSample.cdl +++ b/src/IntTools/IntTools_SurfaceRangeSample.cdl @@ -14,6 +14,8 @@ -- commercial license or contractual agreement. class SurfaceRangeSample from IntTools + ---Purpose: class for range index management of surface + uses Range from IntTools, CurveRangeSample from IntTools diff --git a/src/IntWalk/IntWalk.cdl b/src/IntWalk/IntWalk.cdl index ac0b0c98c3..5aa4e72566 100644 --- a/src/IntWalk/IntWalk.cdl +++ b/src/IntWalk/IntWalk.cdl @@ -49,10 +49,8 @@ is generic class IWalking, TheIWLine, SequenceOfIWLine; imported VectorOfWalkingData; - ---Purpose: Defines a dynamic vector of work data. - + imported VectorOfInteger; - ---Purpose: Defines a dynamic vector of integer. --algorithm/solution for a marching on intersection between diff --git a/src/IntWalk/IntWalk_VectorOfInteger.hxx b/src/IntWalk/IntWalk_VectorOfInteger.hxx index dc2be5bbb8..4de3a4dcdf 100755 --- a/src/IntWalk/IntWalk_VectorOfInteger.hxx +++ b/src/IntWalk/IntWalk_VectorOfInteger.hxx @@ -19,6 +19,8 @@ #include #include +// Defines a dynamic vector of integer. + typedef std::vector > IntWalk_VectorOfInteger; diff --git a/src/IntWalk/IntWalk_VectorOfWalkingData.hxx b/src/IntWalk/IntWalk_VectorOfWalkingData.hxx index d97814fd1a..ec973df27e 100755 --- a/src/IntWalk/IntWalk_VectorOfWalkingData.hxx +++ b/src/IntWalk/IntWalk_VectorOfWalkingData.hxx @@ -19,6 +19,8 @@ #include #include +// Defines a dynamic vector of work data. + struct IntWalk_WalkingData { Standard_Real ustart; diff --git a/src/Intf/Intf.cdl b/src/Intf/Intf.cdl index 0bd134b7df..c83c2c8cff 100644 --- a/src/Intf/Intf.cdl +++ b/src/Intf/Intf.cdl @@ -37,9 +37,6 @@ is -- Classes input data : deferred class Polygon2d; - ---Purpose: Describes the necessary polygon information to compute - -- the interferences. - class Array1OfLin instantiates Array1 from TCollection (Lin from gp); @@ -51,41 +48,28 @@ is -- Classes output data : class SectionPoint; - ---Purpose: Describes a common point between two polygons or between a - -- polygon and a polyhedron. class SeqOfSectionPoint instantiates Sequence from TCollection (SectionPoint); class SectionLine; - ---Purpose: Describes a common line between two polyhedrons. class SeqOfSectionLine instantiates Sequence from TCollection (SectionLine); class TangentZone; - ---Purpose: Describes a zone of tangence between two polygons or two - -- polyhedrons. class SeqOfTangentZone instantiates Sequence from TCollection (TangentZone); deferred class Interference; - ---Purpose: Describes the Interference computation result as three - -- sequences of points of intersection , polylines of - -- intersection and zones de tangence. - -- Algorithms : class Tool; - ---Purpose: The class tool provide methods to create Box or - -- Box2d in particular contex. - - class InterferencePolygon2d; diff --git a/src/Intf/Intf_Interference.cdl b/src/Intf/Intf_Interference.cdl index 602f8246c7..fa6e7587d0 100644 --- a/src/Intf/Intf_Interference.cdl +++ b/src/Intf/Intf_Interference.cdl @@ -17,7 +17,9 @@ deferred class Interference from Intf ---Purpose: Describes the Interference computation result - -- between polygon2d or polygon3d or polyhedron. + -- between polygon2d or polygon3d or polyhedron + -- (as three sequences of points of intersection, + -- polylines of intersection and zones de tangence). uses SectionPoint from Intf, SeqOfSectionPoint from Intf, diff --git a/src/Intf/Intf_Polygon2d.cdl b/src/Intf/Intf_Polygon2d.cdl index b903e59cbc..883c36ba50 100644 --- a/src/Intf/Intf_Polygon2d.cdl +++ b/src/Intf/Intf_Polygon2d.cdl @@ -15,7 +15,8 @@ deferred class Polygon2d from Intf - ---Purpose: + ---Purpose: Describes the necessary polygon information to compute + -- the interferences. uses Pnt2d from gp, Box2d from Bnd diff --git a/src/LProp/LProp.cdl b/src/LProp/LProp.cdl index 261c2a8480..5b946d8073 100644 --- a/src/LProp/LProp.cdl +++ b/src/LProp/LProp.cdl @@ -60,17 +60,12 @@ is exception NotDefined inherits Failure; generic class CLProps; - ---Purpose: Computation of local properties of a curve. - generic class SLProps; - ---Purpose: Computation of local properties of a surface. - + generic class SLProps; + class CurAndInf; - ---Purpose: Stores the parameters of a curve 2d or 3d corresponding - -- to the curvature's extremas and the inflection's points. - + class AnalyticCurInf; - ---Purpose: Computes the locals extremas of curvature of a gp curve. private class SequenceOfCIType instantiates Sequence from TCollection (CIType from LProp); diff --git a/src/LocalAnalysis/LocalAnalysis.cdl b/src/LocalAnalysis/LocalAnalysis.cdl index b1ab797fef..0dfef88d75 100644 --- a/src/LocalAnalysis/LocalAnalysis.cdl +++ b/src/LocalAnalysis/LocalAnalysis.cdl @@ -43,11 +43,7 @@ end StatusErrorType; class SurfaceContinuity; - ---Purpose: - -- This class computes and gives tools to check the local - -- continuity between two points situated on 2 surfaces - - + class CurveContinuity; ---Purpose: -- This class compute diff --git a/src/MAT/MAT.cdl b/src/MAT/MAT.cdl index 0680ad8e25..d2cf041cd4 100644 --- a/src/MAT/MAT.cdl +++ b/src/MAT/MAT.cdl @@ -30,20 +30,14 @@ is --- Purpose: Definition on the Left and the Right on the Fig. class Graph; - --- Purpose: Graph of exploration of the Bisecting Locus. class Arc; - --- Purpose: Arc of Graph. - + class Node; - --- Purpose: Node of Graph. - + class BasicElt; - --- Purpose: BasicElt of Graph. - + class Zone; - --- Purpose: Class Zone contains the frontiere of the Zone of proximity - -- of a BasicElt. class SequenceOfBasicElt instantiates Sequence from TCollection (BasicElt from MAT); diff --git a/src/MAT/MAT_Node.cdl b/src/MAT/MAT_Node.cdl index f1154ead1e..9b0ece96b6 100644 --- a/src/MAT/MAT_Node.cdl +++ b/src/MAT/MAT_Node.cdl @@ -16,7 +16,7 @@ class Node from MAT - ---Purpose : + ---Purpose : Node of Graph. inherits diff --git a/src/MAT2d/MAT2d.cdl b/src/MAT2d/MAT2d.cdl index 94d57936b5..08cecae47b 100644 --- a/src/MAT2d/MAT2d.cdl +++ b/src/MAT2d/MAT2d.cdl @@ -34,34 +34,18 @@ uses is deferred class SketchExplorer; - ---Purpose: SletchExplorer contains an iterator on a set of geometrys - -- from Geom2d. It's use by BisectingLocus. - - + class Tool2d; - ---Purpose: Tool2d contains the geometrys of the map. Tool2d - -- contains the set of the geometric's methode used for - -- the map's computation. class Mat2d; - --- Purpose: The Algorithm of Computation of the Map of - -- bisecting locus. class Connexion; - ---Purpose: a Connexion links two lines. class MiniPath; - ---Purpose: MiniPath computes one minimum path to link all the - -- lines of a set. - + class Circuit; - ---Purpose: EquiCircuit gives a Circuit passing by all the lines - -- in a set and all the connexions of the minipath associated. - + class CutCurve; - ---Purpose: Cuts a curve at the extremas of curvature - -- and at the inflections. Constructs a trimmed - -- Curve for each interval. class SequenceOfConnexion instantiates Sequence from TCollection (Connexion from MAT2d); diff --git a/src/MAT2d/MAT2d_Circuit.cdl b/src/MAT2d/MAT2d_Circuit.cdl index 248aa6de3d..6052458ef7 100644 --- a/src/MAT2d/MAT2d_Circuit.cdl +++ b/src/MAT2d/MAT2d_Circuit.cdl @@ -21,7 +21,8 @@ inherits TShared from MMgt ---Purpose: Constructs a circuit on a set of lines. - -- + -- EquiCircuit gives a Circuit passing by all the lines + -- in a set and all the connexions of the minipath associated. -- uses diff --git a/src/MAT2d/MAT2d_SketchExplorer.cdl b/src/MAT2d/MAT2d_SketchExplorer.cdl index e1dee0b189..88e3317e5b 100644 --- a/src/MAT2d/MAT2d_SketchExplorer.cdl +++ b/src/MAT2d/MAT2d_SketchExplorer.cdl @@ -19,6 +19,7 @@ deferred class SketchExplorer from MAT2d ---Purpose: SketchExplorer is an iterator on a sketch. A -- sketch is a set of contours, each contour is a set -- of curves from Geom2d. + -- It's use by BisectingLocus. uses diff --git a/src/MDF/MDF.cdl b/src/MDF/MDF.cdl index 130e9be28a..65b6658c79 100644 --- a/src/MDF/MDF.cdl +++ b/src/MDF/MDF.cdl @@ -76,8 +76,8 @@ is class Tool from MDF; - ---Purpose: Storage and Retrieval attributes drivers - -- ======================================== + ---Category: Storage and Retrieval attributes drivers + -- ======================================== class TagSourceStorageDriver; diff --git a/src/MDataStd/MDataStd.cdl b/src/MDataStd/MDataStd.cdl index a3894e0afb..be7aaf901a 100644 --- a/src/MDataStd/MDataStd.cdl +++ b/src/MDataStd/MDataStd.cdl @@ -33,8 +33,8 @@ uses TDF, is - ---Purpose: Storage drivers for TDataStd attributes - -- ======================================= + ---Category: Storage drivers for TDataStd attributes + -- ======================================= class DirectoryStorageDriver; @@ -80,8 +80,8 @@ is class AsciiStringStorageDriver; class IntPackedMapStorageDriver; - ---Purpose: Retrieval drivers for PDataStd attributes - -- ========================================= + ---Category: Retrieval drivers for PDataStd attributes + -- ========================================= class DirectoryRetrievalDriver; diff --git a/src/MDataXtd/MDataXtd.cdl b/src/MDataXtd/MDataXtd.cdl index 0b8ba847ee..29e9d6cf82 100644 --- a/src/MDataXtd/MDataXtd.cdl +++ b/src/MDataXtd/MDataXtd.cdl @@ -36,8 +36,8 @@ uses TDF, is - ---Purpose: Storage drivers for TDataXtd attributes - -- ======================================= + ---Category: Storage drivers for TDataXtd attributes + -- ======================================= class ShapeStorageDriver; @@ -57,8 +57,8 @@ is - ---Purpose: Retrieval drivers for PDataXtd attributes - -- ========================================= + ---Category: Retrieval drivers for PDataXtd attributes + -- ========================================= class ShapeRetrievalDriver; diff --git a/src/MDocStd/MDocStd.cdl b/src/MDocStd/MDocStd.cdl index b2f031b2db..13144d3d1e 100644 --- a/src/MDocStd/MDocStd.cdl +++ b/src/MDocStd/MDocStd.cdl @@ -25,8 +25,8 @@ uses TColStd, TCollection, PCollection, PTColStd, is - ---Purpose: Standard CAF Document drivers - -- ============================= + ---Category: Standard CAF Document drivers + -- ============================= class DocumentStorageDriver; @@ -34,8 +34,8 @@ is class DocumentRetrievalDriver; - ---Purpose: External Reference Attribute drivers - -- ===================================== + ---Category: External Reference Attribute drivers + -- ===================================== class XLinkStorageDriver; diff --git a/src/MMgt/MMgt.cdl b/src/MMgt/MMgt.cdl index 1c4b4f7b7f..2f641c805e 100644 --- a/src/MMgt/MMgt.cdl +++ b/src/MMgt/MMgt.cdl @@ -24,7 +24,5 @@ uses Standard is deferred class TShared; - ---Purpose: - -- Intermediate class between Standard_Transient and descendants. end MMgt; diff --git a/src/MMgt/MMgt_TShared.cdl b/src/MMgt/MMgt_TShared.cdl index 0dcfd92434..8dadb2e61b 100644 --- a/src/MMgt/MMgt_TShared.cdl +++ b/src/MMgt/MMgt_TShared.cdl @@ -19,6 +19,8 @@ deferred class TShared from MMgt inherits Transient from Standard ---Purpose: +-- Intermediate class between Standard_Transient +-- and descendants. -- The abstract class TShared is the root class of -- managed objects. TShared objects are managed -- by a memory manager based on reference diff --git a/src/MPrsStd/MPrsStd.cdl b/src/MPrsStd/MPrsStd.cdl index 2d15fd7437..0f7b8d0bd6 100644 --- a/src/MPrsStd/MPrsStd.cdl +++ b/src/MPrsStd/MPrsStd.cdl @@ -28,18 +28,14 @@ uses TDF, is - ---Purpose: Storage drivers for graphic attributes from - -- TPrsStd ---Category: StorageDriver class AISPresentationStorageDriver; class PositionStorageDriver; - - ---Purpose: Retrieval drivers for graphic attributes from - -- PPrsStd - ---Category: RetrievalDriver + ---Category: RetrievalDriver + class AISPresentationRetrievalDriver; class AISPresentationRetrievalDriver_1; class PositionRetrievalDriver; diff --git a/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver.cdl b/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver.cdl index f9cc433e89..77886fb6e1 100644 --- a/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver.cdl +++ b/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver.cdl @@ -16,7 +16,8 @@ class AISPresentationRetrievalDriver from MPrsStd inherits ARDriver from MDF - ---Purpose: + ---Purpose: Retrieval drivers for graphic attributes from + -- PPrsStd uses RRelocationTable from MDF, Attribute from PDF, diff --git a/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver_1.cdl b/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver_1.cdl index f9ba1dea4a..b54560ecd4 100644 --- a/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver_1.cdl +++ b/src/MPrsStd/MPrsStd_AISPresentationRetrievalDriver_1.cdl @@ -16,7 +16,8 @@ class AISPresentationRetrievalDriver_1 from MPrsStd inherits ARDriver from MDF - ---Purpose: + ---Purpose: Retrieval drivers for graphic attributes from + -- PPrsStd uses RRelocationTable from MDF, Attribute from PDF, diff --git a/src/MPrsStd/MPrsStd_AISPresentationStorageDriver.cdl b/src/MPrsStd/MPrsStd_AISPresentationStorageDriver.cdl index d1fc5e094c..774b71b807 100644 --- a/src/MPrsStd/MPrsStd_AISPresentationStorageDriver.cdl +++ b/src/MPrsStd/MPrsStd_AISPresentationStorageDriver.cdl @@ -16,7 +16,8 @@ class AISPresentationStorageDriver from MPrsStd inherits ASDriver from MDF - ---Purpose: + ---Purpose: Storage driver for graphic attributes from + -- TPrsStd uses SRelocationTable from MDF, Attribute from TDF, diff --git a/src/MPrsStd/MPrsStd_PositionRetrievalDriver.cdl b/src/MPrsStd/MPrsStd_PositionRetrievalDriver.cdl index 9d5c0b857b..d0c078d703 100644 --- a/src/MPrsStd/MPrsStd_PositionRetrievalDriver.cdl +++ b/src/MPrsStd/MPrsStd_PositionRetrievalDriver.cdl @@ -15,8 +15,8 @@ -- commercial license or contractual agreement. class PositionRetrievalDriver from MPrsStd inherits ARDriver from MDF - ---Purpose: - + ---Purpose: Retrieval drivers for graphic attributes from + -- PPrsStd uses RRelocationTable from MDF, diff --git a/src/MPrsStd/MPrsStd_PositionStorageDriver.cdl b/src/MPrsStd/MPrsStd_PositionStorageDriver.cdl index 27ca4ee734..1d5c961fb9 100644 --- a/src/MPrsStd/MPrsStd_PositionStorageDriver.cdl +++ b/src/MPrsStd/MPrsStd_PositionStorageDriver.cdl @@ -16,7 +16,8 @@ class PositionStorageDriver from MPrsStd inherits ASDriver from MDF - ---Purpose: + ---Purpose: Storage driver for graphic attributes from + -- TPrsStd uses SRelocationTable from MDF, Attribute from TDF, diff --git a/src/MeshVS/MeshVS.cdl b/src/MeshVS/MeshVS.cdl index a27b07977a..1e0d85c432 100644 --- a/src/MeshVS/MeshVS.cdl +++ b/src/MeshVS/MeshVS.cdl @@ -27,9 +27,6 @@ uses Graphic3d, gp, TCollection, Bnd, TColgp, Select3D, TopLoc, Aspect is - ---Purpose: The integer keys for most useful constants attuning mesh presentation appearence - -- WARNING: DA_TextExpansionFactor, DA_TextSpace, DA_TextDisplayType have no effect and might be removed - -- in the future. enumeration DrawerAttribute is @@ -107,9 +104,11 @@ is DA_User end DrawerAttribute; + ---Purpose: The integer keys for most useful constants attuning mesh presentation appearence + -- WARNING: DA_TextExpansionFactor, DA_TextSpace, DA_TextDisplayType have + -- no effect and might be removed in the future. + - ---Purpose: this enumeration describe what type of sensitive entity will be built - -- in 0-th selection mode (it means that whole mesh is selected ) enumeration MeshSelectionMethod is MSM_PRECISE, -- the list of sensitive entities according to nodes and elements (the slowest method) @@ -117,6 +116,9 @@ is MSM_BOX -- mesh bounding box (the fastest method) end MeshSelectionMethod; + ---Purpose: this enumeration describe what type of sensitive entity will be built + -- in 0-th selection mode (it means that whole mesh is selected ) + class Mesh; pointer MeshPtr to Mesh from MeshVS; diff --git a/src/Message/Message.cdl b/src/Message/Message.cdl index 554c91a5a0..b55d347020 100644 --- a/src/Message/Message.cdl +++ b/src/Message/Message.cdl @@ -49,25 +49,12 @@ is imported HArrayOfMsg; class Msg; - ---Purpose: Defines message. class MsgFile; - ---Purpose: Defines file storing messages. - class Messenger; - ---Purpose: Messenger is API class providing general-purpose interface for - -- libraries that may issue text messages without knowledge - -- of how these messages will be further processed. - class Algorithm; - ---Purpose: Class Message_Algorithm is the root class for all algorithms. - -- It provides generic mechanism for management execution status, - -- collection and output of corresponding error/warning messages deferred class Printer; - ---Purpose: Defines basic message printer. - - class PrinterOStream; - ---Purpose: Defines printer associated with an ostream + class PrinterOStream; class ListOfMsg instantiates List from TCollection (Msg from Message); diff --git a/src/MgtBRep/MgtBRep.cdl b/src/MgtBRep/MgtBRep.cdl index 3ef4977281..ab21ab0372 100644 --- a/src/MgtBRep/MgtBRep.cdl +++ b/src/MgtBRep/MgtBRep.cdl @@ -81,11 +81,9 @@ is -- --------- class TranslateTool; - ---Purpose: Auxiliary class used to call the MgtTopoDS methods. - + class TranslateTool1; - ---Purpose: Auxiliary class used to call the MgtTopoDS methods. - + -- --------------- -- Package Methods diff --git a/src/MgtBRep/MgtBRep_TranslateTool.cdl b/src/MgtBRep/MgtBRep_TranslateTool.cdl index 4ad50dd6fc..c1a4074077 100644 --- a/src/MgtBRep/MgtBRep_TranslateTool.cdl +++ b/src/MgtBRep/MgtBRep_TranslateTool.cdl @@ -21,6 +21,7 @@ class TranslateTool from MgtBRep inherits TranslateTool from MgtTopoDS ---Purpose: The TranslateTool class is provided to support the -- translation of BRep topological data structures. + -- Used to call the MgtTopoDS methods. uses TransientPersistentMap from PTColStd, diff --git a/src/MgtBRep/MgtBRep_TranslateTool1.cdl b/src/MgtBRep/MgtBRep_TranslateTool1.cdl index 5c5c564ecd..cd28d2da51 100644 --- a/src/MgtBRep/MgtBRep_TranslateTool1.cdl +++ b/src/MgtBRep/MgtBRep_TranslateTool1.cdl @@ -24,6 +24,7 @@ class TranslateTool1 from MgtBRep inherits TranslateTool1 from MgtTopoDS ---Purpose: The TranslateTool1 class is provided to support the -- translation of BRep topological data structures. + -- Used to call the MgtTopoDS methods. uses TransientPersistentMap from PTColStd, diff --git a/src/MgtTopoDS/MgtTopoDS.cdl b/src/MgtTopoDS/MgtTopoDS.cdl index c13b30bbe4..0e417f4ddb 100644 --- a/src/MgtTopoDS/MgtTopoDS.cdl +++ b/src/MgtTopoDS/MgtTopoDS.cdl @@ -68,12 +68,8 @@ uses is deferred class TranslateTool; - ---Purpose: Supports the translation of inherited parts of - -- classes. Root of all translation tools. deferred class TranslateTool1; - ---Purpose: Supports the translation of inherited parts of - -- classes. Root of all translation tools. ---Category: Old translate methods. diff --git a/src/MgtTopoDS/MgtTopoDS_TranslateTool.cdl b/src/MgtTopoDS/MgtTopoDS_TranslateTool.cdl index cd3e731f3a..4ead31f27d 100644 --- a/src/MgtTopoDS/MgtTopoDS_TranslateTool.cdl +++ b/src/MgtTopoDS/MgtTopoDS_TranslateTool.cdl @@ -23,7 +23,7 @@ deferred class TranslateTool from MgtTopoDS inherits TShared from MMgt ---Purpose: The TranslateTool class is provided to support the -- translation of inherited parts of topological data -- structures. - + -- Root of all translation tools. uses TransientPersistentMap from PTColStd, diff --git a/src/MgtTopoDS/MgtTopoDS_TranslateTool1.cdl b/src/MgtTopoDS/MgtTopoDS_TranslateTool1.cdl index 774eb4d89a..e4d1e59ae0 100644 --- a/src/MgtTopoDS/MgtTopoDS_TranslateTool1.cdl +++ b/src/MgtTopoDS/MgtTopoDS_TranslateTool1.cdl @@ -25,7 +25,7 @@ deferred class TranslateTool1 from MgtTopoDS inherits TShared from MMgt ---Purpose: The TranslateTool1 class is provided to support the -- translation of inherited parts of topological data -- structures. - + -- Root of all translation tools. uses TransientPersistentMap from PTColStd, diff --git a/src/OSD/OSD.cdl b/src/OSD/OSD.cdl index abd27fc1ca..0d349e4431 100755 --- a/src/OSD/OSD.cdl +++ b/src/OSD/OSD.cdl @@ -38,9 +38,6 @@ is exception OSDError inherits Failure from Standard ; imported Function; - ---Purpose: This is in fact a pointer to a function. - -- This is not an "enumeration" but a trick to solve an omission - -- from CDL. --- C++: alias "typedef int (* OSD_Function)(...);" enumeration OEMType is Unavailable,SUN,DEC,SGI,NEC,MAC,PC,HP,IBM,VAX,LIN,AIX; @@ -98,64 +95,39 @@ is ---Purpose: Allows great accuracy for error management. -- This is private. - class Error; - ---Purpose: Accurate management of OSD specific errors. class Protection; - ---Purpose: Gets and sets protection attributes of 'system , user , - -- group, and world'. class Path; - ---Purpose: Manages independent system path translation. deferred class FileNode; - ---Purpose: A set of file/directory manipulation tools. class Disk; - ---Purpose: A set of disk oriented tools. class File; - ---Purpose: A set of file oriented tools. class FileIterator; - ---Purpose: Searches for child files in current directory. class Directory; - ---Purpose: A set of directory oriented tools class DirectoryIterator; - ---Purpose: Searches sub-directories in current directory. class Chronometer; - ---Purpose: Measures time elapsed for performance program tests. - -- Measures CPU time consumed by a method call. class Timer; - ---Purpose: Measures the effective time elapsed for a method call. class Printer; - ---Purpose: Selects a printer (used by File). class Host; - ---Purpose: Carries information about a host. - -- System version ,host name, nodename ... class Environment; - ---Purpose: Manages environment variables. class EnvironmentIterator; - ---Purpose: Get all environment variables. class Process; - ---Purpose: Process specific oriented tools - --- class Mutex is alias Mutex from Standard; - ---Purpose: Mutex object to synchronize threads within one process class SharedLibrary; - ---Purpose: Provides tools to load a shared library - -- and retrieve the address of an entry point. imported MemInfo; imported PThread; diff --git a/src/OSD/OSD_Directory.cdl b/src/OSD/OSD_Directory.cdl index 8be7b7df81..0b2a08fbc4 100644 --- a/src/OSD/OSD_Directory.cdl +++ b/src/OSD/OSD_Directory.cdl @@ -20,7 +20,7 @@ class Directory from OSD - ---Purpose: Management of directories + ---Purpose: Management of directories (a set of directory oriented tools) inherits FileNode diff --git a/src/OSD/OSD_Disk.cdl b/src/OSD/OSD_Disk.cdl index 09a3736bfb..6d9fc6aaec 100644 --- a/src/OSD/OSD_Disk.cdl +++ b/src/OSD/OSD_Disk.cdl @@ -16,7 +16,7 @@ class Disk from OSD - ---Purpose: Disk management + ---Purpose: Disk management (a set of disk oriented tools) uses Error, Path, CString from Standard, AsciiString from TCollection diff --git a/src/OSD/OSD_Error.cdl b/src/OSD/OSD_Error.cdl index 8929a56f99..d955b29504 100755 --- a/src/OSD/OSD_Error.cdl +++ b/src/OSD/OSD_Error.cdl @@ -16,7 +16,7 @@ class Error from OSD - ---Purpose: Management of OSD errors + ---Purpose: Accurate management of OSD specific errors. -- Each method can be error tested with object.Failed(). -- To manage an occuring error, just use object.Perror(); diff --git a/src/OSD/OSD_FileNode.cdl b/src/OSD/OSD_FileNode.cdl index 127b16dd11..90e176f321 100644 --- a/src/OSD/OSD_FileNode.cdl +++ b/src/OSD/OSD_FileNode.cdl @@ -17,7 +17,7 @@ deferred class FileNode from OSD ---Purpose: A class for 'File' and 'Directory' grouping common - -- methods. + -- methods (file/directory manipulation tools). -- The "file oriented" name means files or directories which are -- in fact hard coded as files. diff --git a/src/OSD/OSD_Function.hxx b/src/OSD/OSD_Function.hxx index cb9aed710f..695dd905cf 100644 --- a/src/OSD/OSD_Function.hxx +++ b/src/OSD/OSD_Function.hxx @@ -15,6 +15,9 @@ #ifndef OSD_Function_HeaderFile #define OSD_Function_HeaderFile +// This is in fact a pointer to a function. +// This is not an "enumeration" but a trick to solve an omission from CDL. + typedef int (* OSD_Function)(...); #endif diff --git a/src/OSD/OSD_Host.cdl b/src/OSD/OSD_Host.cdl index 20ae651320..ac7db04882 100644 --- a/src/OSD/OSD_Host.cdl +++ b/src/OSD/OSD_Host.cdl @@ -17,6 +17,7 @@ class Host from OSD ---Purpose: Carries information about a Host + -- System version ,host name, nodename ... uses SysType, OEMType, Error, AsciiString from TCollection diff --git a/src/OSD/OSD_Printer.cdl b/src/OSD/OSD_Printer.cdl index cc433414fa..7284369ae2 100644 --- a/src/OSD/OSD_Printer.cdl +++ b/src/OSD/OSD_Printer.cdl @@ -16,7 +16,7 @@ class Printer from OSD - ---Purpose: Selects a printer. + ---Purpose: Selects a printer (used by File). uses Error, AsciiString from TCollection raises ConstructionError, NullObject, OSDError diff --git a/src/OSD/OSD_SharedLibrary.cdl b/src/OSD/OSD_SharedLibrary.cdl index 51ff8e652d..1bc413fd52 100644 --- a/src/OSD/OSD_SharedLibrary.cdl +++ b/src/OSD/OSD_SharedLibrary.cdl @@ -19,6 +19,8 @@ class SharedLibrary from OSD ---Purpose: Interface to dynamic library loader. + -- Provides tools to load a shared library + -- and retrieve the address of an entry point. uses LoadMode,Function is diff --git a/src/ObjMgt/ObjMgt.cdl b/src/ObjMgt/ObjMgt.cdl index 51f965f290..705ee44e65 100644 --- a/src/ObjMgt/ObjMgt.cdl +++ b/src/ObjMgt/ObjMgt.cdl @@ -33,15 +33,13 @@ uses is --deferred class RetrievalDriver; - ---Purpose: to retrieve ExternShareable objects in the framework. + --- to retrieve ExternShareable objects in the framework. deferred class ExternShareable; - ---Purpose: Defines the root persistent object which can be persistent - -- extern reference. + private class ExternRef; - ---Purpose: Defines (objet-relais) to implement extern reference. private class PSeqOfExtRef instantiates HSequence from PCollection (ExternRef from ObjMgt); diff --git a/src/ObjMgt/ObjMgt_ExternRef.cdl b/src/ObjMgt/ObjMgt_ExternRef.cdl index db00706a41..a74c42b76f 100644 --- a/src/ObjMgt/ObjMgt_ExternRef.cdl +++ b/src/ObjMgt/ObjMgt_ExternRef.cdl @@ -12,6 +12,7 @@ -- commercial license or contractual agreement. private class ExternRef from ObjMgt inherits Persistent from Standard + ---Purpose: Defines (objet-relais) to implement extern reference. uses HAsciiString from PCollection is diff --git a/src/ObjMgt/ObjMgt_ExternShareable.cdl b/src/ObjMgt/ObjMgt_ExternShareable.cdl index d08d3d51e1..c2a02881a8 100644 --- a/src/ObjMgt/ObjMgt_ExternShareable.cdl +++ b/src/ObjMgt/ObjMgt_ExternShareable.cdl @@ -14,6 +14,8 @@ deferred class ExternShareable from ObjMgt inherits Persistent from Standard + ---Purpose: Defines the root persistent object which can be persistent + -- extern reference. uses HAsciiString from PCollection diff --git a/src/PBRep/PBRep.cdl b/src/PBRep/PBRep.cdl index 439c0d7e9d..abb96c9fe8 100644 --- a/src/PBRep/PBRep.cdl +++ b/src/PBRep/PBRep.cdl @@ -39,83 +39,47 @@ uses is deferred class CurveRepresentation; - ---Purpose: Root for curve representations. deferred class GCurve; - ---Purpose: Root class for geometric curves representations. - -- Contains a first an a last parameter. - + class Curve3D; - ---Purpose: Representation by a 3d curve. - + class CurveOnSurface; - ---Purpose: Representation by a curve in the parametric space - -- of a surface. class CurveOnClosedSurface; - ---Purpose: Representation by two curves in the parametric - -- space of a surface. class Polygon3D; - ---Purpose: Representation by a 3D polygon. class PolygonOnTriangulation; - ---Purpose: Representation by an array of indices on a - -- triangulation. - + class PolygonOnClosedTriangulation; - ---Purpose: Representation by two arrays of indices on a - -- triangulation. - + class PolygonOnSurface; - ---Purpose: Representation by 2d polygon in the parametric space - -- of a surface. class PolygonOnClosedSurface; - ---Purpose: Representation by two 2d polygons in the parametric - -- space of the surface. - + class CurveOn2Surfaces; - ---Purpose: Geometric continuity bewtween two surfaces. - + deferred class PointRepresentation; - ---Purpose: Root for point representations. - + class PointOnCurve; - ---Purpose: Representation by a parameter on a 3D curve. - + deferred class PointsOnSurface; - ---Purpose: Root for points on surface. - + class PointOnCurveOnSurface; - ---Purpose: Representation by a parameter on a curve on a - -- surface. class PointOnSurface; - ---Purpose: Representation by two parameters on a surface. class TFace; - ---Purpose: The TFace class is inherited from the TFace from - -- TopoDS. - + class TEdge; - ---Purpose: The TEdge class is inherited from the TEdge from - -- TopoDS. class TVertex; - ---Purpose: The TVertex class is inherited from the TVertex - -- from TopoDS. class TFace1; - ---Purpose: The TFace class is inherited from the TFace from - -- TopoDS. - + class TEdge1; - ---Purpose: The TEdge class is inherited from the TEdge from - -- TopoDS. class TVertex1; - ---Purpose: The TVertex class is inherited from the TVertex - -- from TopoDS. end PBRep; diff --git a/src/PBRep/PBRep_GCurve.cdl b/src/PBRep/PBRep_GCurve.cdl index c6a2eece48..aea6d56fed 100644 --- a/src/PBRep/PBRep_GCurve.cdl +++ b/src/PBRep/PBRep_GCurve.cdl @@ -18,6 +18,7 @@ deferred class GCurve from PBRep inherits CurveRepresentation from PBRep ---Purpose: Root class for the geometric curves -- representation. Contains a range. + -- Contains a first and a last parameter. uses diff --git a/src/PBRep/PBRep_PointOnCurve.cdl b/src/PBRep/PBRep_PointOnCurve.cdl index 23b171e0f6..645aa92d9b 100644 --- a/src/PBRep/PBRep_PointOnCurve.cdl +++ b/src/PBRep/PBRep_PointOnCurve.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class PointOnCurve from PBRep inherits PointRepresentation from PBRep - + ---Purpose: Representation by a parameter on a 3D curve. uses Curve from PGeom, Location from PTopLoc diff --git a/src/PBRep/PBRep_PointOnCurveOnSurface.cdl b/src/PBRep/PBRep_PointOnCurveOnSurface.cdl index 88b554dc61..39b9584f1e 100644 --- a/src/PBRep/PBRep_PointOnCurveOnSurface.cdl +++ b/src/PBRep/PBRep_PointOnCurveOnSurface.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class PointOnCurveOnSurface from PBRep inherits PointsOnSurface from PBRep - + ---Purpose: Representation by a parameter on a curve on a + -- surface. uses Curve from PGeom2d, diff --git a/src/PBRep/PBRep_PointOnSurface.cdl b/src/PBRep/PBRep_PointOnSurface.cdl index faa699c71d..302fc9984b 100644 --- a/src/PBRep/PBRep_PointOnSurface.cdl +++ b/src/PBRep/PBRep_PointOnSurface.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. class PointOnSurface from PBRep inherits PointsOnSurface from PBRep - + ---Purpose: Representation by two parameters on a surface. uses Surface from PGeom, Location from PTopLoc diff --git a/src/PBRep/PBRep_PointsOnSurface.cdl b/src/PBRep/PBRep_PointsOnSurface.cdl index 4204f97cb9..62099800b0 100644 --- a/src/PBRep/PBRep_PointsOnSurface.cdl +++ b/src/PBRep/PBRep_PointsOnSurface.cdl @@ -15,7 +15,7 @@ -- commercial license or contractual agreement. deferred class PointsOnSurface from PBRep inherits PointRepresentation from PBRep - + ---Purpose: Root for points on surface. uses Surface from PGeom, diff --git a/src/PBRep/PBRep_Polygon3D.cdl b/src/PBRep/PBRep_Polygon3D.cdl index 7583e3e813..c6db65e823 100644 --- a/src/PBRep/PBRep_Polygon3D.cdl +++ b/src/PBRep/PBRep_Polygon3D.cdl @@ -16,7 +16,7 @@ class Polygon3D from PBRep inherits CurveRepresentation from PBRep - ---Purpose: + ---Purpose: Representation by a 3D polygon. uses Polygon3D from PPoly, diff --git a/src/PCollection/PCollection.cdl b/src/PCollection/PCollection.cdl index 1c3f3fd4da..513a0e4ab5 100644 --- a/src/PCollection/PCollection.cdl +++ b/src/PCollection/PCollection.cdl @@ -37,10 +37,6 @@ is generic class HSequence,SeqNode,SeqExplorer; - ---Purpose: Generic sequence of elements - -- indexed by an integer in the range 1..N. - - class HAsciiString; class HExtendedString; diff --git a/src/PCollection/PCollection_HSequence.cdl b/src/PCollection/PCollection_HSequence.cdl index 1be4071731..91d1e6073f 100644 --- a/src/PCollection/PCollection_HSequence.cdl +++ b/src/PCollection/PCollection_HSequence.cdl @@ -28,7 +28,8 @@ raises is ---Purpose: This class provides tools to manipulate a Sequence node. - + -- Generic sequence of elements indexed by an integer in the range 1..N. + Create( TheLast: SeqNode ; TheItem: Item) returns SeqNode from PCollection; diff --git a/src/PDataStd/PDataStd.cdl b/src/PDataStd/PDataStd.cdl index 50b4ce9077..3cddbec118 100644 --- a/src/PDataStd/PDataStd.cdl +++ b/src/PDataStd/PDataStd.cdl @@ -29,15 +29,15 @@ uses Standard, is - ---Purpose: General Data - -- ============ + ---Category: General Data + -- ============ class Name; class Comment; - ---Purpose: Basic Data for Modeling - -- ======================= + ---Category: Basic Data for Modeling + -- ======================= class Integer; @@ -63,8 +63,8 @@ is class Variable; - ---Purpose: Document Data for Modeling - -- ========================== + ---Category: Document Data for Modeling + -- ========================== class NoteBook; diff --git a/src/PDataXtd/PDataXtd.cdl b/src/PDataXtd/PDataXtd.cdl index 0843dd64c4..71ac6ccf44 100644 --- a/src/PDataXtd/PDataXtd.cdl +++ b/src/PDataXtd/PDataXtd.cdl @@ -39,8 +39,8 @@ uses Standard, is - ---Purpose: General Data - -- ============ + ---Category: General Data + -- ============ class Position; diff --git a/src/PMMgt/PMMgt.cdl b/src/PMMgt/PMMgt.cdl index 5b3606505e..e1b01f1fca 100644 --- a/src/PMMgt/PMMgt.cdl +++ b/src/PMMgt/PMMgt.cdl @@ -25,10 +25,5 @@ uses MMgt is deferred class PManaged; - ---Purpose: - -- Abstract base class providing protocols for persistent - -- storage allocation and deallocation. - -- - end PMMgt; diff --git a/src/PMMgt/PMMgt_PManaged.cdl b/src/PMMgt/PMMgt_PManaged.cdl index 37d6e59aa6..ffe4327b1b 100644 --- a/src/PMMgt/PMMgt_PManaged.cdl +++ b/src/PMMgt/PMMgt_PManaged.cdl @@ -19,10 +19,10 @@ deferred class PManaged from PMMgt inherits Persistent from Standard ---Purpose: - -- The class is a persistent abstract class that + -- The class is a persistent abstract base class that -- provides a strategy for managing the necessary storage - -- for an instance of . The storage is taken from - -- Persistent cache. + -- for an instance of (allocation and deallocation). + -- The storage is taken from Persistent cache. -- -- The storage of an instance is returned to persistent cache -- when the instance is deleted explicitly. diff --git a/src/PPoly/PPoly.cdl b/src/PPoly/PPoly.cdl index d7286852b3..50125b7a4a 100644 --- a/src/PPoly/PPoly.cdl +++ b/src/PPoly/PPoly.cdl @@ -32,29 +32,14 @@ uses PCollection, is class Triangle; - ---Purpose: A triangle is a triplet of integers (indices of - -- the nodes). - - class Triangulation; - ---Purpose: A Triangulation is a 3D polyhedron made of - -- triangles. It is made of a nodes which are - -- indexed. Nodes have a 3d value and a 2d value. - -- Triangles are triplet of node indices. - -- - -- This is a Transient class. + class Triangulation; class Polygon3D; - ---Purpose: A Polygon3D is made of indexed nodes. - -- Nodes have a 3d value. class Polygon2D; - ---Purpose: A Polygon2D is made of indexed nodes. - -- Nodes have a 2d value. - + class PolygonOnTriangulation; - ---Purpose: A polygonOnTriangulation is made of node indices - -- referencing a triangulation. class HArray1OfTriangle instantiates HArray1 from PCollection(Triangle from PPoly); diff --git a/src/PPoly/PPoly_Triangulation.cdl b/src/PPoly/PPoly_Triangulation.cdl index 7933e0fe86..16e94e76e0 100644 --- a/src/PPoly/PPoly_Triangulation.cdl +++ b/src/PPoly/PPoly_Triangulation.cdl @@ -36,7 +36,8 @@ class Triangulation from PPoly inherits Persistent from Standard -- triplet of node indices. A triangle is oriented -- and the whole triangulation must have a coherent -- orientation. - + -- + -- This is a Transient class. uses HArray1OfPnt2d from PColgp, HArray1OfPnt from PColgp, diff --git a/src/PTopLoc/PTopLoc.cdl b/src/PTopLoc/PTopLoc.cdl index ec66765c79..21b1e0e11f 100644 --- a/src/PTopLoc/PTopLoc.cdl +++ b/src/PTopLoc/PTopLoc.cdl @@ -45,15 +45,9 @@ uses is class Datum3D; - -- inherits Persistent from Standard - ---Purpose: Persistent elementary local coordinate system. - + private class ItemLocation; - -- inherits Persistent from Standard - ---Purpose: Persistent class used to implement Locations. - + class Location; - -- inherits Storable from Standard - ---Purpose: Storable composite local coordinate system. end PTopLoc; diff --git a/src/PTopoDS/PTopoDS.cdl b/src/PTopoDS/PTopoDS.cdl index 9d801db4d4..dd52580602 100644 --- a/src/PTopoDS/PTopoDS.cdl +++ b/src/PTopoDS/PTopoDS.cdl @@ -64,85 +64,41 @@ is -- ============================ class HShape; - ---Purpose: A reference (even outside the same container) to a - -- Topological shape with Location, Orientation. - + deferred class TShape; - -- inherits ExternShareable from ObjMgt - ---Purpose: A topological shape is a structure made from other - -- shapes. This is a deferred class used to support - -- topological objects. - + deferred class TVertex; - ---Purpose: A TVertex is a topological point in two or three - -- dimensions. - + class Vertex; - ---Purpose: A Vertex is a TVertex with a Location and an - -- Orientation. - -- It inherits HShape - + deferred class TEdge; - ---Purpose: A topological part of a curve in 2D or 3D, the - -- boundary is a set of oriented Vertices. - + class Edge; - ---Purpose: A Edge is a TEdge with a Location and an - -- Orientation. - -- It inherits HShape - + class TWire; - ---Purpose: A set of Edges making a wire structure, it can be - -- a wireframe or a composite line. - + class Wire; - ---Purpose: A Wire is a TWire with a Location and an - -- Orientation. - -- It inherits HShape - + class TFace; - ---Purpose: A topological part of a surface or of the 2D - -- space. The boundary is a set of wires and edges. - + class Face; - ---Purpose: A Face is a TFace with a Location and an - -- Orientation. - -- It inherits HShape - + class TShell; - ---Purpose: A set of Faces or Shells, a topological surface or - -- any faces structure. class Shell; - ---Purpose: A Shell is a TShell with a Location and an - -- Orientation. - -- It inherits HShape - + class TSolid; - ---Purpose: A Topological part of 3D space, bounded by Shells - -- and Faces. class Solid; - ---Purpose: A Solid is a TSolid with a Location and an - -- Orientation. - -- It inherits HShape - + class TCompSolid; - ---Purpose: A structure of Solids sharing Faces. - + class CompSolid; - ---Purpose: A CompSolid is a TCompSolid with a Location and an - -- Orientation. - -- It inherits HShape - + class TCompound; - ---Purpose: A TCompound is an all-purpose set of Shapes. - + class Compound; - ---Purpose: A Compound is a TCompound with a Location and an - -- Orientation. - -- It inherits HShape - + class HArray1OfHShape instantiates HArray1 from PCollection (HShape from PTopoDS); @@ -152,45 +108,25 @@ is -- ============================ class Shape1; - ---Purpose: A reference to a Topological TShape with Location, - -- Orientation. - + deferred class TShape1; - -- inherits ExternShareable from ObjMgt - ---Purpose: A topological shape is a structure made from other - -- shapes. This is a deferred class used to support - -- topological objects. - + deferred class TVertex1; - ---Purpose: A TVertex is a topological point in two or three - -- dimensions. - + deferred class TEdge1; - ---Purpose: A topological part of a curve in 2D or 3D, the - -- boundary is a set of oriented Vertices. - + class TWire1; - ---Purpose: A set of Edges making a wire structure, it can be - -- a wireframe or a composite line. - + class TFace1; - ---Purpose: A topological part of a surface or of the 2D - -- space. The boundary is a set of wires and edges. - + class TShell1; - ---Purpose: A set of Faces or Shells, a topological surface or - -- any faces structure. class TSolid1; - ---Purpose: A Topological part of 3D space, bounded by Shells - -- and Faces. + class TCompSolid1; - ---Purpose: A structure of Solids sharing Faces. - + class TCompound1; - ---Purpose: A TCompound is an all-purpose set of Shapes. - class HArray1OfShape1 instantiates HArray1 from PCollection (Shape1 from PTopoDS); diff --git a/src/PTopoDS/PTopoDS_CompSolid.cdl b/src/PTopoDS/PTopoDS_CompSolid.cdl index 3ebb82f8a1..ddfbb0193f 100644 --- a/src/PTopoDS/PTopoDS_CompSolid.cdl +++ b/src/PTopoDS/PTopoDS_CompSolid.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class CompSolid from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A CompSolid is a TCompSolid with a Location and an + -- Orientation. + -- It inherits HShape is Create returns CompSolid from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_Compound.cdl b/src/PTopoDS/PTopoDS_Compound.cdl index aba8d0105d..536b1c9b88 100644 --- a/src/PTopoDS/PTopoDS_Compound.cdl +++ b/src/PTopoDS/PTopoDS_Compound.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Compound from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Compound is a TCompound with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Compound from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_Edge.cdl b/src/PTopoDS/PTopoDS_Edge.cdl index 8c013d83f6..258dbf3c28 100644 --- a/src/PTopoDS/PTopoDS_Edge.cdl +++ b/src/PTopoDS/PTopoDS_Edge.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Edge from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Edge is a TEdge with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Edge from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_Face.cdl b/src/PTopoDS/PTopoDS_Face.cdl index e871cf794c..fc3e9314af 100644 --- a/src/PTopoDS/PTopoDS_Face.cdl +++ b/src/PTopoDS/PTopoDS_Face.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Face from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Face is a TFace with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Face from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_Shell.cdl b/src/PTopoDS/PTopoDS_Shell.cdl index c1f8979d56..41e96d54d9 100644 --- a/src/PTopoDS/PTopoDS_Shell.cdl +++ b/src/PTopoDS/PTopoDS_Shell.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Shell from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Shell is a TShell with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Shell from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_Solid.cdl b/src/PTopoDS/PTopoDS_Solid.cdl index 20d2f35b5c..bb636b1576 100644 --- a/src/PTopoDS/PTopoDS_Solid.cdl +++ b/src/PTopoDS/PTopoDS_Solid.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Solid from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Solid is a TSolid with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Solid from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_TCompSolid.cdl b/src/PTopoDS/PTopoDS_TCompSolid.cdl index 86b6fbb634..f1fbf9cc27 100644 --- a/src/PTopoDS/PTopoDS_TCompSolid.cdl +++ b/src/PTopoDS/PTopoDS_TCompSolid.cdl @@ -17,7 +17,7 @@ class TCompSolid from PTopoDS inherits TShape from PTopoDS ---Purpose: A topological Composite Solid shape. - + -- A structure of Solids sharing Faces. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TCompSolid1.cdl b/src/PTopoDS/PTopoDS_TCompSolid1.cdl index 1f037c8cd0..f9854f7d9b 100644 --- a/src/PTopoDS/PTopoDS_TCompSolid1.cdl +++ b/src/PTopoDS/PTopoDS_TCompSolid1.cdl @@ -17,7 +17,7 @@ class TCompSolid1 from PTopoDS inherits TShape1 from PTopoDS ---Purpose: A topological Composite Solid1 shape. - + -- A structure of Solids sharing Faces. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TEdge.cdl b/src/PTopoDS/PTopoDS_TEdge.cdl index 02a482fbe9..9eb91effca 100644 --- a/src/PTopoDS/PTopoDS_TEdge.cdl +++ b/src/PTopoDS/PTopoDS_TEdge.cdl @@ -16,7 +16,9 @@ deferred class TEdge from PTopoDS inherits TShape from PTopoDS - ---Purpose: A Topological edge shape. + ---Purpose: A topological part of a curve in 2D or 3D, the + -- boundary is a set of oriented Vertices. + -- A Topological edge shape. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TEdge1.cdl b/src/PTopoDS/PTopoDS_TEdge1.cdl index d1a6fff11b..6e2178ff22 100644 --- a/src/PTopoDS/PTopoDS_TEdge1.cdl +++ b/src/PTopoDS/PTopoDS_TEdge1.cdl @@ -17,7 +17,8 @@ deferred class TEdge1 from PTopoDS inherits TShape1 from PTopoDS ---Purpose: A Topological edge shape. - + -- A topological part of a curve in 2D or 3D, the + -- boundary is a set of oriented Vertices. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TFace.cdl b/src/PTopoDS/PTopoDS_TFace.cdl index 1039509ad0..4bb36a3073 100644 --- a/src/PTopoDS/PTopoDS_TFace.cdl +++ b/src/PTopoDS/PTopoDS_TFace.cdl @@ -17,7 +17,8 @@ class TFace from PTopoDS inherits TShape from PTopoDS ---Purpose: A topological Face. - + -- A topological part of a surface or of the 2D + -- space. The boundary is a set of wires and edges. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TFace1.cdl b/src/PTopoDS/PTopoDS_TFace1.cdl index 61f7eabfbe..254008510b 100644 --- a/src/PTopoDS/PTopoDS_TFace1.cdl +++ b/src/PTopoDS/PTopoDS_TFace1.cdl @@ -17,7 +17,8 @@ class TFace1 from PTopoDS inherits TShape1 from PTopoDS ---Purpose: A topological Face1. - + -- A topological part of a surface or of the 2D + -- space. The boundary is a set of wires and edges. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TShape.cdl b/src/PTopoDS/PTopoDS_TShape.cdl index 2c62c0a08b..3716e53edb 100644 --- a/src/PTopoDS/PTopoDS_TShape.cdl +++ b/src/PTopoDS/PTopoDS_TShape.cdl @@ -21,7 +21,8 @@ deferred class TShape from PTopoDS inherits Persistent from Standard ---Purpose: A TShape is a topological structure describing a -- set of points in a 2D or 3D space. - -- + -- This is a deferred class used to support + -- topological objects. -- All the information stored are potentially frozen. So has -- the "free" information no sense in the D.B. context. A diff --git a/src/PTopoDS/PTopoDS_TShape1.cdl b/src/PTopoDS/PTopoDS_TShape1.cdl index c2cff484f5..fe3aabd3d6 100644 --- a/src/PTopoDS/PTopoDS_TShape1.cdl +++ b/src/PTopoDS/PTopoDS_TShape1.cdl @@ -24,7 +24,9 @@ deferred class TShape1 from PTopoDS inherits Persistent from Standard ---Purpose: A TShape1 is a topological structure describing a -- set of points in a 2D or 3D space. - -- + -- A topological shape is a structure made from other + -- shapes. This is a deferred class used to support + -- topological objects. -- All the information stored are potentially frozen. So has -- the "free" information no sense in the D.B. context. A diff --git a/src/PTopoDS/PTopoDS_TShell.cdl b/src/PTopoDS/PTopoDS_TShell.cdl index f9dd6ec52b..a73f5f1f4a 100644 --- a/src/PTopoDS/PTopoDS_TShell.cdl +++ b/src/PTopoDS/PTopoDS_TShell.cdl @@ -17,7 +17,8 @@ class TShell from PTopoDS inherits TShape from PTopoDS ---Purpose: A topological Shell shape. - + -- A set of Faces or Shells, a topological surface or +---- any faces structure. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TShell1.cdl b/src/PTopoDS/PTopoDS_TShell1.cdl index 2f0af72a9d..fb991b0664 100644 --- a/src/PTopoDS/PTopoDS_TShell1.cdl +++ b/src/PTopoDS/PTopoDS_TShell1.cdl @@ -17,7 +17,8 @@ class TShell1 from PTopoDS inherits TShape1 from PTopoDS ---Purpose: A topological Shell1 shape. - + -- A set of Faces or Shells, a topological surface or + -- any faces structure. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TSolid.cdl b/src/PTopoDS/PTopoDS_TSolid.cdl index d195a2e73e..3d8063784e 100644 --- a/src/PTopoDS/PTopoDS_TSolid.cdl +++ b/src/PTopoDS/PTopoDS_TSolid.cdl @@ -16,8 +16,9 @@ class TSolid from PTopoDS inherits TShape from PTopoDS - ---Purpose: A topological Solid shape. - + ---Purpose: A topological Solid shape. + -- A Topological part of 3D space, bounded by Shells + -- and Faces. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TSolid1.cdl b/src/PTopoDS/PTopoDS_TSolid1.cdl index 8924fd9543..256a8938de 100644 --- a/src/PTopoDS/PTopoDS_TSolid1.cdl +++ b/src/PTopoDS/PTopoDS_TSolid1.cdl @@ -17,7 +17,8 @@ class TSolid1 from PTopoDS inherits TShape1 from PTopoDS ---Purpose: A topological Solid1 shape. - + -- A Topological part of 3D space, bounded by Shells + -- and Faces. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TVertex.cdl b/src/PTopoDS/PTopoDS_TVertex.cdl index 2ee2c24669..8960c5585e 100644 --- a/src/PTopoDS/PTopoDS_TVertex.cdl +++ b/src/PTopoDS/PTopoDS_TVertex.cdl @@ -16,7 +16,8 @@ deferred class TVertex from PTopoDS inherits TShape from PTopoDS - ---Purpose: The vertex is a topological point in space. + ---Purpose: The vertex is a topological point in two or three + -- dimensions. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TVertex1.cdl b/src/PTopoDS/PTopoDS_TVertex1.cdl index 4ccd9f093d..f1c528811e 100644 --- a/src/PTopoDS/PTopoDS_TVertex1.cdl +++ b/src/PTopoDS/PTopoDS_TVertex1.cdl @@ -16,7 +16,7 @@ deferred class TVertex1 from PTopoDS inherits TShape1 from PTopoDS - ---Purpose: The vertex is a topological point in space. + ---Purpose: The vertex is a topological point in in two or three dimensions. uses ShapeEnum from TopAbs diff --git a/src/PTopoDS/PTopoDS_TWire.cdl b/src/PTopoDS/PTopoDS_TWire.cdl index abf35f57df..0798030199 100644 --- a/src/PTopoDS/PTopoDS_TWire.cdl +++ b/src/PTopoDS/PTopoDS_TWire.cdl @@ -16,7 +16,8 @@ class TWire from PTopoDS inherits TShape from PTopoDS - ---Purpose: a Topological Wire is a structure of Edges. The + ---Purpose: a Topological Wire is a structure of Edges. + -- It can be a wireframe or a composite line. The -- Edges may have 2D curves stored with them. This is -- a curve in the parametric space of a Surface. diff --git a/src/PTopoDS/PTopoDS_TWire1.cdl b/src/PTopoDS/PTopoDS_TWire1.cdl index b158580d73..e5a15ffe11 100644 --- a/src/PTopoDS/PTopoDS_TWire1.cdl +++ b/src/PTopoDS/PTopoDS_TWire1.cdl @@ -16,8 +16,10 @@ class TWire1 from PTopoDS inherits TShape1 from PTopoDS - ---Purpose: a Topological Wire1 is a structure of Edge1s. The - -- Edge1s may have 2D curves stored with them. This is + ---Purpose: a Topological Wire1 is a structure of Edge1s. + -- A set of Edges making a wire structure, it can be + -- a wireframe or a composite line. + -- The Edge1s may have 2D curves stored with them. This is -- a curve in the parametric space of a Surface. uses diff --git a/src/PTopoDS/PTopoDS_Vertex.cdl b/src/PTopoDS/PTopoDS_Vertex.cdl index 660fe3b87b..5be83093c1 100644 --- a/src/PTopoDS/PTopoDS_Vertex.cdl +++ b/src/PTopoDS/PTopoDS_Vertex.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Vertex from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Vertex is a TVertex with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Vertex from PTopoDS; ---Level: Internal diff --git a/src/PTopoDS/PTopoDS_Wire.cdl b/src/PTopoDS/PTopoDS_Wire.cdl index 1ff1555c21..66aae7c4f4 100644 --- a/src/PTopoDS/PTopoDS_Wire.cdl +++ b/src/PTopoDS/PTopoDS_Wire.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class Wire from PTopoDS inherits HShape from PTopoDS - + ---Purpose: A Wire is a TWire with a Location and an + -- Orientation. + -- It inherits HShape is Create returns Wire from PTopoDS; ---Level: Internal diff --git a/src/Poly/Poly.cdl b/src/Poly/Poly.cdl index 2ae8eea7d8..3140a6e506 100644 --- a/src/Poly/Poly.cdl +++ b/src/Poly/Poly.cdl @@ -39,8 +39,6 @@ uses is class Triangle; - ---Purpose: A triangle is a triplet of integers (indices of - -- the nodes). class Array1OfTriangle instantiates Array1 from TCollection(Triangle from Poly); @@ -50,26 +48,12 @@ is Array1OfTriangle from Poly); class Triangulation; - ---Purpose: A Triangulation is a 3D polyhedron made of - -- triangles. It is made of a nodes which are - -- indexed. Nodes have a 3d value and a 2d value. - -- Triangles are triplet of node indices. - -- - -- This is a Transient class. - class Polygon3D; - ---Purpose: A Polygon3D is made of indexed nodes. - -- Nodes have a 3d value. class Polygon2D; - ---Purpose: A Polygon2D is made of indexed nodes. - -- Nodes have a 2d value. class PolygonOnTriangulation; - ---Purpose: A polygonOnTriangulation is made of node indices - -- referencing a triangulation. - -- -- Tools to use triangulations diff --git a/src/Poly/Poly_Triangulation.cdl b/src/Poly/Poly_Triangulation.cdl index b39b560f23..2f5d9d756d 100644 --- a/src/Poly/Poly_Triangulation.cdl +++ b/src/Poly/Poly_Triangulation.cdl @@ -40,6 +40,7 @@ class Triangulation from Poly inherits TShared from MMgt -- exact representation of a surface. A triangular -- representation induces simpler and more robust adjusting, -- faster performances, and the results are as good. + -- This is a Transient class. uses HArray1OfPnt2d from TColgp, diff --git a/src/ProjLib/ProjLib.cdl b/src/ProjLib/ProjLib.cdl index c5f2f0b2ff..c92e124524 100644 --- a/src/ProjLib/ProjLib.cdl +++ b/src/ProjLib/ProjLib.cdl @@ -80,16 +80,9 @@ is class ProjectOnPlane ; - ---Purpose: Project a curve on a plane. - class ProjectOnSurface ; - ---Purpose: Project a curve on a surface. The result ( a 3D - -- Curve) will be an approximation - - - -- --------------------------------------------------------------- -- Classes computing the PCurves of curves lying on a surface -- @@ -98,24 +91,10 @@ is class ComputeApprox; - ---Purpose: Approximate the projection of a 3d curve on an - -- analytic surface and stores the result in Approx. - -- The result is a 2d curve. - class ComputeApproxOnPolarSurface ; - ---Purpose: Approximate the projection of a 3d curve on an - -- polar surface and stores the result in Approx. - -- The result is a 2d curve. The evaluation of the - -- current point of the 2d curve is done with the - -- evaluation of the extrema P3d - Surface. - class ProjectedCurve ; - ---Purpose: Compute the 2d-curve. Try to solve the particular - -- case if possible. Otherwize, an approximation is - -- done. - class HProjectedCurve instantiates GenHCurve2d from Adaptor2d (ProjectedCurve); @@ -147,22 +126,16 @@ is -- ------------------------------------------------------------ class Projector; - ---Purpose: Root class for projections. Stores the result. - + class Plane; - ---Purpose: Projection on a plane. class Cylinder; - ---Purpose: Projection on a cylinder. class Cone; - ---Purpose: Projection on a cone. class Sphere; - ---Purpose: Projection on a sphere. class Torus; - ---Purpose: Projection on a torus. -- methods diff --git a/src/ProjLib/ProjLib_ComputeApprox.cdl b/src/ProjLib/ProjLib_ComputeApprox.cdl index 66b5eda78a..f4566c8a48 100644 --- a/src/ProjLib/ProjLib_ComputeApprox.cdl +++ b/src/ProjLib/ProjLib_ComputeApprox.cdl @@ -15,7 +15,9 @@ -- commercial license or contractual agreement. class ComputeApprox from ProjLib - + ---Purpose: Approximate the projection of a 3d curve on an + -- analytic surface and stores the result in Approx. + -- The result is a 2d curve. uses HCurve from Adaptor3d, diff --git a/src/ProjLib/ProjLib_ComputeApproxOnPolarSurface.cdl b/src/ProjLib/ProjLib_ComputeApproxOnPolarSurface.cdl index 0cc970f23d..8ada43ae38 100644 --- a/src/ProjLib/ProjLib_ComputeApproxOnPolarSurface.cdl +++ b/src/ProjLib/ProjLib_ComputeApproxOnPolarSurface.cdl @@ -15,7 +15,11 @@ -- commercial license or contractual agreement. class ComputeApproxOnPolarSurface from ProjLib - + ---Purpose: Approximate the projection of a 3d curve on an + -- polar surface and stores the result in Approx. + -- The result is a 2d curve. The evaluation of the + -- current point of the 2d curve is done with the + -- evaluation of the extrema P3d - Surface. uses diff --git a/src/ProjLib/ProjLib_ProjectOnSurface.cdl b/src/ProjLib/ProjLib_ProjectOnSurface.cdl index 2dfd14f64e..fd78b66fe3 100644 --- a/src/ProjLib/ProjLib_ProjectOnSurface.cdl +++ b/src/ProjLib/ProjLib_ProjectOnSurface.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class ProjectOnSurface from ProjLib - + ---Purpose: Project a curve on a surface. The result ( a 3D + -- Curve) will be an approximation uses HCurve from Adaptor3d, diff --git a/src/ProjLib/ProjLib_ProjectedCurve.cdl b/src/ProjLib/ProjLib_ProjectedCurve.cdl index 2339ae9cdc..2f050b6767 100644 --- a/src/ProjLib/ProjLib_ProjectedCurve.cdl +++ b/src/ProjLib/ProjLib_ProjectedCurve.cdl @@ -15,8 +15,9 @@ -- commercial license or contractual agreement. class ProjectedCurve from ProjLib inherits Curve2d from Adaptor2d - - + ---Purpose: Compute the 2d-curve. Try to solve the particular + -- case if possible. Otherwize, an approximation is + -- done. uses diff --git a/src/Prs3d/Prs3d.cdl b/src/Prs3d/Prs3d.cdl index 29c3fd41c0..e97e22472f 100644 --- a/src/Prs3d/Prs3d.cdl +++ b/src/Prs3d/Prs3d.cdl @@ -93,16 +93,8 @@ is -- otherwise - externally class Presentation; - ---Purpose: defines the presentation object. This object can be - -- displayed, highlighted, erased, etc... The output - -- of the presentation algorithms are sent in a - -- presentation object. A presentation object is attached - -- to a given Viewer. ---Category: Aspect classes. - ---Purpose: The aspect classes qualifies how to represent - -- a given kind of object. - -- deferred class BasicAspect; class PointAspect; @@ -117,24 +109,12 @@ is imported DimensionUnits; class Drawer; - ---Purpose: qualifies how the presentation algorithms compute - -- the presentation of a specific kind of object. - -- This includes for example color, width and type - -- of lines, maximal chordial deviation, etc... - -- A drawer includes an instance of the Aspect classes - -- with particular default values. - + class Projector; - ---Purpose: defines the projection parameters for the hidden - -- lines removal algorithm. - + class PlaneSet; - ---Purpose: defines a set of planes used for a presentation - -- by sections. - -- deferred class Root; - ---Purpose: defines the root of the presentation algorithms. ---Category: Basis construction elements. @@ -143,8 +123,6 @@ is ---Category: Class signatures. class ShapeTool; - ---Purpose: describes the behaviour requested for a wireframe - -- shape presentation. class Arrow; ---Purpose: draws an arrow at a given location, with respect diff --git a/src/Prs3d/Prs3d_BasicAspect.cdl b/src/Prs3d/Prs3d_BasicAspect.cdl index 447727a869..d262abea8f 100644 --- a/src/Prs3d/Prs3d_BasicAspect.cdl +++ b/src/Prs3d/Prs3d_BasicAspect.cdl @@ -13,7 +13,9 @@ -- Alternatively, this file may be used under the terms of Open CASCADE -- commercial license or contractual agreement. ----Purpose All basic Prs3d_xxxAspect must inherits from this class +---Purpose : All basic Prs3d_xxxAspect must inherits from this class +-- The aspect classes qualifies how to represent +-- a given kind of object. deferred class BasicAspect from Prs3d inherits TShared from MMgt diff --git a/src/Prs3d/Prs3d_Drawer.cdl b/src/Prs3d/Prs3d_Drawer.cdl index 26d5ab17a9..d84ee1f499 100644 --- a/src/Prs3d/Prs3d_Drawer.cdl +++ b/src/Prs3d/Prs3d_Drawer.cdl @@ -25,6 +25,8 @@ class Drawer from Prs3d inherits TShared from MMgt -- can see that the AIS_Drawer is modified to set the -- value of the deviation coefficient using a method -- inherited from Prs3d_Drawer. + -- A drawer includes an instance of the Aspect classes + -- with particular default values. uses DatumAspect from Prs3d, diff --git a/src/Prs3d/Prs3d_PlaneSet.cdl b/src/Prs3d/Prs3d_PlaneSet.cdl index 4cfb910b07..a391679cba 100644 --- a/src/Prs3d/Prs3d_PlaneSet.cdl +++ b/src/Prs3d/Prs3d_PlaneSet.cdl @@ -15,6 +15,9 @@ -- commercial license or contractual agreement. class PlaneSet from Prs3d inherits TShared from MMgt + ---Purpose: defines a set of planes used for a presentation + -- by sections. + -- uses diff --git a/src/Prs3d/Prs3d_Presentation.cdl b/src/Prs3d/Prs3d_Presentation.cdl index 4e96d4877e..7f7ec9d6d4 100644 --- a/src/Prs3d/Prs3d_Presentation.cdl +++ b/src/Prs3d/Prs3d_Presentation.cdl @@ -27,6 +27,7 @@ class Presentation from Prs3d inherits Structure from Graphic3d -- This presentation object is used to give display -- attributes defined at this level to -- ApplicationInteractiveServices classes at the level above. + -- A presentation object is attached to a given Viewer. uses Array2OfReal from TColStd, diff --git a/src/Prs3d/Prs3d_ShapeTool.cdl b/src/Prs3d/Prs3d_ShapeTool.cdl index 22df20f20f..b6f4e78303 100644 --- a/src/Prs3d/Prs3d_ShapeTool.cdl +++ b/src/Prs3d/Prs3d_ShapeTool.cdl @@ -15,7 +15,8 @@ -- commercial license or contractual agreement. class ShapeTool from Prs3d - + ---Purpose: describes the behaviour requested for a wireframe + -- shape presentation. uses Shape from TopoDS, @@ -33,7 +34,6 @@ uses IndexedDataMapOfShapeListOfShape from TopTools, IndexedMapOfShape from TopTools - ---Purpose: is Create ( TheShape: Shape from TopoDS) returns ShapeTool from Prs3d; diff --git a/src/QANewModTopOpe/QANewModTopOpe.cdl b/src/QANewModTopOpe/QANewModTopOpe.cdl index e1a6897875..b162cd3e3e 100644 --- a/src/QANewModTopOpe/QANewModTopOpe.cdl +++ b/src/QANewModTopOpe/QANewModTopOpe.cdl @@ -38,16 +38,12 @@ is pointer CommonPtr to Common from BRepAlgoAPI; class Tools; - ---Purpose: to provide several tools for porting to OCC 5.0 (mkk) class Limitation; - ---Purpose: to provide cutting object by face or shell. class Intersection; - ---Purpose: to provide intersection of two topological objects. - + class Glue; --- inherits BooleanOperation from BRepAlgoAPI - ---Purpose: to provide topological sewing of two topological objects. class ReShaper; ---Purpose: to remove "floating" objects from compound. diff --git a/src/QANewModTopOpe/QANewModTopOpe_Glue.cdl b/src/QANewModTopOpe/QANewModTopOpe_Glue.cdl index f564b05190..90d413f6a8 100644 --- a/src/QANewModTopOpe/QANewModTopOpe_Glue.cdl +++ b/src/QANewModTopOpe/QANewModTopOpe_Glue.cdl @@ -15,7 +15,8 @@ class Glue from QANewModTopOpe inherits BooleanOperation from BRepAlgoAPI - ---Purpose: Perform the gluing topological operation. + ---Purpose: Perform the gluing topological operation + -- (topological sewing of two topological objects). uses Boolean from Standard, diff --git a/src/QANewModTopOpe/QANewModTopOpe_Tools.cdl b/src/QANewModTopOpe/QANewModTopOpe_Tools.cdl index d1a2bb5da3..74cfdd401c 100644 --- a/src/QANewModTopOpe/QANewModTopOpe_Tools.cdl +++ b/src/QANewModTopOpe/QANewModTopOpe_Tools.cdl @@ -14,6 +14,8 @@ -- commercial license or contractual agreement. class Tools from QANewModTopOpe + ---Purpose: to provide several tools for porting to OCC 5.0 (mkk) + uses Edge from TopoDS, Shape from TopoDS, diff --git a/src/Quantity/Quantity.cdl b/src/Quantity/Quantity.cdl index 9af448c1e1..73305daa53 100644 --- a/src/Quantity/Quantity.cdl +++ b/src/Quantity/Quantity.cdl @@ -659,23 +659,12 @@ is class Date; - ---Purpose: Gets and sets values of date. - -- This represents a point in time. - -- So it deals with year,month,day,hour,minute,second, - -- millisecond and microsecond. class Period; - ---Purpose: Gets and sets values of Period - -- This allows management of an elapsed time. - - class Color; - ---Purpose: Definition and manipulation of colors. - class Convert; - ---Purpose: Conversion units. class Array1OfCoefficient instantiates diff --git a/src/RWStepBasic/RWStepBasic.cdl b/src/RWStepBasic/RWStepBasic.cdl index 25fc2afc0b..05c7124ae0 100644 --- a/src/RWStepBasic/RWStepBasic.cdl +++ b/src/RWStepBasic/RWStepBasic.cdl @@ -169,6 +169,6 @@ class RWDocumentProductEquivalence; ---Package Method --- -- Init; - ---Purpose: enforced the initialisation of the libraries +-- Enforced the initialisation of the libraries end RWStepBasic; diff --git a/src/RWStepGeom/RWStepGeom.cdl b/src/RWStepGeom/RWStepGeom.cdl index 3c13a4ff22..8376757756 100644 --- a/src/RWStepGeom/RWStepGeom.cdl +++ b/src/RWStepGeom/RWStepGeom.cdl @@ -116,6 +116,6 @@ class RWBezierSurfaceAndRationalBSplineSurface; ---Package Method --- -- Init; - ---Purpose: enforced the initialisation of the libraries +-- Enforced the initialisation of the libraries end RWStepGeom; diff --git a/src/RWStepRepr/RWStepRepr.cdl b/src/RWStepRepr/RWStepRepr.cdl index 1c4766a465..ce050f206d 100644 --- a/src/RWStepRepr/RWStepRepr.cdl +++ b/src/RWStepRepr/RWStepRepr.cdl @@ -96,6 +96,6 @@ class RWMeasureRepresentationItem; class RWReprItemAndLengthMeasureWithUnit; -- Init; - ---Purpose: enforced the initialisation of the libraries +-- Enforced the initialisation of the libraries end RWStepRepr; diff --git a/src/RWStepShape/RWStepShape.cdl b/src/RWStepShape/RWStepShape.cdl index 7ef34228d2..09db5bb559 100644 --- a/src/RWStepShape/RWStepShape.cdl +++ b/src/RWStepShape/RWStepShape.cdl @@ -139,6 +139,6 @@ class RWRevolvedFaceSolid; ---Package Method --- -- Init; - ---Purpose: enforced the initialisation of the libraries +-- Enforced the initialisation of the libraries end RWStepShape; diff --git a/src/RWStepVisual/RWStepVisual.cdl b/src/RWStepVisual/RWStepVisual.cdl index d6a2e29771..e9c3655d7d 100644 --- a/src/RWStepVisual/RWStepVisual.cdl +++ b/src/RWStepVisual/RWStepVisual.cdl @@ -143,6 +143,6 @@ class RWPresentationLayerUsage; ---Package Method --- -- Init; - ---Purpose: enforced the initialisation of the libraries +-- Enforced the initialisation of the libraries end RWStepVisual; diff --git a/src/Resource/Resource.cdl b/src/Resource/Resource.cdl index d796474173..ba7ed34797 100644 --- a/src/Resource/Resource.cdl +++ b/src/Resource/Resource.cdl @@ -58,7 +58,6 @@ is class LexicalCompare ; class Manager; - ---Purpose: Defines a resource structure and its management methods. class Unicode; diff --git a/src/STEPCAFControl/STEPCAFControl.cdl b/src/STEPCAFControl/STEPCAFControl.cdl index 5879e5cdbd..43dcae6d9c 100644 --- a/src/STEPCAFControl/STEPCAFControl.cdl +++ b/src/STEPCAFControl/STEPCAFControl.cdl @@ -42,18 +42,14 @@ uses is class Reader; - ---Purpose: Reader for DECAF documents - + class Writer; - ---Purpose: Writer for DECAF documents class ExternFile; - ---Purpose: Auxiliary class to store results of translation of external file class ActorWrite; class Controller; - ---Purpose: Extensions of standard STEP tools for DECAF specifics - + class DictionaryOfExternFile instantiates Dictionary from Dico (ExternFile from STEPCAFControl); diff --git a/src/STEPConstruct/STEPConstruct.cdl b/src/STEPConstruct/STEPConstruct.cdl index 25998b95ae..9657447f1b 100644 --- a/src/STEPConstruct/STEPConstruct.cdl +++ b/src/STEPConstruct/STEPConstruct.cdl @@ -45,32 +45,23 @@ uses is class Tool; - ---Purpose: Basic class providing general features - + class UnitContext; - ---Purpose: Create and investigate context of units and uncertanties class Part; - ---Purpose: Create and investigate data associated with parts (product etc.) - + class Assembly; - ---Purpose: Create and check assembly data structures - + class Styles; - ---Purpose: Create and investigate STEP constructs for styles (mostly colors) - + class ValidationProps; - ---Purpose: Create and investigate STEP constructs for validation properties - + class ExternRefs; - ---Purpose: Work with references to external documents - + class AP203Context; - ---Purpose: maintains context specific to AP203 - + class ContextTool; - ---Purpose: Maintains global context tool for writing - + --- skl 15.01.2004 class DataMapOfAsciiStringTransient instantiates DataMap from TCollection (AsciiString from TCollection, diff --git a/src/STEPConstruct/STEPConstruct_Assembly.cdl b/src/STEPConstruct/STEPConstruct_Assembly.cdl index a95eef2d81..ce1f37e125 100644 --- a/src/STEPConstruct/STEPConstruct_Assembly.cdl +++ b/src/STEPConstruct/STEPConstruct_Assembly.cdl @@ -16,7 +16,7 @@ class Assembly from STEPConstruct - ---Purpose : This operator creates an item of an assembly, from its + ---Purpose : This operator creates and checks an item of an assembly, from its -- basic data : a ShapeRepresentation, a Location ... -- -- Three ways of coding such item from a ShapeRepresentation : diff --git a/src/STEPConstruct/STEPConstruct_ContextTool.cdl b/src/STEPConstruct/STEPConstruct_ContextTool.cdl index 2c2a0a2367..919589cc2c 100644 --- a/src/STEPConstruct/STEPConstruct_ContextTool.cdl +++ b/src/STEPConstruct/STEPConstruct_ContextTool.cdl @@ -16,7 +16,8 @@ class ContextTool from STEPConstruct - ---Purpose : Gives access to Product Definition Context (one per Model) + ---Purpose : Maintains global context tool for writing. + -- Gives access to Product Definition Context (one per Model) -- Maintains ApplicationProtocolDefinition entity (common for all -- products) -- Also maintains context specific for AP203 and provides set of diff --git a/src/SWDRAW/SWDRAW.cdl b/src/SWDRAW/SWDRAW.cdl index 4f0ed6b418..2ccb569d86 100644 --- a/src/SWDRAW/SWDRAW.cdl +++ b/src/SWDRAW/SWDRAW.cdl @@ -27,29 +27,20 @@ uses TCollection, TColStd, TopoDS, TopTools, Draw, ShapeProcessAPI is class ShapeTool; - ---Purpose: Contains commands to activate Topology/Geometry not - -- Shape Healing class ShapeAnalysis; - ---Purpose: Contains commands to activate package ShapeAnalysis class ShapeCustom; - ---Purpose: Contains commands to activate package ShapeCustom class ShapeExtend; - ---Purpose: Contains commands to activate package ShapeExtend class ShapeFix; - ---Purpose: Contains commands to activate package ShapeFix class ShapeUpgrade; - ---Purpose: Contains commands to activate package ShapeUpgrade class ShapeProcess; - ---Purpose: Contains commands to activate package ShapeProcess - + class ShapeProcessAPI; - ---Purpose: Contains commands to activate package ShapeProcessAPI Init (theCommands: in out Interpretor from Draw); ---Purpose: Loads commands defined in SWDRAW diff --git a/src/SelectBasics/SelectBasics.cdl b/src/SelectBasics/SelectBasics.cdl index e0000ce4a4..2845c0611e 100644 --- a/src/SelectBasics/SelectBasics.cdl +++ b/src/SelectBasics/SelectBasics.cdl @@ -38,14 +38,10 @@ is deferred class EntityOwner; - ---Purpose: entity able to set multiple owners for a SensitiveEntity; class SortAlgo; - ---Purpose: sort algorithm for 2D rectangles. class BasicTool; - ---Purpose: give Tools for sorting Selection results - -- (example : sensitive entities matching) class ListOfBox2d instantiates List from TCollection (Box2d from Bnd); @@ -57,7 +53,6 @@ is deferred class SensitiveEntity; - ---Purpose: general entity able to give sensitive areas class ListOfSensitive instantiates List from TCollection diff --git a/src/SelectBasics/SelectBasics_BasicTool.cdl b/src/SelectBasics/SelectBasics_BasicTool.cdl index fff03546ae..e67525eebb 100644 --- a/src/SelectBasics/SelectBasics_BasicTool.cdl +++ b/src/SelectBasics/SelectBasics_BasicTool.cdl @@ -16,7 +16,8 @@ class BasicTool from SelectBasics - ---Purpose: + ---Purpose: give Tools for sorting Selection results + -- (example : sensitive entities matching) uses Pnt2d from gp, diff --git a/src/SelectBasics/SelectBasics_SortAlgo.cdl b/src/SelectBasics/SelectBasics_SortAlgo.cdl index cb1493d248..a21c176f9a 100644 --- a/src/SelectBasics/SelectBasics_SortAlgo.cdl +++ b/src/SelectBasics/SelectBasics_SortAlgo.cdl @@ -20,6 +20,7 @@ class SortAlgo from SelectBasics ---Purpose: Quickly selection of a rectangle in a set of rectangles + -- Sort algorithm for 2D rectangles. uses Integer from Standard, diff --git a/src/SelectMgr/SelectMgr.cdl b/src/SelectMgr/SelectMgr.cdl index 867c65585c..805bc79b73 100644 --- a/src/SelectMgr/SelectMgr.cdl +++ b/src/SelectMgr/SelectMgr.cdl @@ -195,44 +195,23 @@ is deferred class SelectableObject; deferred class ViewerSelector; - ---Purpose: class selector dedicated to a view ; - -- contains all the sensitive Entities present - -- in a view at selection time - deferred class Filter; deferred class CompositionFilter; class AndFilter; - ---Purpose: AND filter - + class OrFilter; - ---Purpose: OR filter + class EntityOwner; - ---Purpose: Inherits EntityOwner from SelectBasics; - -- knows the selectable object it was made from; - -- - class Selection; - ---Purpose: set of primitives for a mode an an Object; - -- In fact a Selectable Object will have one or many - -- modes of selection or decomposition; - -- A Selection object will contain all the primitives - -- coming from one decomposition. - - class SelectionManager; - ---Purpose: manages all the Operations before selection - - -- i.e. add specific selections for an object in a selectionview - - - ---Category: instantiations of classes from TCollection... @@ -276,7 +255,5 @@ is pointer SOPtr to SelectableObject from SelectMgr; imported CompareResults; - ---Purpose: Redefine CompareOfInteger from TCollection, to be used - -- in method SortResult from class ViewerSelector end SelectMgr; diff --git a/src/SelectMgr/SelectMgr_CompareResults.hxx b/src/SelectMgr/SelectMgr_CompareResults.hxx index a510ff650d..a3b67a8acc 100644 --- a/src/SelectMgr/SelectMgr_CompareResults.hxx +++ b/src/SelectMgr/SelectMgr_CompareResults.hxx @@ -17,6 +17,9 @@ #include #include +// Purpose: Redefine CompareOfInteger from TCollection, to be used +// in method SortResult from class ViewerSelector + class SelectMgr_CompareResults: public TCollection_CompareOfInteger { public: diff --git a/src/ShapeAlgo/ShapeAlgo.cdl b/src/ShapeAlgo/ShapeAlgo.cdl index b28ca99ebf..ea9d56631f 100644 --- a/src/ShapeAlgo/ShapeAlgo.cdl +++ b/src/ShapeAlgo/ShapeAlgo.cdl @@ -33,7 +33,6 @@ uses is class ToolContainer; - ---Purpose: Returns tools used by AlgoContainer class AlgoContainer; ---Purpose: Provides initerface to the algorithms from Shape Healing. diff --git a/src/ShapeAlgo/ShapeAlgo_ToolContainer.cdl b/src/ShapeAlgo/ShapeAlgo_ToolContainer.cdl index 8d507ff533..53894cfcef 100644 --- a/src/ShapeAlgo/ShapeAlgo_ToolContainer.cdl +++ b/src/ShapeAlgo/ShapeAlgo_ToolContainer.cdl @@ -15,7 +15,7 @@ class ToolContainer from ShapeAlgo inherits TShared from MMgt - ---Purpose: + ---Purpose: Returns tools used by AlgoContainer uses diff --git a/src/ShapeAnalysis/ShapeAnalysis.cdl b/src/ShapeAnalysis/ShapeAnalysis.cdl index fe1c9fc03c..3d552d323c 100644 --- a/src/ShapeAnalysis/ShapeAnalysis.cdl +++ b/src/ShapeAnalysis/ShapeAnalysis.cdl @@ -52,74 +52,54 @@ uses is class Geom; - ---Purpose: Basic analysis on geometry - + class Curve; - ---Purpose: Analysis on 2d and 3d curve (projecting points) - + class Surface; - ---Purpose: Analysis on surface (computing singularities) - + class Edge; - ---Purpose: Analysis on edge (geometrical and topological querying, - -- curves consistency, etc.) class Wire; - ---Purpose: Comprehensive alysis of the wire lying on the face or surface - + class WireOrder; - ---Purpose: Analysis of the edges order in the wire - + class WireVertex; - ---Purpose: Analysis of the vertex in context of the wire - + class CheckSmallFace; - ---Purpose: Analysis of the face size - + class Shell; - ---Purpose: Checking orientation in the shell - + class ShapeTolerance; - ---Purpose: Calculating shape tolerances --class OverlapEdges; now it is in package OverlapShape of Products - ---Purpose: Container for keeping information about + --- Container for keeping information about -- overlapping edges --class CheckCoincidenceTool; now it is in package OverlapShape of Products - ---Purpose: Tool for checking coincidence of faces and edges + ---Tool for checking coincidence of faces and edges -- Class intended for analyzing shape contents class ShapeContents; - ---Purpose: Dumps shape contents - - + -- Classes intended for free bounds analysis - class FreeBounds; - ---Purpose: Constructing free bounds of the shape - - class FreeBoundData; - ---Purpose: Data structure for storing free bound - - class FreeBoundsProperties; - ---Purpose: Analysis of properties of free bounds - + class FreeBounds; + + class FreeBoundData; + + class FreeBoundsProperties; + class TransferParameters; - ---Purpose: Transfers parameters between curve 3d of edge and its pcurves - + class TransferParametersProj; - ---Purpose: Transfers parameters between curve 3d of edge and its - -- pcurves. This algorithm uses projection for not - -- sameparameter edges. - - class SequenceOfFreeBounds instantiates - Sequence from TCollection (FreeBoundData from ShapeAnalysis); - - class HSequenceOfFreeBounds instantiates - HSequence from TCollection (FreeBoundData from ShapeAnalysis, - SequenceOfFreeBounds from ShapeAnalysis); + + class SequenceOfFreeBounds instantiates + Sequence from TCollection (FreeBoundData from ShapeAnalysis); + + class HSequenceOfFreeBounds instantiates + HSequence from TCollection (FreeBoundData from ShapeAnalysis, + SequenceOfFreeBounds from ShapeAnalysis); class DataMapOfShapeListOfReal instantiates DataMap from TCollection(Shape from TopoDS, diff --git a/src/ShapeAnalysis/ShapeAnalysis_CheckSmallFace.cdl b/src/ShapeAnalysis/ShapeAnalysis_CheckSmallFace.cdl index fd3ca99f65..0e9dcf4c56 100644 --- a/src/ShapeAnalysis/ShapeAnalysis_CheckSmallFace.cdl +++ b/src/ShapeAnalysis/ShapeAnalysis_CheckSmallFace.cdl @@ -16,7 +16,7 @@ class CheckSmallFace from ShapeAnalysis - ---Purpose: + ---Purpose: Analysis of the face size uses Shape from TopoDS, diff --git a/src/ShapeAnalysis/ShapeAnalysis_ShapeContents.cdl b/src/ShapeAnalysis/ShapeAnalysis_ShapeContents.cdl index db492db3a2..2d67e9a5e3 100644 --- a/src/ShapeAnalysis/ShapeAnalysis_ShapeContents.cdl +++ b/src/ShapeAnalysis/ShapeAnalysis_ShapeContents.cdl @@ -16,7 +16,7 @@ class ShapeContents from ShapeAnalysis - ---Purpose: + ---Purpose: Dumps shape contents uses diff --git a/src/ShapeBuild/ShapeBuild.cdl b/src/ShapeBuild/ShapeBuild.cdl index 739b9f33aa..a7b2c7fd53 100644 --- a/src/ShapeBuild/ShapeBuild.cdl +++ b/src/ShapeBuild/ShapeBuild.cdl @@ -34,11 +34,9 @@ uses is class Vertex; - ---Purpose: Provides low-level functions used for constructing vertices - + class Edge; - ---Purpose: Provides low-level functions used for rebuilding edge - + class ReShape; ---Purpose: Rebuilds a shape with substitution of some components diff --git a/src/ShapeConstruct/ShapeConstruct.cdl b/src/ShapeConstruct/ShapeConstruct.cdl index 2239ab69fd..f74cff976a 100644 --- a/src/ShapeConstruct/ShapeConstruct.cdl +++ b/src/ShapeConstruct/ShapeConstruct.cdl @@ -42,20 +42,15 @@ uses is class Curve; - ---Purpose: Tool for adjusting 3d and 2d curve class ProjectCurveOnSurface; - ---Purpose: Tool for computing pcurve by projecting 3d curve on a surface + ---WARNING: The following two classes are just a copy of those from GEOMLITE -- They must be removed as soon as bug in them is fixed class CompBezierCurvesToBSplineCurve; - ---Purpose: Converts a list of connecting BezierCurves - -- into a B-spline curve. class CompBezierCurves2dToBSplineCurve2d; - ---Purpose: Converts a list of connecting BezierCurves - -- into a B-spline curve. class MakeTriangulation; ---Purpose: Tool for wire triangulation diff --git a/src/ShapeExtend/ShapeExtend.cdl b/src/ShapeExtend/ShapeExtend.cdl index e033a7283a..09329cb237 100644 --- a/src/ShapeExtend/ShapeExtend.cdl +++ b/src/ShapeExtend/ShapeExtend.cdl @@ -98,20 +98,15 @@ is deferred class ComplexCurve; class CompositeSurface; - ---Purpose: Defines surface composed of grid of connected patches class WireData; - ---Purpose: Defines data structure for work on a wire as a list of edges - + class BasicMsgRegistrator; - ---Purpose: Abstract class to send messages to the objects - + class MsgRegistrator; - ---Purpose: Collects messages to be attached messages to the objects - + class Explorer; - ---Purpose: Exploring of shapes (compounds) - + class DataMapOfShapeListOfMsg instantiates DataMap from TCollection (Shape from TopoDS, ListOfMsg from Message, diff --git a/src/ShapeFix/ShapeFix.cdl b/src/ShapeFix/ShapeFix.cdl index 87e9f83ddd..fa75eb1e5a 100644 --- a/src/ShapeFix/ShapeFix.cdl +++ b/src/ShapeFix/ShapeFix.cdl @@ -53,62 +53,41 @@ is class EdgeProjAux; class Edge; - ---Purpose: Fixing different problems on edge - + class Wire; - ---Purpose: Fixing different problems with wires class Face; - ---Purpose: Fixing problems with face (orientation of wires and wrong wires) - + class FixSmallFace; - ---Purpose: Fixing face with small size class WireVertex; - ---Purpose: Fixing disconnected edges in the wire class Wireframe; - ---Purpose: Provides methods to fix wireframe of shape - + class FreeBounds; - ---Purpose: Fixing free bounds of the shape (connecting open wires) class FaceConnect; - ---Purpose: Rebuilds connectivity between faces in shell - + class Shell; - ---Purpose: Fixing orientation of faces in shell class Solid; - ---Purpose: Creating solid from shell and orienting it to have finite volume - + class ShapeTolerance; - ---Purpose: Modifying shape tolerances class Shape; - ---Purpose: Fixing problem of shape. class EdgeConnect; - ---Purpose: Rebuilds edges to connect with new vertices, was moved from ShapeBuild class ComposeShell; - ---Purpose: Splits a (pseudo)face onto grid of faces (shell) class SplitCommonVertex; - ---Purpose: Splits vertex which is common for two wires - -- (for writing into STEP) class WireSegment; - ---Purpose: Auxiliary class (data storage) for ComposeShell - + class IntersectionTool; - ---Purpose: Tool for fixing selfintersecting wire - -- and intersecting wires - + class SplitTool; - ---Purpose: Tool for splitting and cutting edges; incudes methods - -- used in OverlappingTool and IntersectionTool - + class SequenceOfWireSegment instantiates Sequence from TCollection (WireSegment from ShapeFix); diff --git a/src/ShapeFix/ShapeFix_EdgeConnect.cdl b/src/ShapeFix/ShapeFix_EdgeConnect.cdl index 7ebc4cb1fe..d05de8d672 100644 --- a/src/ShapeFix/ShapeFix_EdgeConnect.cdl +++ b/src/ShapeFix/ShapeFix_EdgeConnect.cdl @@ -16,7 +16,8 @@ class EdgeConnect from ShapeFix - ---Purpose : Makes vertices to be shared to connect edges, + ---Purpose : Rebuilds edges to connect with new vertices, was moved from ShapeBuild. + -- Makes vertices to be shared to connect edges, -- updates positions and tolerances for shared vertices. -- Accepts edges bounded by two vertices each. diff --git a/src/ShapeFix/ShapeFix_FaceConnect.cdl b/src/ShapeFix/ShapeFix_FaceConnect.cdl index dd5ad8ea65..fc28a1fca7 100644 --- a/src/ShapeFix/ShapeFix_FaceConnect.cdl +++ b/src/ShapeFix/ShapeFix_FaceConnect.cdl @@ -16,7 +16,7 @@ class FaceConnect from ShapeFix - ---Purpose : + ---Purpose : Rebuilds connectivity between faces in shell uses DataMapOfShapeListOfShape from TopTools, diff --git a/src/ShapeFix/ShapeFix_FixSmallFace.cdl b/src/ShapeFix/ShapeFix_FixSmallFace.cdl index fd3377735d..5c2246b585 100644 --- a/src/ShapeFix/ShapeFix_FixSmallFace.cdl +++ b/src/ShapeFix/ShapeFix_FixSmallFace.cdl @@ -16,7 +16,7 @@ class FixSmallFace from ShapeFix inherits Root from ShapeFix - ---Purpose: + ---Purpose: Fixing face with small size uses Shape from TopoDS, diff --git a/src/ShapeFix/ShapeFix_WireSegment.cdl b/src/ShapeFix/ShapeFix_WireSegment.cdl index 4e6ce0e036..bce4979c2c 100644 --- a/src/ShapeFix/ShapeFix_WireSegment.cdl +++ b/src/ShapeFix/ShapeFix_WireSegment.cdl @@ -16,7 +16,7 @@ class WireSegment from ShapeFix - ---Purpose: This class is auxiliary class used in ComposeShell. + ---Purpose: This class is auxiliary class (data storage) used in ComposeShell. -- It is intended for representing segment of the wire -- (or whole wire). The segment itself is represented by -- ShapeExtend_WireData. In addition, some associated data diff --git a/src/ShapeFix/ShapeFix_WireVertex.cdl b/src/ShapeFix/ShapeFix_WireVertex.cdl index 92f8dfc6bb..bbe1acbb3f 100644 --- a/src/ShapeFix/ShapeFix_WireVertex.cdl +++ b/src/ShapeFix/ShapeFix_WireVertex.cdl @@ -16,7 +16,8 @@ class WireVertex from ShapeFix - ---Purpose: Fixes vertices in the wire on the basis of pre-analysis + ---Purpose: Fixing disconnected edges in the wire + -- Fixes vertices in the wire on the basis of pre-analysis -- made by ShapeAnalysis_WireVertex (given as argument). -- The Wire has formerly been loaded in a ShapeExtend_WireData. diff --git a/src/ShapeProcess/ShapeProcess.cdl b/src/ShapeProcess/ShapeProcess.cdl index 8e39904c84..d279951f7b 100644 --- a/src/ShapeProcess/ShapeProcess.cdl +++ b/src/ShapeProcess/ShapeProcess.cdl @@ -40,18 +40,15 @@ uses is class Context; - ---Purpose: Provides general context for processing (resource file) + class ShapeContext; - ---Purpose: Extends context to support processing of the shape deferred class Operator; - ---Purpose: Defines interface to Operator which do the job + primitive OperFunc; class UOperator; - ---Purpose: Customizable operator-container loaded by OperFunc class OperLibrary; - ---Purpose: Provides standard set of operators class DictionaryOfOperator instantiates Dictionary from Dico (Operator from ShapeProcess); diff --git a/src/ShapeProcessAPI/ShapeProcessAPI.cdl b/src/ShapeProcessAPI/ShapeProcessAPI.cdl index 4127cf3df6..7e0281190a 100644 --- a/src/ShapeProcessAPI/ShapeProcessAPI.cdl +++ b/src/ShapeProcessAPI/ShapeProcessAPI.cdl @@ -31,6 +31,5 @@ uses is class ApplySequence; - ---Purpose: Applies one of the sequence of calls from resource file. - + end ShapeProcessAPI; diff --git a/src/ShapeUpgrade/ShapeUpgrade.cdl b/src/ShapeUpgrade/ShapeUpgrade.cdl index f5c5f2db1c..9684e4db3a 100644 --- a/src/ShapeUpgrade/ShapeUpgrade.cdl +++ b/src/ShapeUpgrade/ShapeUpgrade.cdl @@ -68,14 +68,11 @@ is class ShapeDivideArea; class ShapeDivideContinuity; - ---Purpose: API Tool for converting shapes with C0 geometry into C1 ones - + class ShapeDivideAngle; - ---Purpose: API Class for splitting revolutions to segments less than 90 class ShapeConvertToBezier; - ---Purpose: API Class for convering curves to beziers. - + class ShapeDivideClosed; ---Purpose: @@ -97,18 +94,16 @@ is class SplitSurfaceArea; class ShellSewing; - ---Purpose: Provides access to a sewing algorithms from BRepOffsetAPI + class FixSmallCurves; ---Purpose: class FixSmallBezierCurves; ---Purpose: class RemoveLocations; - ---Purpose: Removes all locations sub-shapes of specified shape - + class RemoveInternalWires; - ---Purpose: Removes all internal wires having area less than specified min area - + class UnifySameDomain; ---Purpose: Unifies same domain faces and edges of specified shape diff --git a/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideAngle.cdl b/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideAngle.cdl index 3503a574e4..1b7b8d0aac 100644 --- a/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideAngle.cdl +++ b/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideAngle.cdl @@ -19,7 +19,7 @@ class ShapeDivideAngle from ShapeUpgrade inherits ShapeDivide from ShapeUpgrade ---Purpose: Splits all surfaces of revolution, cylindrical, toroidal, -- conical, spherical surfaces in the given shape so that -- each resulting segment covers not more than defined number - -- of degrees. + -- of degrees (to segments less than 90). uses diff --git a/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideContinuity.cdl b/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideContinuity.cdl index 267fa827fb..d6f6be5d39 100644 --- a/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideContinuity.cdl +++ b/src/ShapeUpgrade/ShapeUpgrade_ShapeDivideContinuity.cdl @@ -16,7 +16,7 @@ class ShapeDivideContinuity from ShapeUpgrade inherits ShapeDivide from ShapeUpgrade - ---Purpose: + ---Purpose: API Tool for converting shapes with C0 geometry into C1 ones uses diff --git a/src/SortTools/SortTools.cdl b/src/SortTools/SortTools.cdl index 1a71a290fa..a4fe88df28 100644 --- a/src/SortTools/SortTools.cdl +++ b/src/SortTools/SortTools.cdl @@ -28,16 +28,12 @@ uses TCollection, is generic class HeapSort; - ---Purpose: Sort an array using the heap sort algorithm. generic class QuickSort; - ---Purpose: Sort an array using the quick sort algorithm. generic class ShellSort; - ---Purpose: Sort an array using the shell sort algorithm. generic class StraightInsertionSort; - ---Purpose: Sort an array using the straight insertion sort algorithm. -- The table below summarizes the most important characteristics that diff --git a/src/StdPrs/StdPrs.cdl b/src/StdPrs/StdPrs.cdl index de78cb0edf..dcbde7117b 100644 --- a/src/StdPrs/StdPrs.cdl +++ b/src/StdPrs/StdPrs.cdl @@ -57,88 +57,46 @@ is class ShadedShape; class PoleCurve; - ---Purpose: computes the presentation of curves by drawing - -- a broken line linking the poles of the curve. class Plane; - ---Purpose: computes the presentation of a infinite plane. class WFPoleSurface; - ---Purpose: computes the presentation of surfaces by drawing a - -- double network of lines linking the poles of the surface - -- in the two parametric direction. - class DeflectionCurve; - ---Purpose: computes the presentation of objects to be - -- seen as curves. The computation will be made - -- according to a maximal chordial deviation. - + ---Category: Wireframe algorithms class WFDeflectionSurface; - ---Purpose: computes the wireframe presentation of surfaces - -- by displaying a given number of U and/or V isoparametric - --- curves. The isoparametric curves are drawn with respect - -- to a given maximal chordial deviation. class ShadedSurface; - ---Purpose: computes the shading presentation of surfaces. ----------------------------------------------- --- deflection drawing classes : ----------------------------------------------- class WFDeflectionRestrictedFace; - ---Purpose: computes the wireframe presentation of faces with - -- restrictions by displaying a given number of U and/or - -- V isoparametric curves. The isoparametric curves are - -- drawn with respect to a maximal chordial deviation. - -- The presentation includes the restriction curves. - - class Curve; - ---Purpose: computes the presentation of objects to be - -- seen as curves. The computation will be made - -- whith a constant number of points. + class Curve; class WFSurface; - ---Purpose: computes the wireframe presentation of surfaces - -- by displaying a given number of U and/or V isoparametric - --- curves. The isoparametric curves are drawn with respect - -- to a given number of points. - - + ---Category: Hidden lines removal algorithms. class HLRPolyShape; - ---Purpose: computes the presentation of objects with - -- removal of their hidden lines for a specific - -- projector. The polygonal algorithm is used. - + imported HLRShape; - ---Purpose: computes the presentation of objects with - -- removal of their hidden lines for a specific - -- projector. The exact algorithm is used. - + imported NListOfSequenceOfPnt from Prs3d; imported NListIteratorOfListOfSequenceOfPnt from Prs3d; imported WFShape; imported WFDeflectionShape; - ---Purpose: computes the wireframe presentation of surfaces - -- by displaying planar sections. + imported Vertex; imported Point; - ---Purpose: computes the presentation of objects to be - -- seen as points. + imported WFRestrictedFace; - ---Purpose: Computes the wireframe presentation of faces with - -- restrictions by displaying a given number of U and/or - -- V isoparametric curves. The isoparametric curves are - -- drawn with a fixed number of points. - -- The presentation includes the restriction curves. - + end StdPrs; diff --git a/src/StdPrs/StdPrs_HLRPolyShape.cdl b/src/StdPrs/StdPrs_HLRPolyShape.cdl index c3dcbbc34a..12b3cef71e 100644 --- a/src/StdPrs/StdPrs_HLRPolyShape.cdl +++ b/src/StdPrs/StdPrs_HLRPolyShape.cdl @@ -27,6 +27,7 @@ inherits Root from Prs3d -- obtain an exact result, whereas, when you use -- StdPrs_HLRPolyShape, you reduce computation -- time but obtain polygonal segments. + -- The polygonal algorithm is used. uses Shape from TopoDS, Presentation from Prs3d, diff --git a/src/StdPrs/StdPrs_HLRShape.hxx b/src/StdPrs/StdPrs_HLRShape.hxx index 7b2d002034..7283538403 100755 --- a/src/StdPrs/StdPrs_HLRShape.hxx +++ b/src/StdPrs/StdPrs_HLRShape.hxx @@ -19,6 +19,10 @@ #include #include +// Computes the presentation of objects with +// removal of their hidden lines for a specific +// projector. The exact algorithm is used. + class StdPrs_HLRShape: public Prs3d_Root { public: diff --git a/src/StdPrs/StdPrs_Point.hxx b/src/StdPrs/StdPrs_Point.hxx index d10800eca6..37de4bb4eb 100755 --- a/src/StdPrs/StdPrs_Point.hxx +++ b/src/StdPrs/StdPrs_Point.hxx @@ -19,6 +19,6 @@ #include #include #include - +//computes the presentation of objects to be seen as points. typedef Prs3d_Point StdPrs_Point; #endif diff --git a/src/StdPrs/StdPrs_PoleCurve.cdl b/src/StdPrs/StdPrs_PoleCurve.cdl index 6565c0f47d..de13d3e721 100644 --- a/src/StdPrs/StdPrs_PoleCurve.cdl +++ b/src/StdPrs/StdPrs_PoleCurve.cdl @@ -17,9 +17,9 @@ class PoleCurve from StdPrs inherits Root from Prs3d - - - ---Purpose: A framework to provide display of Bezier or BSpline curves. + + ---Purpose: A framework to provide display of Bezier or BSpline curves + -- (by drawing a broken line linking the poles of the curve). uses Curve from Adaptor3d, diff --git a/src/StdPrs/StdPrs_ShadedSurface.cdl b/src/StdPrs/StdPrs_ShadedSurface.cdl index 9ebaad1e5d..9a91fe60ac 100644 --- a/src/StdPrs/StdPrs_ShadedSurface.cdl +++ b/src/StdPrs/StdPrs_ShadedSurface.cdl @@ -17,10 +17,11 @@ class ShadedSurface from StdPrs inherits Root from Prs3d - --- Purpose: Draws a surface by drawing the isoparametric curves with respect to - -- a maximal chordial deviation. - -- The number of isoparametric curves to be drawn and their color are - -- controlled by the furnished Drawer. + --- Purpose: Computes the shading presentation of surfaces. + -- Draws a surface by drawing the isoparametric curves with respect to + -- a maximal chordial deviation. + -- The number of isoparametric curves to be drawn and their color are + -- controlled by the furnished Drawer. uses Surface from Adaptor3d, Presentation from Prs3d, diff --git a/src/StdPrs/StdPrs_WFDeflectionRestrictedFace.cdl b/src/StdPrs/StdPrs_WFDeflectionRestrictedFace.cdl index 8860cdc102..303264a15f 100644 --- a/src/StdPrs/StdPrs_WFDeflectionRestrictedFace.cdl +++ b/src/StdPrs/StdPrs_WFDeflectionRestrictedFace.cdl @@ -22,6 +22,11 @@ inherits Root from Prs3d ---Purpose: A framework to provide display of U and V -- isoparameters of faces, while allowing you to impose -- a deflection on them. + -- Computes the wireframe presentation of faces with + -- restrictions by displaying a given number of U and/or + -- V isoparametric curves. The isoparametric curves are + -- drawn with respect to a maximal chordial deviation. + -- The presentation includes the restriction curves. uses HSurface from BRepAdaptor, diff --git a/src/StdPrs/StdPrs_WFDeflectionShape.hxx b/src/StdPrs/StdPrs_WFDeflectionShape.hxx index def659d438..333d2e1ae2 100755 --- a/src/StdPrs/StdPrs_WFDeflectionShape.hxx +++ b/src/StdPrs/StdPrs_WFDeflectionShape.hxx @@ -24,6 +24,9 @@ #include #include +// Computes the wireframe presentation of surfaces +// by displaying planar sections. + class StdPrs_WFDeflectionShape : public Prs3d_Root { diff --git a/src/StdPrs/StdPrs_WFPoleSurface.cdl b/src/StdPrs/StdPrs_WFPoleSurface.cdl index 568dc4bdd5..25d042408b 100644 --- a/src/StdPrs/StdPrs_WFPoleSurface.cdl +++ b/src/StdPrs/StdPrs_WFPoleSurface.cdl @@ -17,8 +17,11 @@ class WFPoleSurface from StdPrs inherits Root from Prs3d - --- Purpose: The number of lines to be drawn is controlled - -- by the NetworkNumber of the given Drawer. + --- Purpose: Computes the presentation of surfaces by drawing a + -- double network of lines linking the poles of the surface + -- in the two parametric direction. + -- The number of lines to be drawn is controlled + -- by the NetworkNumber of the given Drawer. uses Surface from Adaptor3d, Presentation from Prs3d, diff --git a/src/StdPrs/StdPrs_WFRestrictedFace.hxx b/src/StdPrs/StdPrs_WFRestrictedFace.hxx index 8ea6045bf2..e763636766 100755 --- a/src/StdPrs/StdPrs_WFRestrictedFace.hxx +++ b/src/StdPrs/StdPrs_WFRestrictedFace.hxx @@ -20,6 +20,12 @@ #include #include +// Computes the wireframe presentation of faces with +// restrictions by displaying a given number of U and/or +// V isoparametric curves. The isoparametric curves are +// drawn with a fixed number of points. +// The presentation includes the restriction curves. + class StdPrs_WFRestrictedFace : public Prs3d_Root { public: diff --git a/src/StdPrs/StdPrs_WFSurface.cdl b/src/StdPrs/StdPrs_WFSurface.cdl index 0711806a05..3d9858dc54 100644 --- a/src/StdPrs/StdPrs_WFSurface.cdl +++ b/src/StdPrs/StdPrs_WFSurface.cdl @@ -15,6 +15,10 @@ -- commercial license or contractual agreement. class WFSurface from StdPrs + ---Purpose: Computes the wireframe presentation of surfaces + -- by displaying a given number of U and/or V isoparametric + --- curves. The isoparametric curves are drawn with respect + -- to a given number of points. inherits Root from Prs3d diff --git a/src/StdSelect/StdSelect.cdl b/src/StdSelect/StdSelect.cdl index 151213a3b9..f9b5313b46 100644 --- a/src/StdSelect/StdSelect.cdl +++ b/src/StdSelect/StdSelect.cdl @@ -91,20 +91,11 @@ is class ViewerSelector3d; - ---Purpose: Viewer Selector for a view from V3d - -- Accepts Only Sensitive Entities inheriting Select3D entities... - - - + class BRepSelectionTool; - ---Purpose: gives standard selections for Shapes class BRepOwner; - ---Purpose: Owner classes for BRep objects - -- used by BRepSelectionTool to know which entities - -- own the sensitive primitives created. - -- the hilight-unhilight methods are empty and - -- must be redefined by each User... + ---Category: Shape Filters diff --git a/src/StdSelect/StdSelect_BRepOwner.cdl b/src/StdSelect/StdSelect_BRepOwner.cdl index 63241b1982..7ea2e9e7cd 100644 --- a/src/StdSelect/StdSelect_BRepOwner.cdl +++ b/src/StdSelect/StdSelect_BRepOwner.cdl @@ -21,6 +21,8 @@ class BRepOwner from StdSelect inherits EntityOwner from SelectMgr -- Used in Dynamic Selection Mechanism. -- A BRepOwner has an Owner (the shape it represents) -- and Users (One or More Transient entities). + -- The highlight-unhighlight methods are empty and + -- must be redefined by each User. uses Location from TopLoc, diff --git a/src/StdSelect/StdSelect_ViewerSelector3d.cdl b/src/StdSelect/StdSelect_ViewerSelector3d.cdl index b519d631db..7c45d5a4d8 100644 --- a/src/StdSelect/StdSelect_ViewerSelector3d.cdl +++ b/src/StdSelect/StdSelect_ViewerSelector3d.cdl @@ -19,6 +19,7 @@ class ViewerSelector3d from StdSelect inherits ViewerSelector from SelectMgr ---Purpose: Selector Usable by Viewers from V3d + -- Accepts Only Sensitive Entities inheriting Select3D entities... uses View from V3d, diff --git a/src/StepAP209/StepAP209.cdl b/src/StepAP209/StepAP209.cdl index f6350f71a4..b8486079d2 100644 --- a/src/StepAP209/StepAP209.cdl +++ b/src/StepAP209/StepAP209.cdl @@ -33,6 +33,5 @@ is class Construct; - ---Purpose: Basic tool for working with AP209 model - + end StepAP209; diff --git a/src/StepBasic/StepBasic.cdl b/src/StepBasic/StepBasic.cdl index 3bf00a11ca..69c4cab593 100644 --- a/src/StepBasic/StepBasic.cdl +++ b/src/StepBasic/StepBasic.cdl @@ -314,7 +314,6 @@ class Array1OfDocument instantiates Array1 from TCollection (Document); class HArray1OfDocument instantiates HArray1 from TCollection (Document,Array1OfDocument from StepBasic); -- Protocol returns Protocol from StepBasic; - ---Purpose : creates a Protocol end StepBasic; diff --git a/src/StepGeom/StepGeom.cdl b/src/StepGeom/StepGeom.cdl index 933dd86da6..9676a5ab21 100644 --- a/src/StepGeom/StepGeom.cdl +++ b/src/StepGeom/StepGeom.cdl @@ -239,7 +239,6 @@ class Array1OfTrimmingSelect instantiates Array1 from TCollection (TrimmingSelec class HArray1OfTrimmingSelect instantiates HArray1 from TCollection (TrimmingSelect,Array1OfTrimmingSelect from StepGeom); -- Protocol returns Protocol from StepGeom; - ---Purpose : creates a Protocol end StepGeom; diff --git a/src/StepRepr/StepRepr.cdl b/src/StepRepr/StepRepr.cdl index 57c8a538df..9f0270c7dd 100644 --- a/src/StepRepr/StepRepr.cdl +++ b/src/StepRepr/StepRepr.cdl @@ -143,7 +143,6 @@ is -- Protocol returns Protocol from StepRepr; - ---Purpose : creates a Protocol end StepRepr; diff --git a/src/StepShape/StepShape.cdl b/src/StepShape/StepShape.cdl index 7301524b8b..de6c9dae0e 100644 --- a/src/StepShape/StepShape.cdl +++ b/src/StepShape/StepShape.cdl @@ -249,7 +249,6 @@ class HArray1OfShell instantiates HArray1 from TCollection (Shell,Array1OfShell class PointRepresentation; -- Protocol returns Protocol from StepShape; - ---Purpose : creates a Protocol end StepShape; diff --git a/src/StepVisual/StepVisual.cdl b/src/StepVisual/StepVisual.cdl index 45e5af4024..8ca7878fe5 100644 --- a/src/StepVisual/StepVisual.cdl +++ b/src/StepVisual/StepVisual.cdl @@ -356,7 +356,6 @@ class HArray1OfBoxCharacteristicSelect Array1OfBoxCharacteristicSelect); -- Protocol returns Protocol from StepVisual; - ---Purpose : creates a Protocol end StepVisual; diff --git a/src/StlMesh/StlMesh.cdl b/src/StlMesh/StlMesh.cdl index 8528a2a921..15092a8f73 100644 --- a/src/StlMesh/StlMesh.cdl +++ b/src/StlMesh/StlMesh.cdl @@ -31,28 +31,12 @@ uses is class Mesh; - ---Purpose: Mesh definition. The mesh contains one or several - -- domains. Each mesh domain contains a set of - -- triangles. Each domain can have its own deflection - -- value. - class MeshExplorer; - ---Purpose: Provides facilities to explore the triangles of - -- each mesh domain. - class MeshDomain; - ---Purpose: Set of triangles defined with three vertices and a - -- given orientation. Internal class used to classify - -- the triangles of each domain. - class MeshTriangle; - ---Purpose: triangle defined with three vertices and a given - -- orientation - - class SequenceOfMeshDomain instantiates Sequence from TCollection (MeshDomain from StlMesh); diff --git a/src/StlMesh/StlMesh_MeshDomain.cdl b/src/StlMesh/StlMesh_MeshDomain.cdl index b7c802c066..248669d370 100644 --- a/src/StlMesh/StlMesh_MeshDomain.cdl +++ b/src/StlMesh/StlMesh_MeshDomain.cdl @@ -17,9 +17,9 @@ class MeshDomain from StlMesh inherits TShared from MMgt ---Purpose: A mesh domain is a set of triangles defined with - -- three geometric vertices. The mesh domain has its - -- own deflection. - -- + -- three geometric vertices and a given orientation. + -- The mesh domain has its own deflection. + -- Internal class used to classify the triangles of each domain. uses SequenceOfXYZ from TColgp, SequenceOfMeshTriangle from StlMesh diff --git a/src/Storage/Storage.cdl b/src/Storage/Storage.cdl index 13e405bf16..cdb172530b 100644 --- a/src/Storage/Storage.cdl +++ b/src/Storage/Storage.cdl @@ -116,7 +116,6 @@ is imported Position; -- typedef long deferred class BaseDriver; - ---Purpose: base class for storage drivers deferred class CallBack; class DefaultCallBack; diff --git a/src/Sweep/Sweep.cdl b/src/Sweep/Sweep.cdl index 11d91e24f3..46527e0e12 100644 --- a/src/Sweep/Sweep.cdl +++ b/src/Sweep/Sweep.cdl @@ -35,14 +35,11 @@ is -- class NumShape; - ---Purpose: A shape represented by an index. - + class NumShapeTool; - ---Purpose: Tool for NumShapes. - + class NumShapeIterator; - ---Purpose: Iterator for NumShapes. - + end Sweep; diff --git a/src/TCollection/TCollection.cdl b/src/TCollection/TCollection.cdl index 16e214168a..cfb3b975dd 100644 --- a/src/TCollection/TCollection.cdl +++ b/src/TCollection/TCollection.cdl @@ -51,51 +51,35 @@ is generic class HArray2; generic class List, ListNode, ListIterator; - ---Purpose: A single list handled by value. class BaseSequence; class SeqNode; pointer SeqNodePtr to SeqNode from TCollection; generic class Sequence,SequenceNode; - ---Purpose: An indexed double list handled by value. - + generic class HSequence; - ---Purpose: An indexed double list handle by reference. generic class MapHasher; - ---Purpose: A Tool to instantiate Maps. Providing HashCode and - -- Comparisons on Keys. - + private deferred class BasicMap; private class MapNode; pointer MapNodePtr to MapNode from TCollection; - ---Purpose: Basic class root of all the Maps. - + private deferred class BasicMapIterator; - ---Purpose: Basic class root of all the Iterators on Maps. - + generic class Map, MapIterator,StdMapNode; - ---Purpose: A Hashed map to store keys. generic class DataMap, DataMapIterator,DataMapNode; - ---Purpose: A Map where data can be stored with the keys. - + generic class DoubleMap, DoubleMapIterator, DoubleMapNode; - ---Purpose: A Map to store pair of keys. - + generic class IndexedMap,IndexedMapNode; - ---Purpose: A Map where the keys are indexed. - + generic class IndexedDataMap,IndexedDataMapNode; - ---Purpose: An Indexed Map where data can be stored with the keys. enumeration Side is Left , Right; deferred generic class Compare ; - ---Purpose: Defines a comparison operator which can be used by - -- any ordered structure. The way to compare items - -- has to be described in subclasses, which herit - -- from instantiations of Compare. private deferred class PrivCompareOfInteger instantiates Compare from TCollection(Integer from Standard); diff --git a/src/TCollection/TCollection_MapNode.cdl b/src/TCollection/TCollection_MapNode.cdl index ea4a28e43d..d2c579aef7 100644 --- a/src/TCollection/TCollection_MapNode.cdl +++ b/src/TCollection/TCollection_MapNode.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. private class MapNode from TCollection + ---Purpose: Basic class root of all the Maps. inherits TShared from MMgt uses MapNodePtr from TCollection is diff --git a/src/TDF/TDF.cdl b/src/TDF/TDF.cdl index f650811934..c9666e4258 100644 --- a/src/TDF/TDF.cdl +++ b/src/TDF/TDF.cdl @@ -51,10 +51,8 @@ is -- ============================================================== class Data; - ---Purpose: The root class of this structure. class Label; - ---Purpose: A label is a feature in the structure. imported HAllocator; imported LabelNode; @@ -62,109 +60,71 @@ is pointer LabelNodePtr to LabelNode from TDF; deferred class Attribute; - ---Purpose: A class each application has to implement. It is - -- used to contain the application data. class TagSource; - ---Purpose: this attribute may be used for automatic delivery of - -- labels under a given label. class Reference; - ---Purpose: this attribute is used to store in the framework a - -- reference to an other label. + ---Category: DF Copy algorithms -- ============================================================== class ClosureMode; - ---Purpose: This class provides options closure management. - + class ClosureTool; - ---Purpose: This class gives services around the transitive - -- enclosure of a set of information, starting from a - -- list of label. class CopyTool; - ---Purpose: This class gives services around copy/paste actions. - + class CopyLabel; - ---Purpose: This class gives copy of source label hierarchy - + class ComparisonTool; - ---Purpose: This class gives services around the comparison - -- between two sets of information. ---Category: DF Transaction & Delta -- ============================================================== class Transaction; - ---Purpose: This class offers services to open, commit or - -- abort a transaction in a more secure way than - -- using Data from TDF. class Delta; - ---Purpose: A set of AttributeDelta for a given transaction - -- number and reference time number. deferred class AttributeDelta; - ---Purpose: Delta for a given attribute. class DeltaOnAddition; - ---Purpose: Attribute delta on ADDITION action. class DeltaOnForget; - ---Purpose: Attribute delta on FORGET action. class DeltaOnResume; - ---Purpose: Attribute delta on RESUME action. deferred class DeltaOnRemoval; - ---Purpose: Attribute delta on REMOVAL action. deferred class DeltaOnModification; - ---Purpose: Attribute delta on MODIFICATION action. class DefaultDeltaOnRemoval; - ---Purpose: Default implementation of TDF_DeltaOnRemoval. class DefaultDeltaOnModification; - ---Purpose: Default implementation of TDF_DeltaOnModification. ---Category: DF Basic Tools -- ============================================================== class ChildIterator; - ---Purpose: A tool to iterate on the children of a label. class ChildIDIterator; - ---Purpose: A tool to iterate on the children of a label to - -- find attributes with an ID. imported AttributeIterator; - ---Purpose: DO NOT USE THIS CLASS WITHOUT AUTHORIZATION! - ---Category: DF Specific Tools -- ============================================================== class DataSet; - ---Purpose: This class is used to build a set of DF - -- informations like labels or attributes. class RelocationTable; - ---Purpose: Builds a attribute relocation dictionnary useful - -- for copy or paste actions. class Tool; - ---Purpose: This class provides general services. class LabelMapHasher; - ---Purpose: A label hasher for label maps. class IDFilter; - ---Purpose: This class offers filtering services around an ID list. ---Category: DF Classes Instantiations diff --git a/src/TDF/TDF_Attribute.cdl b/src/TDF/TDF_Attribute.cdl index f9c9f54369..19a5edbc7f 100644 --- a/src/TDF/TDF_Attribute.cdl +++ b/src/TDF/TDF_Attribute.cdl @@ -23,7 +23,9 @@ deferred class Attribute from TDF inherits TShared from MMgt - ---Purpose: This abstract class, alongwith Label, + ---Purpose: A class each application has to implement. It is + -- used to contain the application data. + -- This abstract class, alongwith Label, -- is one of the cornerstones of Model Editor. -- The groundwork is to define the root of -- information. This information is to be diff --git a/src/TDF/TDF_AttributeIterator.hxx b/src/TDF/TDF_AttributeIterator.hxx index 9ba62e353d..4688545152 100644 --- a/src/TDF/TDF_AttributeIterator.hxx +++ b/src/TDF/TDF_AttributeIterator.hxx @@ -26,6 +26,8 @@ #include #include +// DO NOT USE THIS CLASS WITHOUT AUTHORIZATION! +// // This class provides a way to iterates on the // up-to-date (current) valid attributes of a label. // diff --git a/src/TDF/TDF_ClosureTool.cdl b/src/TDF/TDF_ClosureTool.cdl index 3d79d0fc1f..b55422f4bb 100644 --- a/src/TDF/TDF_ClosureTool.cdl +++ b/src/TDF/TDF_ClosureTool.cdl @@ -23,7 +23,9 @@ class ClosureTool from TDF ---Purpose: This class provides services to build the closure -- of an information set. - -- + -- This class gives services around the transitive + -- enclosure of a set of information, starting from a + -- list of label. -- You can set closure options by using IDFilter -- (to select or exclude specific attribute IDs) and -- CopyOption objects and by giving to Closure diff --git a/src/TDF/TDF_CopyLabel.cdl b/src/TDF/TDF_CopyLabel.cdl index 63fbc0a86d..5c63061d18 100644 --- a/src/TDF/TDF_CopyLabel.cdl +++ b/src/TDF/TDF_CopyLabel.cdl @@ -16,7 +16,7 @@ class CopyLabel from TDF - ---Purpose: + ---Purpose: This class gives copy of source label hierarchy uses diff --git a/src/TDF/TDF_Delta.cdl b/src/TDF/TDF_Delta.cdl index 38fb3b41e3..5a6d464f34 100644 --- a/src/TDF/TDF_Delta.cdl +++ b/src/TDF/TDF_Delta.cdl @@ -22,9 +22,11 @@ class Delta from TDF inherits TShared from MMgt - ---Purpose: A delta set is available at . If - -- applied, it restores the TDF_Data in the state it - -- was at . + ---Purpose: A set of AttributeDelta for a given transaction + -- number and reference time number. + -- A delta set is available at . If + -- applied, it restores the TDF_Data in the state it + -- was at . uses diff --git a/src/TDF/TDF_LabelMapHasher.cdl b/src/TDF/TDF_LabelMapHasher.cdl index ca8df34a50..cb077641ad 100644 --- a/src/TDF/TDF_LabelMapHasher.cdl +++ b/src/TDF/TDF_LabelMapHasher.cdl @@ -21,7 +21,7 @@ class LabelMapHasher from TDF - + ---Purpose: A label hasher for label maps. uses Label from TDF diff --git a/src/TDF/TDF_Reference.cdl b/src/TDF/TDF_Reference.cdl index 6ec42d9d1d..4b62f8d159 100644 --- a/src/TDF/TDF_Reference.cdl +++ b/src/TDF/TDF_Reference.cdl @@ -15,7 +15,8 @@ class Reference from TDF inherits Attribute from TDF - ---Purpose: + ---Purpose: This attribute is used to store in the framework a + -- reference to an other label. uses Attribute from TDF, Label from TDF, diff --git a/src/TDF/TDF_RelocationTable.cdl b/src/TDF/TDF_RelocationTable.cdl index 257039ef61..9630026153 100644 --- a/src/TDF/TDF_RelocationTable.cdl +++ b/src/TDF/TDF_RelocationTable.cdl @@ -26,7 +26,8 @@ class RelocationTable from TDF ---Purpose: This is a relocation dictionnary between source -- and target labels, attributes or any - -- transient. Note that one target value may be the + -- transient(useful for copy or paste actions). + -- Note that one target value may be the -- relocation value of more than one source object. -- -- Common behaviour: it returns true and the found diff --git a/src/TDataStd/TDataStd.cdl b/src/TDataStd/TDataStd.cdl index 8425b9d075..c9a0ddd009 100644 --- a/src/TDataStd/TDataStd.cdl +++ b/src/TDataStd/TDataStd.cdl @@ -92,7 +92,7 @@ is class UAttribute; - ---Purpose: Attributes for organization + ---Category: Attributes for organization -- ============================ class TreeNode; diff --git a/src/TDataXtd/TDataXtd.cdl b/src/TDataXtd/TDataXtd.cdl index ab074e6ae0..cb66edfcd5 100644 --- a/src/TDataXtd/TDataXtd.cdl +++ b/src/TDataXtd/TDataXtd.cdl @@ -109,13 +109,11 @@ is deferred class Pattern; class PatternStd; - ---Purpose: LinearPattern, CircularPattern, RectangularPattern, - -- RadialCircularPattern, MirrorPattern - + class Shape; - ---Purpose: tools - -- ===== + ---Category: tools + -- ===== class Array1OfTrsf instantiates Array1 from TCollection (Trsf from gp); diff --git a/src/TDataXtd/TDataXtd_PatternStd.cdl b/src/TDataXtd/TDataXtd_PatternStd.cdl index d58f342cd3..2a6d56d478 100644 --- a/src/TDataXtd/TDataXtd_PatternStd.cdl +++ b/src/TDataXtd/TDataXtd_PatternStd.cdl @@ -15,7 +15,9 @@ class PatternStd from TDataXtd inherits Pattern from TDataXtd - ---Purpose: to create a PatternStd + ---Purpose: to create a PatternStd + -- (LinearPattern, CircularPattern, RectangularPattern, + -- RadialCircularPattern, MirrorPattern) uses diff --git a/src/TDocStd/TDocStd.cdl b/src/TDocStd/TDocStd.cdl index cb351b0a36..b4b00d038f 100644 --- a/src/TDocStd/TDocStd.cdl +++ b/src/TDocStd/TDocStd.cdl @@ -61,8 +61,8 @@ uses is - ---Purpose: standard Application/Document - -- ============================= + --- standard Application/Document + -- ============================= deferred class Application; @@ -72,43 +72,26 @@ is class Context; - ---Purpose: External reference Attribute - -- ============================ + --- External reference Attribute + -- ============================ class XLink; - ---Purpose: This attribute, when setted, store an external - -- reference . An external reference is a memorized link - -- between attributes wich originate from different - -- documents. - + class XLinkIterator; - ---Purpose: This is an iterator giving all the external references - -- of a Document. class XLinkTool; - ---Purpose: This class provide services to set, update and perform - -- external references. - - ---Purpose: Attributes for Document Management - -- ================================== + --- Attributes for Document Management + -- ================================== private class Owner; - ---Purpose: This attribute located at the root label of the - -- framework contains a back reference to the owner - -- TDocStd_Document, providing acces to the document from - -- any label. private class Owner; private class Modified; - ---Purpose: This attribute located at the root label provide - -- services to register modified labels in a document. - + pointer XLinkPtr to XLink from TDocStd; private class XLinkRoot; - ---Purpose: This attribute is the root of all external references - -- setted in a document. - + class PathParser; diff --git a/src/TDocStd/TDocStd_Owner.cdl b/src/TDocStd/TDocStd_Owner.cdl index d21d44757d..33e8119482 100644 --- a/src/TDocStd/TDocStd_Owner.cdl +++ b/src/TDocStd/TDocStd_Owner.cdl @@ -16,7 +16,10 @@ private class Owner from TDocStd inherits Attribute from TDF - ---Purpose: + ---Purpose: This attribute located at the root label of the + -- framework contains a back reference to the owner + -- TDocStd_Document, providing acces to the document from + -- any label. private class Owner; uses Attribute from TDF, GUID from Standard, diff --git a/src/TDocStd/TDocStd_XLinkIterator.cdl b/src/TDocStd/TDocStd_XLinkIterator.cdl index 9c71b83fb2..c98bd06489 100644 --- a/src/TDocStd/TDocStd_XLinkIterator.cdl +++ b/src/TDocStd/TDocStd_XLinkIterator.cdl @@ -23,6 +23,8 @@ class XLinkIterator from TDocStd ---Purpose: Iterates on Reference attributes. + -- This is an iterator giving all the external references + -- of a Document. uses Document from TDocStd, XLink from TDocStd, diff --git a/src/TDocStd/TDocStd_XLinkTool.cdl b/src/TDocStd/TDocStd_XLinkTool.cdl index 9f5371f64e..479adfe270 100644 --- a/src/TDocStd/TDocStd_XLinkTool.cdl +++ b/src/TDocStd/TDocStd_XLinkTool.cdl @@ -27,6 +27,8 @@ class XLinkTool from TDocStd -- Depending of the called method an external -- reference is set in the the target document to -- registred the externallink. + -- Provide services to set, update and perform + -- external references. -- Warning1: Nothing is provided in this class about the -- opportunity to copy, set a link or update it. -- Such decisions must be under application control. diff --git a/src/TNaming/TNaming.cdl b/src/TNaming/TNaming.cdl index b1e17eb49c..0b71de3414 100644 --- a/src/TNaming/TNaming.cdl +++ b/src/TNaming/TNaming.cdl @@ -97,11 +97,9 @@ is class CopyShape; class TranslateTool; - ---Purpose: tool to copy underlying TShape of a Shape private class Translator; - ---Purpose: only for Shape Copy test - to move in DNaming - + ---Category: classes to store shapes and their evolution in the framework -- ============================================================ @@ -148,35 +146,25 @@ is -- removed by a Boolean operation. class NamedShape; - ---Purpose: attribute to store shapes and their evolution - + private class UsedShapes; - ---Purpose: global attribute located under root label to store all - -- the shapes handled by the framework + class Builder; - ---Purpose: API to build a NamedShape attribute. class Tool; - ---Purpose: methods to interogate naming data class Iterator; - ---Purpose: Iterates on all the evolutions in an attribute. class NewShapeIterator; - ---Purpose: To iterate on all the shapes created from a given - -- shape. class OldShapeIterator; - ---Purpose: To iterate on all the shapes which created a given - -- shape. class SameShapeIterator; - ---Purpose: To iterate on all the label which contained a - -- given shape. + class NamedShapeHasher instantiates MapHasher from TCollection(NamedShape from TNaming) ; @@ -187,8 +175,8 @@ is class ListOfNamedShape instantiates List from TCollection (NamedShape from TNaming); - ---Purpose: classes to store selected shape (involve naming algorithm) - -- ========================================================= + ---Category: classes to store selected shape (involve naming algorithm) + -- ========================================================== enumeration NameType is @@ -208,14 +196,10 @@ is end NameType; class Name; - ---Purpose: store the arguments of Naming. class Naming; - ---Purpose: Perform Topological naming when the topology is not - -- already attached to a specific label. class Selector; - ---Purpose: API to select shapes (identification and solving) diff --git a/src/TNaming/TNaming_Name.cdl b/src/TNaming/TNaming_Name.cdl index e0f4b88eb7..9893eee2ae 100644 --- a/src/TNaming/TNaming_Name.cdl +++ b/src/TNaming/TNaming_Name.cdl @@ -18,7 +18,7 @@ class Name from TNaming - + ---Purpose: store the arguments of Naming. uses NameType from TNaming, diff --git a/src/TNaming/TNaming_TranslateTool.cdl b/src/TNaming/TNaming_TranslateTool.cdl index 2ed88eb256..fd09fba722 100644 --- a/src/TNaming/TNaming_TranslateTool.cdl +++ b/src/TNaming/TNaming_TranslateTool.cdl @@ -16,9 +16,10 @@ class TranslateTool from TNaming inherits TShared from MMgt - ---Purpose: The TranslateTool class is provided to support the - -- translation of topological data structures Transient - -- . to Transient. + ---Purpose: tool to copy underlying TShape of a Shape. + -- The TranslateTool class is provided to support the + -- translation of topological data structures Transient + -- to Transient. uses Shape from TopoDS, diff --git a/src/TNaming/TNaming_Translator.cdl b/src/TNaming/TNaming_Translator.cdl index df117e0a67..2e10ed6a6c 100644 --- a/src/TNaming/TNaming_Translator.cdl +++ b/src/TNaming/TNaming_Translator.cdl @@ -16,7 +16,7 @@ private class Translator from TNaming - ---Purpose: + ---Purpose: only for Shape Copy test - to move in DNaming uses Shape from TopoDS, diff --git a/src/TNaming/TNaming_UsedShapes.cdl b/src/TNaming/TNaming_UsedShapes.cdl index a6157f771b..c038f67265 100644 --- a/src/TNaming/TNaming_UsedShapes.cdl +++ b/src/TNaming/TNaming_UsedShapes.cdl @@ -16,7 +16,9 @@ private class UsedShapes from TNaming inherits Attribute from TDF - ---Purpose: Set of Shapes Used in a Data from TDF + ---Purpose: Global attribute located under root label to store all + -- the shapes handled by the framework + -- Set of Shapes Used in a Data from TDF -- Only one instance by Data, it always -- Stored as Attribute of The Root. diff --git a/src/TopAbs/TopAbs.cdl b/src/TopAbs/TopAbs.cdl index e654e9175e..7a3cc7bb8e 100644 --- a/src/TopAbs/TopAbs.cdl +++ b/src/TopAbs/TopAbs.cdl @@ -15,10 +15,6 @@ -- commercial license or contractual agreement. package TopAbs - - ---Level : Public. - -- All methods of all classes will be public. - ---Purpose: This package gives resources for Topology oriented -- applications such as : Topological Data Structure, -- Topological Algorithms. @@ -36,6 +32,9 @@ package TopAbs -- -- * Methods to manage the enumerations. + ---Level : Public. + -- All methods of all classes will be public. + is enumeration ShapeEnum is diff --git a/src/TopBas/TopBas.cdl b/src/TopBas/TopBas.cdl index b494b6da3f..89ee5530bf 100644 --- a/src/TopBas/TopBas.cdl +++ b/src/TopBas/TopBas.cdl @@ -33,8 +33,6 @@ uses is generic class Interference; - ---Purpose: The Interference is the description of an - -- intersection on a Shape. class TestInterference instantiates Interference from TopBas (Real from Standard, diff --git a/src/TopClass/TopClass.cdl b/src/TopClass/TopClass.cdl index bb3f96f025..ebe687b3e6 100644 --- a/src/TopClass/TopClass.cdl +++ b/src/TopClass/TopClass.cdl @@ -33,29 +33,17 @@ uses is generic class Classifier2d; - ---Purpose: Basic algorithm for 2d classifications. - generic class FaceClassifier, FClass2d; - ---Purpose: Algorithm for classification in a Face. - deferred class Intersection3d; - ---Purpose: Describes the intersection algorithm for 3d - -- classifications. - + generic class Classifier3d; - ---Purpose: Basic algorithm for 3d classification. - + deferred class SolidExplorer; - ---Purpose: Defines the description of a solid for the - -- SolidClassifier. - + generic class SolidClassifier; - ---Purpose: Algorithm for classification in a Solid. - - - + end TopClass; diff --git a/src/TopClass/TopClass_Classifier2d.cdl b/src/TopClass/TopClass_Classifier2d.cdl index 668be0add3..3d886b959c 100644 --- a/src/TopClass/TopClass_Classifier2d.cdl +++ b/src/TopClass/TopClass_Classifier2d.cdl @@ -21,7 +21,7 @@ generic class Classifier2d from TopClass (TheEdge as any; TheIntersector as any) - ---Purpose: + ---Purpose: Basic algorithm for 2d classifications. uses Lin2d from gp, diff --git a/src/TopClass/TopClass_Classifier3d.cdl b/src/TopClass/TopClass_Classifier3d.cdl index abc7878a57..9e73dafa0e 100644 --- a/src/TopClass/TopClass_Classifier3d.cdl +++ b/src/TopClass/TopClass_Classifier3d.cdl @@ -17,7 +17,7 @@ generic class Classifier3d from TopClass (TheIntersector as any) -- as Intersection3d from TopClass - ---Purpose: + ---Purpose: Basic algorithm for 3d classification. uses Lin from gp, diff --git a/src/TopClass/TopClass_SolidExplorer.cdl b/src/TopClass/TopClass_SolidExplorer.cdl index 973bbe3620..7ab511a3d8 100644 --- a/src/TopClass/TopClass_SolidExplorer.cdl +++ b/src/TopClass/TopClass_SolidExplorer.cdl @@ -17,7 +17,8 @@ deferred class SolidExplorer from TopClass ---Purpose: Provide an exploration of a BRep Shape for the - -- classification. + -- classification. Defines the description of a solid for the + -- SolidClassifier. uses Pnt from gp, diff --git a/src/TopCnx/TopCnx.cdl b/src/TopCnx/TopCnx.cdl index 6bcf8bff33..b41772f5fa 100644 --- a/src/TopCnx/TopCnx.cdl +++ b/src/TopCnx/TopCnx.cdl @@ -52,7 +52,5 @@ uses is class EdgeFaceTransition; - ---Purpose: Algorithm to compute cumulated transitions on an - -- edge crossing the boundary of a face. end TopCnx; diff --git a/src/TopLoc/TopLoc.cdl b/src/TopLoc/TopLoc.cdl index 17fa1e7c36..7247878722 100644 --- a/src/TopLoc/TopLoc.cdl +++ b/src/TopLoc/TopLoc.cdl @@ -36,18 +36,13 @@ uses is pointer TrsfPtr to Trsf from gp; class Datum3D; - ---Purpose: An elementary 3D coordinate system. private class ItemLocation; - ---Purpose: Used to implement the Location. A Datum3D with a - -- power elevation. private class SListOfItemLocation; private class SListNodeOfItemLocation; class Location; - ---Purpose: A Local Coordinate System. A list of elementary - -- Datums. class MapLocationHasher instantiates MapHasher from TCollection(Location from TopLoc); diff --git a/src/TopOpeBRep/TopOpeBRep.cdl b/src/TopOpeBRep/TopOpeBRep.cdl index 7d9bbe62aa..15b7c7a707 100644 --- a/src/TopOpeBRep/TopOpeBRep.cdl +++ b/src/TopOpeBRep/TopOpeBRep.cdl @@ -109,16 +109,15 @@ is class GeomTool; class FacesIntersector; - ---Purpose: Describes the intersection of two faces. + pointer PFacesIntersector to FacesIntersector from TopOpeBRep; class EdgesIntersector; - ---Purpose: Describes the intersection of two edges on the same surface + pointer PEdgesIntersector to EdgesIntersector from TopOpeBRep; class FaceEdgeIntersector; - ---Purpose: Describes the intersection of a face and an edge. - + class ShapeScanner; class ShapeIntersector; diff --git a/src/TopOpeBRep/TopOpeBRep_EdgesIntersector.cdl b/src/TopOpeBRep/TopOpeBRep_EdgesIntersector.cdl index 6bd3a2a84d..21e15c3349 100644 --- a/src/TopOpeBRep/TopOpeBRep_EdgesIntersector.cdl +++ b/src/TopOpeBRep/TopOpeBRep_EdgesIntersector.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class EdgesIntersector from TopOpeBRep + ---Purpose: Describes the intersection of two edges on the same surface uses diff --git a/src/TopOpeBRep/TopOpeBRep_FaceEdgeIntersector.cdl b/src/TopOpeBRep/TopOpeBRep_FaceEdgeIntersector.cdl index 787625a5c2..86b721545f 100644 --- a/src/TopOpeBRep/TopOpeBRep_FaceEdgeIntersector.cdl +++ b/src/TopOpeBRep/TopOpeBRep_FaceEdgeIntersector.cdl @@ -16,7 +16,7 @@ class FaceEdgeIntersector from TopOpeBRep - ---Purpose: + ---Purpose: Describes the intersection of a face and an edge. uses diff --git a/src/TopOpeBRep/TopOpeBRep_FacesIntersector.cdl b/src/TopOpeBRep/TopOpeBRep_FacesIntersector.cdl index 287595f947..5800653ce4 100644 --- a/src/TopOpeBRep/TopOpeBRep_FacesIntersector.cdl +++ b/src/TopOpeBRep/TopOpeBRep_FacesIntersector.cdl @@ -16,7 +16,7 @@ class FacesIntersector from TopOpeBRep - ---Purpose: + ---Purpose: Describes the intersection of two faces. uses diff --git a/src/TopOpeBRepDS/TopOpeBRepDS.cdl b/src/TopOpeBRepDS/TopOpeBRepDS.cdl index 7565179b0b..25558d5e10 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS.cdl @@ -94,21 +94,20 @@ is class Transition; class CurvePointInterference; - ---Purpose: Interference + a parameter. + class SurfaceCurveInterference; - ---Purpose: Interference + a pcurve. + class SolidSurfaceInterference; - ---Purpose: Interference + class ShapeShapeInterference; - ---Purpose: Interference + class EdgeVertexInterference; - ---Purpose: ShapeShapeInterference + class FaceEdgeInterference; - ---Purpose: ShapeShapeInterference - - class Surface; ---Purpose:A surface and a tolerance. - class Curve; ---Purpose:A curve and a tolerance. - class Point; ---Purpose:A point and a tolerance. + + class Surface; + class Curve; + class Point; class IndexedDataMapOfVertexPoint instantiates IndexedDataMap from TCollection (Shape from TopoDS, diff --git a/src/TopOpeBRepDS/TopOpeBRepDS_Curve.cdl b/src/TopOpeBRepDS/TopOpeBRepDS_Curve.cdl index c61f8e85e5..373f4d614e 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS_Curve.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS_Curve.cdl @@ -16,7 +16,7 @@ class Curve from TopOpeBRepDS - ---Purpose: A Geom point and a tolerance. + ---Purpose: A Geom curve and a tolerance. uses diff --git a/src/TopOpeBRepDS/TopOpeBRepDS_EdgeVertexInterference.cdl b/src/TopOpeBRepDS/TopOpeBRepDS_EdgeVertexInterference.cdl index 6f162c8dbc..07385b200b 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS_EdgeVertexInterference.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS_EdgeVertexInterference.cdl @@ -17,7 +17,7 @@ class EdgeVertexInterference from TopOpeBRepDS inherits ShapeShapeInterference from TopOpeBRepDS - ---Purpose: An interference with a parameter. + ---Purpose: An interference with a parameter (ShapeShapeInterference). uses diff --git a/src/TopOpeBRepDS/TopOpeBRepDS_FaceEdgeInterference.cdl b/src/TopOpeBRepDS/TopOpeBRepDS_FaceEdgeInterference.cdl index 3849fcd122..f8db311af8 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS_FaceEdgeInterference.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS_FaceEdgeInterference.cdl @@ -16,6 +16,7 @@ class FaceEdgeInterference from TopOpeBRepDS inherits ShapeShapeInterference from TopOpeBRepDS + ---Purpose: ShapeShapeInterference uses diff --git a/src/TopOpeBRepDS/TopOpeBRepDS_ShapeShapeInterference.cdl b/src/TopOpeBRepDS/TopOpeBRepDS_ShapeShapeInterference.cdl index 7171e9d4df..4926683eb6 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS_ShapeShapeInterference.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS_ShapeShapeInterference.cdl @@ -17,7 +17,7 @@ class ShapeShapeInterference from TopOpeBRepDS inherits Interference from TopOpeBRepDS - ---Purpose: + ---Purpose: Interference uses diff --git a/src/TopOpeBRepDS/TopOpeBRepDS_SolidSurfaceInterference.cdl b/src/TopOpeBRepDS/TopOpeBRepDS_SolidSurfaceInterference.cdl index cd95fedef5..15aec4a341 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS_SolidSurfaceInterference.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS_SolidSurfaceInterference.cdl @@ -17,7 +17,7 @@ class SolidSurfaceInterference from TopOpeBRepDS inherits Interference from TopOpeBRepDS - ---Purpose: + ---Purpose: Interference uses diff --git a/src/TopOpeBRepDS/TopOpeBRepDS_Surface.cdl b/src/TopOpeBRepDS/TopOpeBRepDS_Surface.cdl index 031454b9be..173e0a9d8a 100644 --- a/src/TopOpeBRepDS/TopOpeBRepDS_Surface.cdl +++ b/src/TopOpeBRepDS/TopOpeBRepDS_Surface.cdl @@ -16,7 +16,7 @@ class Surface from TopOpeBRepDS - ---Purpose: A Geom poimt and a tolerance. + ---Purpose: A Geom surface and a tolerance. uses diff --git a/src/TopOpeBRepTool/TopOpeBRepTool.cdl b/src/TopOpeBRepTool/TopOpeBRepTool.cdl index 18a8d51e1a..0f85ca2fd9 100644 --- a/src/TopOpeBRepTool/TopOpeBRepTool.cdl +++ b/src/TopOpeBRepTool/TopOpeBRepTool.cdl @@ -121,8 +121,6 @@ is class mkTondgE; class PurgeInternalEdges; - ---Purpose: Detect and remove Internal and External edges (that - -- are not connex to other faces) from all faces of a shape. class FuseEdges; ---Purpose: Fuse edges (in a wire) of a shape where we have diff --git a/src/TopTools/TopTools.cdl b/src/TopTools/TopTools.cdl index 0f499dcd1b..b3344ba26e 100644 --- a/src/TopTools/TopTools.cdl +++ b/src/TopTools/TopTools.cdl @@ -198,7 +198,6 @@ is ---------------------------------------------------------- class LocationSet; - ---Purpose: A set of Locations. Can be dump, wrote or read. pointer LocationSetPtr to LocationSet from TopTools; diff --git a/src/TopoDS/TopoDS.cdl b/src/TopoDS/TopoDS.cdl index d8bb20ba55..92aa8cfd3f 100644 --- a/src/TopoDS/TopoDS.cdl +++ b/src/TopoDS/TopoDS.cdl @@ -42,80 +42,47 @@ is -- classes class Shape; - ---Purpose: A reference to a Topological shape with Location, - -- Orientation. class HShape; - ---Purpose: Class to manipulate a Shape with handle. class ListOfShape instantiates List from TCollection (Shape from TopoDS); ---Purpose: Used to implement the TShape. deferred class TShape; - ---Purpose: A topological shape is a structure made from other - -- shapes. This is a deferred class used to support - -- topological objects. deferred class TVertex; - ---Purpose: A Vertex is a topological point in two or three - -- dimensions. class Vertex; - ---Purpose: A TVertex with a localisation and an orientation. deferred class TEdge; - ---Purpose: A topological part of a curve in 2D or 3D, the - -- boundary is a set of oriented Vertices. class Edge; - ---Purpose: A TEdge with a localisation and an orientation. class TWire; - ---Purpose: A set of edges connected by their vertices. class Wire; - ---Purpose: A TWire with a localisation and an orientation. class TFace; - ---Purpose: A topological part of a surface or of the 2D - -- space. The boundary is a set of wires and - -- vertices. class Face; - ---Purpose: A TFace with a localisation and an orientation. class TShell; - ---Purpose: A set of faces connected by their edges. class Shell; - ---Purpose: A TShell with a localisation and an orientation. class TSolid; - ---Purpose: A Topological part of 3D space, bounded by shells, - -- edges and vertices. class Solid; - ---Purpose: A Solid with a localisation and an orientation. class TCompSolid; - ---Purpose: A set of solids connected by their faces. class CompSolid; - ---Purpose: A TCompSolid with a localisation and an - -- orientation. Casts shape S to the more specialized return type, CompSolid. class TCompound; - ---Purpose: A TCompound is an all-purpose set of Shapes. class Compound; - ---Purpose: A TCompound with a localisation and an - -- orientation. - -- Casts shape S to the more specialized return type, Compound. class Builder; - ---Purpose: A builder is an object used to create and modify - -- Data Structures. It is the root of the Builder - -- class hierarchy. class Iterator; ---Purpose: Basic tool to access the data structure. diff --git a/src/TopoDS/TopoDS_Builder.cdl b/src/TopoDS/TopoDS_Builder.cdl index 49fd26fec4..52c76c8a72 100644 --- a/src/TopoDS/TopoDS_Builder.cdl +++ b/src/TopoDS/TopoDS_Builder.cdl @@ -17,7 +17,7 @@ class Builder from TopoDS ---Purpose: A Builder is used to create Topological Data - -- Structures. + -- Structures.It is the root of the Builder class hierarchy. -- -- There are three groups of methods in the Builder : -- diff --git a/src/TopoDS/TopoDS_CompSolid.cdl b/src/TopoDS/TopoDS_CompSolid.cdl index 47a11d3e80..743349e819 100644 --- a/src/TopoDS/TopoDS_CompSolid.cdl +++ b/src/TopoDS/TopoDS_CompSolid.cdl @@ -24,6 +24,7 @@ class CompSolid from TopoDS inherits Shape from TopoDS -- - has an orientation for the underlying composite -- solid, in terms of its geometry (as opposed to -- orientation in relation to other shapes). +-- Casts shape S to the more specialized return type, CompSolid. is Create returns CompSolid from TopoDS; diff --git a/src/TopoDS/TopoDS_Compound.cdl b/src/TopoDS/TopoDS_Compound.cdl index 6a68171d9b..042f3a610b 100644 --- a/src/TopoDS/TopoDS_Compound.cdl +++ b/src/TopoDS/TopoDS_Compound.cdl @@ -24,6 +24,7 @@ class Compound from TopoDS inherits Shape from TopoDS -- - has an orientation for the underlying compound, in -- terms of its geometry (as opposed to orientation in -- relation to other shapes). +-- Casts shape S to the more specialized return type, Compound. is Create returns Compound from TopoDS; diff --git a/src/TopoDS/TopoDS_TCompSolid.cdl b/src/TopoDS/TopoDS_TCompSolid.cdl index 8f5ea45d7c..f16c155e50 100644 --- a/src/TopoDS/TopoDS_TCompSolid.cdl +++ b/src/TopoDS/TopoDS_TCompSolid.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class TCompSolid from TopoDS inherits TShape from TopoDS + ---Purpose: A set of solids connected by their faces. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TCompound.cdl b/src/TopoDS/TopoDS_TCompound.cdl index 5fac978a07..3405358705 100644 --- a/src/TopoDS/TopoDS_TCompound.cdl +++ b/src/TopoDS/TopoDS_TCompound.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class TCompound from TopoDS inherits TShape from TopoDS + ---Purpose: A TCompound is an all-purpose set of Shapes. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TEdge.cdl b/src/TopoDS/TopoDS_TEdge.cdl index dd602455f5..abc1bba5ef 100644 --- a/src/TopoDS/TopoDS_TEdge.cdl +++ b/src/TopoDS/TopoDS_TEdge.cdl @@ -15,6 +15,8 @@ -- commercial license or contractual agreement. deferred class TEdge from TopoDS inherits TShape from TopoDS + ---Purpose: A topological part of a curve in 2D or 3D, the + -- boundary is a set of oriented Vertices. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TFace.cdl b/src/TopoDS/TopoDS_TFace.cdl index 2d6fb1b745..2d4b8f1b52 100644 --- a/src/TopoDS/TopoDS_TFace.cdl +++ b/src/TopoDS/TopoDS_TFace.cdl @@ -15,6 +15,9 @@ -- commercial license or contractual agreement. class TFace from TopoDS inherits TShape from TopoDS + ---Purpose: A topological part of a surface or of the 2D + -- space. The boundary is a set of wires and + -- vertices. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TShape.cdl b/src/TopoDS/TopoDS_TShape.cdl index e9ad69b3ec..2a90ab2d94 100644 --- a/src/TopoDS/TopoDS_TShape.cdl +++ b/src/TopoDS/TopoDS_TShape.cdl @@ -19,6 +19,10 @@ deferred class TShape from TopoDS inherits TShared from MMgt ---Purpose: A TShape is a topological structure describing a -- set of points in a 2D or 3D space. -- + -- A topological shape is a structure made from other + -- shapes. This is a deferred class used to support + -- topological objects. + -- -- TShapes are defined by their optional domain -- (geometry) and their components (other TShapes -- with Locations and Orientations). The components diff --git a/src/TopoDS/TopoDS_TShell.cdl b/src/TopoDS/TopoDS_TShell.cdl index 150f0acd52..b8c06fe727 100644 --- a/src/TopoDS/TopoDS_TShell.cdl +++ b/src/TopoDS/TopoDS_TShell.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class TShell from TopoDS inherits TShape from TopoDS + ---Purpose: A set of faces connected by their edges. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TSolid.cdl b/src/TopoDS/TopoDS_TSolid.cdl index 0a593d8c64..17d7119e04 100644 --- a/src/TopoDS/TopoDS_TSolid.cdl +++ b/src/TopoDS/TopoDS_TSolid.cdl @@ -15,6 +15,8 @@ -- commercial license or contractual agreement. class TSolid from TopoDS inherits TShape from TopoDS + ---Purpose: A Topological part of 3D space, bounded by shells, + -- edges and vertices. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TVertex.cdl b/src/TopoDS/TopoDS_TVertex.cdl index 42fe48cc1e..04c665f43a 100644 --- a/src/TopoDS/TopoDS_TVertex.cdl +++ b/src/TopoDS/TopoDS_TVertex.cdl @@ -15,6 +15,8 @@ -- commercial license or contractual agreement. deferred class TVertex from TopoDS inherits TShape from TopoDS + ---Purpose: A Vertex is a topological point in two or three + -- dimensions. uses ShapeEnum from TopAbs diff --git a/src/TopoDS/TopoDS_TWire.cdl b/src/TopoDS/TopoDS_TWire.cdl index 0bb5839888..70119716c1 100644 --- a/src/TopoDS/TopoDS_TWire.cdl +++ b/src/TopoDS/TopoDS_TWire.cdl @@ -15,6 +15,7 @@ -- commercial license or contractual agreement. class TWire from TopoDS inherits TShape from TopoDS + ---Purpose: A set of edges connected by their vertices. uses ShapeEnum from TopAbs diff --git a/src/V3d/V3d.cdl b/src/V3d/V3d.cdl index 27bd364528..8212178c11 100644 --- a/src/V3d/V3d.cdl +++ b/src/V3d/V3d.cdl @@ -175,33 +175,22 @@ is ------------------------ class Viewer; - ---Purpose: Provides the services of a 3D viewer. class View; - ---Purpose: Provides a set of services common to all types of view. class LayerMgr; - ---Purpose: Services of layer management. deferred class Light; - ---Purpose: Provides services common to all types of luminous source. - -- (base class for AmbientLight and PositionLight) - class AmbientLight; - ---Purpose: Services of ambient light sources. deferred class PositionLight; - ---Purpose: Provides services common to Positional,Directional,Spot Lights. class PositionalLight; - ---Purpose: Services of positional light sources. class DirectionalLight; - ---Purpose: Services of directional light sources. class SpotLight; - ---Purpose: Services of spot light sources. --------------------------------- ---Category: Instantiated classes diff --git a/src/V3d/V3d_Light.cdl b/src/V3d/V3d_Light.cdl index cd03118d9d..ad874789f4 100644 --- a/src/V3d/V3d_Light.cdl +++ b/src/V3d/V3d_Light.cdl @@ -23,7 +23,7 @@ deferred class Light from V3d ---Purpose: Defines services on Light type objects.. - + -- (base class for AmbientLight and PositionLight) inherits diff --git a/src/V3d/V3d_PositionalLight.cdl b/src/V3d/V3d_PositionalLight.cdl index 0208d34bcc..be612b4da2 100644 --- a/src/V3d/V3d_PositionalLight.cdl +++ b/src/V3d/V3d_PositionalLight.cdl @@ -23,7 +23,7 @@ class PositionalLight from V3d ---Version: ---Purpose: Creation and modification of an isolated - -- light source. + -- (positional) light source. ---Keywords: Light,Positional diff --git a/src/V3d/V3d_View.cdl b/src/V3d/V3d_View.cdl index 5e00113eb7..9f0b1f8f62 100644 --- a/src/V3d/V3d_View.cdl +++ b/src/V3d/V3d_View.cdl @@ -59,6 +59,7 @@ class View from V3d inherits TShared from MMgt -- and inquiring the parameters linked to the view. -- (Projection,Mapping,Zclipping,DepthCueing,AntiAliasing -- et Conversions) . + -- Provides a set of services common to all types of view. -- Warning: The default parameters are defined by the class -- Viewer (Example : SetDefaultViewSize()). -- Certain methods are mouse oriented, and it is diff --git a/src/ViewerTest/ViewerTest.cdl b/src/ViewerTest/ViewerTest.cdl index 9f634a5f79..7d77fa5bb1 100644 --- a/src/ViewerTest/ViewerTest.cdl +++ b/src/ViewerTest/ViewerTest.cdl @@ -35,9 +35,6 @@ uses is class EventManager; - ---Purpose: used to manage mouse event (move,select,shiftselect) - -- By default the events are transmitted to interactive context. - class DoubleMapOfInteractiveAndName instantiates DoubleMap from TCollection ( Transient from Standard, diff --git a/src/ViewerTest/ViewerTest_EventManager.cdl b/src/ViewerTest/ViewerTest_EventManager.cdl index 4712139c98..e3c69651c7 100644 --- a/src/ViewerTest/ViewerTest_EventManager.cdl +++ b/src/ViewerTest/ViewerTest_EventManager.cdl @@ -16,7 +16,9 @@ class EventManager from ViewerTest inherits TShared from MMgt - ---Purpose: + ---Purpose: used to manage mouse event (move,select,shiftselect) + -- By default the events are transmitted to interactive context. + uses View from V3d, diff --git a/src/Visual3d/Visual3d.cdl b/src/Visual3d/Visual3d.cdl index 0cd7bfccd1..a3e673ce74 100644 --- a/src/Visual3d/Visual3d.cdl +++ b/src/Visual3d/Visual3d.cdl @@ -198,56 +198,24 @@ is ------------------------ class ContextPick; - ---Purpose: This class allows the creation and update of a - -- pick context for one view of the viewer. - -- A context allows the control of different parameters - -- before the activation of a pick : - -- - -- * pick aperture. - -- * the depth of pick, the number of sub-structures selected. - -- * the order of picking, the possibility to traverse - -- the pick structures starting from the roots or the leaves. ---Category: The classes class ContextView; - ---Purpose: This class manages the creation and update of a - -- visualisation context for one view in the viewer. - -- - -- A context is defined by : - -- * Antialiasing. - -- * ZClipping. - -- * Depth-cueing. - -- * The type of visualisation. - -- * The light sources. ---Category: The classes class Light; - ---Purpose: This class defines and updates light sources. - -- There is no limit to the number of light sources defined. - -- Only the number of active sources is limited. ---Category: The classes class View; - ---Purpose: Creation and editing of a view in a 3D visualiser. - -- - -- A 3D view is composed of an 'orientation' part defined - -- by the position of the observer, the viewing direction, - -- and a 'mapping' part defined by the type of projection - -- (parallel or perspective), and by the window-viewport - -- couple which allows passage from the projected coordinate - -- space into the screen space. ---Category: The classes class ViewManager; - ---Purpose: 3D Visualiser ---Category: The classes class Layer; - ---Purpose: 2D Layer ---Category: The classes class LayerItem; - ---Purpose: 2D Layer presentation unit ---Category: The classes --------------------- diff --git a/src/Vrml/Vrml.cdl b/src/Vrml/Vrml.cdl index 6e071a7d17..59ad87546d 100644 --- a/src/Vrml/Vrml.cdl +++ b/src/Vrml/Vrml.cdl @@ -75,7 +75,7 @@ is ---Category: Classes of VRML field types. - ---Purpose: qualifies all types of VRML fields. + -- Qualifies all types of VRML fields. -- Notes: @@ -97,9 +97,8 @@ is -- MFVec3f VRML type == HArray1OfVec from TColgp - ---Purpose: defines SFImage type of VRML field types. class SFImage; - ---Purpose: defines SFRotation type of VRML field types. + class SFRotation; @@ -177,7 +176,7 @@ is ---Category: Classes of VRML nodes specifying properties of geometry --- and its appearance. - ---Purpose: qualifies properties of geometry and its appearance. + --- Qualifies properties of geometry and its appearance. @@ -269,7 +268,7 @@ is ---Category: Classes of VRML nodes specifying matrix and transform --- properties. - ---Purpose: qualifies matrix and transform properties. + --- Qualifies matrix and transform properties. class MatrixTransform; class Rotation; @@ -280,7 +279,7 @@ is ---Category: Classes of VRML nodes specifying properties of cameras --- and lights. - ---Purpose: qualifies properties of cameras and lights. + --- Qualifies properties of cameras and lights. class OrthographicCamera; class PerspectiveCamera; @@ -290,7 +289,7 @@ is ---Category: Classes of VRML nodes specifying group properties. - ---Purpose: qualifies group properties. + --- Qualifies group properties. diff --git a/src/VrmlAPI/VrmlAPI.cdl b/src/VrmlAPI/VrmlAPI.cdl index 7ebf296341..c131d9f4a9 100644 --- a/src/VrmlAPI/VrmlAPI.cdl +++ b/src/VrmlAPI/VrmlAPI.cdl @@ -23,22 +23,20 @@ uses Vrml, Quantity is - enumeration RepresentationOfShape - ---Purpose: Identifies the representation of the shape written - -- to a VRML file. The available options are : - -- - VrmlAPI_ShadedRepresentation : - -- the shape is translated with a shaded representation. - -- - VrmlAPI_WireFrameRepresentation : - -- the shape is translated with a wireframe representation. - -- - VrmlAPI_BothRepresentation : the shape is translated - -- to VRML format with both representations : shaded and - -- wireframe. This is the default option. - - is + enumeration RepresentationOfShape is ShadedRepresentation, WireFrameRepresentation, BothRepresentation end RepresentationOfShape; + ---Purpose: Identifies the representation of the shape written + -- to a VRML file. The available options are : + -- - VrmlAPI_ShadedRepresentation : + -- the shape is translated with a shaded representation. + -- - VrmlAPI_WireFrameRepresentation : + -- the shape is translated with a wireframe representation. + -- - VrmlAPI_BothRepresentation : the shape is translated + -- to VRML format with both representations : shaded and + -- wireframe. This is the default option. class Writer; ---Purpose: With help of this class user can change parameters of writing. diff --git a/src/VrmlConverter/VrmlConverter.cdl b/src/VrmlConverter/VrmlConverter.cdl index 30b4b205d5..427a1eb91a 100644 --- a/src/VrmlConverter/VrmlConverter.cdl +++ b/src/VrmlConverter/VrmlConverter.cdl @@ -55,90 +55,39 @@ is class Drawer; - ---Purpose: qualifies the aspect properties for - -- the VRML conversation of a specific kind of object. - -- This includes for example color, maximal chordial deviation, etc... class ShadingAspect; - ---Purpose: qualifies the aspect properties for - -- the VRML conversation of a ShadedShape. class LineAspect; - ---Purpose: qualifies the aspect properties for - -- the VRML conversation of a Curve and a DeflectionCurve . class IsoAspect; - ---Purpose: qualifies the aspect properties for - -- the VRML conversation of iso curves . class PointAspect; - ---Purpose: qualifies the aspect properties for - -- the VRML conversation of a Point Set . - - - ---Category: Presentation classes. - ---Purpose: To compute different kinds of presentation, to convert - -- CasCade objects into VRML objects for requested aspect - -- properties and to add the results to the stream. + ---Category: Presentation classes. + -- To compute different kinds of presentation, to convert + -- CasCade objects into VRML objects for requested aspect + -- properties and to add the results to the stream. class ShadedShape; - ---Purpose: computes the shading presentation of shapes - -- by triangulation algorithms. - - + class Curve; - ---Purpose: computes the presentation of objects to be - -- seen as curves. The computation will be made - -- whith a constant number of points. - class DeflectionCurve; - ---Purpose: computes the presentation of objects to be seen as - -- curves. The computation will be made according to - -- a maximal chordial deviation. + class DeflectionCurve; - class WFRestrictedFace; - ---Purpose: computes the wireframe presentation of faces with - -- restrictions by displaying a given number of U and/or - -- V isoparametric curves. The isoparametric curves are - -- drawn with a fixed number of points. - class WFDeflectionRestrictedFace; - ---Purpose: computes the wireframe presentation of faces with - -- restrictions by displaying a given number of U and/or - -- V isoparametric curves. The isoparametric curves are - -- drawn with respect to a maximal chordial deviation. - - class WFShape; - ---Purpose: computes the wireframe presentation of compound set - -- of faces, edges and vertices by displaying a given - -- number of U and/or V isoparametric curves. - + class WFShape; class WFDeflectionShape; - ---Purpose: computes the wireframe presentation of compound - -- set of faces, edges and vertices by displaying - -- a given number of U and/or V isoparametric curves. - class HLRShape; - ---Purpose: computes the presentation of objects with - -- removal of their hidden lines for a specific - -- projector. - - class Projector; - ---Purpose: defines the projection parameters for the hidden - -- lines removal algorithm and calculates properties of cameras - -- and lights from Vrml ( OrthograpicCamera, PerspectiveCamera, - -- DirectionalLight, PointLight, SpotLight ) - -- to display all shapes of scene with arbitrary locations - -- for requested the Projection Vector . - + class Projector; + -- Enumeration for cameras and lights from Vrml enumeration TypeOfCamera diff --git a/src/VrmlConverter/VrmlConverter_PointAspect.cdl b/src/VrmlConverter/VrmlConverter_PointAspect.cdl index cdb80da381..616f5d8145 100644 --- a/src/VrmlConverter/VrmlConverter_PointAspect.cdl +++ b/src/VrmlConverter/VrmlConverter_PointAspect.cdl @@ -17,7 +17,7 @@ class PointAspect from VrmlConverter inherits TShared from MMgt ---Purpose: qualifies the aspect properties for - -- the VRML conversation of points. + -- the VRML conversation of a Point Set. uses diff --git a/src/WNT/WNT.cdl b/src/WNT/WNT.cdl index 8a9c7755dc..20410f27c7 100644 --- a/src/WNT/WNT.cdl +++ b/src/WNT/WNT.cdl @@ -49,11 +49,9 @@ package WNT -------------------- class Window; - ---Purpose: Creates the Window drawable. ---Category: Classes class WClass; - ---Purpose: Creates a Windows NT window class. ---Category: Classes --------------------------- @@ -75,15 +73,12 @@ package WNT imported Dword; - ---Purpose: Defines a Windows NT DWORD type. ---Category: Imported types imported Uint; - ---Purpose: Defines a Windows NT UINT type. ---Category: Imported types imported WindowData; - ---Purpose: Defines additional window data type. ---Category: Imported types diff --git a/src/WNT/WNT_Dword.hxx b/src/WNT/WNT_Dword.hxx index 0c74750973..8249a12af6 100644 --- a/src/WNT/WNT_Dword.hxx +++ b/src/WNT/WNT_Dword.hxx @@ -15,6 +15,8 @@ #ifndef __WNT_Dword_HeaderFile # define __WNT_Dword_HeaderFile +// Purpose: Defines a Windows NT DWORD type. + # ifndef __WINDOWS_H_INCLUDED # define __WINDOWS_H_INCLUDED # ifndef STRICT diff --git a/src/WNT/WNT_Uint.hxx b/src/WNT/WNT_Uint.hxx index 88dd013cee..a61c601a7b 100644 --- a/src/WNT/WNT_Uint.hxx +++ b/src/WNT/WNT_Uint.hxx @@ -15,6 +15,8 @@ #ifndef __WNT_Uint_HeaderFile # define __WNT_Uint_HeaderFile +// Purpose: Defines a Windows NT UINT type. + # ifndef __WINDOWS_H_INCLUDED # define __WINDOWS_H_INCLUDED # ifndef STRICT diff --git a/src/WNT/WNT_WindowData.hxx b/src/WNT/WNT_WindowData.hxx index 0a03ba05e9..87540ff4f3 100644 --- a/src/WNT/WNT_WindowData.hxx +++ b/src/WNT/WNT_WindowData.hxx @@ -15,6 +15,8 @@ #ifndef __WNT_WindowData_HeaderFile # define __WNT_WindowData_HeaderFile +// Purpose: Defines additional window data type. + # ifndef __WINDOWS_H_INCLUDED # define __WINDOWS_H_INCLUDED # ifndef STRICT diff --git a/src/XCAFApp/XCAFApp.cdl b/src/XCAFApp/XCAFApp.cdl index a6e8585635..582c919d85 100644 --- a/src/XCAFApp/XCAFApp.cdl +++ b/src/XCAFApp/XCAFApp.cdl @@ -28,6 +28,5 @@ uses is class Application; - ---Purpose: Defines application for DECAF documents - + end XCAFApp; diff --git a/src/XCAFDoc/XCAFDoc.cdl b/src/XCAFDoc/XCAFDoc.cdl index ef29714dba..b28e8690c8 100644 --- a/src/XCAFDoc/XCAFDoc.cdl +++ b/src/XCAFDoc/XCAFDoc.cdl @@ -59,61 +59,37 @@ is class DocumentTool; - ---Purpose: Defines sections structure of an XDE document. - -- attribute marking CAF document as being DECAF document. - -- Creates the sections structure of the document. class Location; - ---Purpose: attribute to store TopLoc_Location class Color; - ---Purpose: attribute to store color class DimTol; - ---Purpose: attribute to store dimension and tolerance class Datum; - ---Purpose: attribute to store datum class Material; - ---Purpose: attribute to store material class Volume; - ---Purpose: attribute to store volume class Area; - ---Purpose: attribute to store area class Centroid; - ---Purpose: attribute to store centroid class ShapeTool; - ---Purpose: attribute containing Shapes section of DECAF document. - -- Provide tools for management of Shapes section. class ShapeMapTool; - ---Purpose: attribute containing map of sub shapes class ColorTool; - ---Purpose: attribute containing Colors section of DECAF document. - -- Provide tools for management of Colors section of document. class DimTolTool; - ---Purpose: attribute containing DimTol section of DECAF document. - -- Provide tools for management of DimTol section of document. - + class LayerTool; - ---Purpose: attribute containing Layers section og DECAF document. - -- Provide tools for management of Layers section of document. class MaterialTool; - ---Purpose: attribute containing Materials section og DECAF document. - -- Provide tools for management of Materialss section of document. class GraphNode; - ---Purpose: attribute containg sequence of father's and chaild's labels. - -- Provide create and work with Graph in XCAFDocument. - + class GraphNodeSequence instantiates Sequence from TCollection (GraphNode from XCAFDoc); ---Purpose: class for containing GraphNodes. diff --git a/src/XCAFDoc/XCAFDoc_Area.cdl b/src/XCAFDoc/XCAFDoc_Area.cdl index c616bc33d7..54ecf79bee 100644 --- a/src/XCAFDoc/XCAFDoc_Area.cdl +++ b/src/XCAFDoc/XCAFDoc_Area.cdl @@ -15,7 +15,7 @@ class Area from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store area uses Attribute from TDF, diff --git a/src/XCAFDoc/XCAFDoc_Centroid.cdl b/src/XCAFDoc/XCAFDoc_Centroid.cdl index 02f8c9af75..975ddfaa7e 100644 --- a/src/XCAFDoc/XCAFDoc_Centroid.cdl +++ b/src/XCAFDoc/XCAFDoc_Centroid.cdl @@ -15,7 +15,7 @@ class Centroid from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store centroid uses Pnt from gp, diff --git a/src/XCAFDoc/XCAFDoc_Color.cdl b/src/XCAFDoc/XCAFDoc_Color.cdl index bbf1e925da..21298bd633 100644 --- a/src/XCAFDoc/XCAFDoc_Color.cdl +++ b/src/XCAFDoc/XCAFDoc_Color.cdl @@ -15,7 +15,7 @@ class Color from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store color uses Color from Quantity, diff --git a/src/XCAFDoc/XCAFDoc_ColorTool.cdl b/src/XCAFDoc/XCAFDoc_ColorTool.cdl index b9590b409f..a039aea9b4 100644 --- a/src/XCAFDoc/XCAFDoc_ColorTool.cdl +++ b/src/XCAFDoc/XCAFDoc_ColorTool.cdl @@ -19,6 +19,7 @@ class ColorTool from XCAFDoc inherits Attribute from TDF -- of TopoDS_Shape in and from TDocStd_Document -- A Document is intended to hold different -- attributes of ONE shape and it's sub-shapes + -- Provide tools for management of Colors section of document. uses Color from Quantity, diff --git a/src/XCAFDoc/XCAFDoc_Datum.cdl b/src/XCAFDoc/XCAFDoc_Datum.cdl index e42d5caa26..17dad19fbb 100644 --- a/src/XCAFDoc/XCAFDoc_Datum.cdl +++ b/src/XCAFDoc/XCAFDoc_Datum.cdl @@ -15,7 +15,7 @@ class Datum from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store datum uses Label from TDF, diff --git a/src/XCAFDoc/XCAFDoc_DimTol.cdl b/src/XCAFDoc/XCAFDoc_DimTol.cdl index 50e11fcafc..57c5d09a17 100644 --- a/src/XCAFDoc/XCAFDoc_DimTol.cdl +++ b/src/XCAFDoc/XCAFDoc_DimTol.cdl @@ -15,7 +15,7 @@ class DimTol from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store dimension and tolerance uses Label from TDF, diff --git a/src/XCAFDoc/XCAFDoc_DimTolTool.cdl b/src/XCAFDoc/XCAFDoc_DimTolTool.cdl index 3c92e453c7..9564ff2557 100644 --- a/src/XCAFDoc/XCAFDoc_DimTolTool.cdl +++ b/src/XCAFDoc/XCAFDoc_DimTolTool.cdl @@ -18,8 +18,9 @@ class DimTolTool from XCAFDoc inherits Attribute from TDF ---Purpose: Provides tools to store and retrieve attributes (colors) -- of TopoDS_Shape in and from TDocStd_Document -- A Document is intended to hold different - -- attributes of ONE shape and it's sub-shapes - + -- attributes of ONE shape and it's sub-shapes. + -- Attribute containing DimTol section of DECAF document. + -- Provide tools for management of DimTol section of document. uses Shape from TopoDS, Label from TDF, diff --git a/src/XCAFDoc/XCAFDoc_DocumentTool.cdl b/src/XCAFDoc/XCAFDoc_DocumentTool.cdl index 98d8d1d0fb..4e3c7a0651 100644 --- a/src/XCAFDoc/XCAFDoc_DocumentTool.cdl +++ b/src/XCAFDoc/XCAFDoc_DocumentTool.cdl @@ -16,7 +16,8 @@ class DocumentTool from XCAFDoc inherits Attribute from TDF ---Purpose: Defines sections structure of an XDE document. - + -- attribute marking CAF document as being DECAF document. + -- Creates the sections structure of the document. uses Label from TDF, Document from TDocStd, diff --git a/src/XCAFDoc/XCAFDoc_GraphNode.cdl b/src/XCAFDoc/XCAFDoc_GraphNode.cdl index a77b5c12f9..74bb55405b 100644 --- a/src/XCAFDoc/XCAFDoc_GraphNode.cdl +++ b/src/XCAFDoc/XCAFDoc_GraphNode.cdl @@ -16,7 +16,9 @@ class GraphNode from XCAFDoc inherits Attribute from TDF ---Purpose: This attribute allow user multirelation tree of labels. - -- This GraphNode is experimental Graph that not control looping and redundance. + -- This GraphNode is experimental Graph that not control looping and redundance. + -- Attribute containg sequence of father's and child's labels. + -- Provide create and work with Graph in XCAFDocument. uses GUID from Standard, diff --git a/src/XCAFDoc/XCAFDoc_LayerTool.cdl b/src/XCAFDoc/XCAFDoc_LayerTool.cdl index 59743484cf..5bffac7092 100644 --- a/src/XCAFDoc/XCAFDoc_LayerTool.cdl +++ b/src/XCAFDoc/XCAFDoc_LayerTool.cdl @@ -19,7 +19,7 @@ class LayerTool from XCAFDoc inherits Attribute from TDF -- of TopoDS_Shape in and from TDocStd_Document -- A Document is intended to hold different -- attributes of ONE shape and it's sub-shapes - + -- Provide tools for management of Layers section of document. uses Shape from TopoDS, Label from TDF, diff --git a/src/XCAFDoc/XCAFDoc_Location.cdl b/src/XCAFDoc/XCAFDoc_Location.cdl index d879827639..2dda7d5228 100644 --- a/src/XCAFDoc/XCAFDoc_Location.cdl +++ b/src/XCAFDoc/XCAFDoc_Location.cdl @@ -15,7 +15,7 @@ class Location from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store TopLoc_Location uses Location from TopLoc, diff --git a/src/XCAFDoc/XCAFDoc_Material.cdl b/src/XCAFDoc/XCAFDoc_Material.cdl index 414cbfa161..b92f5d5880 100644 --- a/src/XCAFDoc/XCAFDoc_Material.cdl +++ b/src/XCAFDoc/XCAFDoc_Material.cdl @@ -14,6 +14,8 @@ -- commercial license or contractual agreement. class Material from XCAFDoc inherits Attribute from TDF + ---Purpose: attribute to store material + uses Label from TDF, RelocationTable from TDF, diff --git a/src/XCAFDoc/XCAFDoc_MaterialTool.cdl b/src/XCAFDoc/XCAFDoc_MaterialTool.cdl index 6ba7960687..53326096b6 100644 --- a/src/XCAFDoc/XCAFDoc_MaterialTool.cdl +++ b/src/XCAFDoc/XCAFDoc_MaterialTool.cdl @@ -19,6 +19,7 @@ class MaterialTool from XCAFDoc inherits Attribute from TDF -- of TopoDS_Shape in and from TDocStd_Document -- A Document is intended to hold different -- attributes of ONE shape and it's sub-shapes + -- Provide tools for management of Materialss section of document. uses Shape from TopoDS, diff --git a/src/XCAFDoc/XCAFDoc_ShapeMapTool.cdl b/src/XCAFDoc/XCAFDoc_ShapeMapTool.cdl index c8bbd9172b..8d2ea9f1ef 100644 --- a/src/XCAFDoc/XCAFDoc_ShapeMapTool.cdl +++ b/src/XCAFDoc/XCAFDoc_ShapeMapTool.cdl @@ -14,6 +14,7 @@ -- commercial license or contractual agreement. class ShapeMapTool from XCAFDoc inherits Attribute from TDF + ---Purpose: attribute containing map of sub shapes uses diff --git a/src/XCAFDoc/XCAFDoc_ShapeTool.cdl b/src/XCAFDoc/XCAFDoc_ShapeTool.cdl index 9faa64c7cf..6db5d84335 100644 --- a/src/XCAFDoc/XCAFDoc_ShapeTool.cdl +++ b/src/XCAFDoc/XCAFDoc_ShapeTool.cdl @@ -17,6 +17,8 @@ class ShapeTool from XCAFDoc inherits Attribute from TDF ---Purpose: A tool to store shapes in an XDE -- document in the form of assembly structure, and to maintain this structure. +-- Attribute containing Shapes section of DECAF document. +-- Provide tools for management of Shapes section. -- The API provided by this class allows to work with this -- structure regardless of its low-level implementation. -- All the shapes are stored on child labels of a main label which is diff --git a/src/XCAFDoc/XCAFDoc_Volume.cdl b/src/XCAFDoc/XCAFDoc_Volume.cdl index 2f7e0d1538..73dcd24cfc 100644 --- a/src/XCAFDoc/XCAFDoc_Volume.cdl +++ b/src/XCAFDoc/XCAFDoc_Volume.cdl @@ -15,7 +15,7 @@ class Volume from XCAFDoc inherits Attribute from TDF - ---Purpose: + ---Purpose: attribute to store volume uses Attribute from TDF, diff --git a/src/XCAFPrs/XCAFPrs.cdl b/src/XCAFPrs/XCAFPrs.cdl index 277de02a30..5871cfd0be 100644 --- a/src/XCAFPrs/XCAFPrs.cdl +++ b/src/XCAFPrs/XCAFPrs.cdl @@ -36,13 +36,10 @@ uses is class Driver; - ---Purpose: Implements a presentation driver for DECAF class AISObject; - ---Purpose: Implements an interactive object for DECAF class Style; - ---Purpose: Object representing a set of style settings class DataMapOfShapeStyle instantiates DataMap from TCollection(Shape from TopoDS, diff --git a/src/XDEDRAW/XDEDRAW.cdl b/src/XDEDRAW/XDEDRAW.cdl index 9575139200..066ec710ac 100644 --- a/src/XDEDRAW/XDEDRAW.cdl +++ b/src/XDEDRAW/XDEDRAW.cdl @@ -23,17 +23,13 @@ uses is class Shapes; - ---Purpose: Provides functions for work with shapes and assemblies class Colors; - ---Purpose: Provides functions for work with colors class Layers; - ---Purpose: Provides functions for work with layers class Props; - ---Purpose: Provides functions for work with geometric properties - + class Common; ---Purpose: Provides common commands for work XDE diff --git a/src/XDEDRAW/XDEDRAW_Shapes.cdl b/src/XDEDRAW/XDEDRAW_Shapes.cdl index 2295a050ba..c25d7b1491 100644 --- a/src/XDEDRAW/XDEDRAW_Shapes.cdl +++ b/src/XDEDRAW/XDEDRAW_Shapes.cdl @@ -15,7 +15,7 @@ class Shapes from XDEDRAW - ---Purpose: Contains commands to work with shapes + ---Purpose: Contains commands to work with shapes and assemblies uses Interpretor from Draw diff --git a/src/XSAlgo/XSAlgo.cdl b/src/XSAlgo/XSAlgo.cdl index dcc7bad66a..34c79d3e3c 100644 --- a/src/XSAlgo/XSAlgo.cdl +++ b/src/XSAlgo/XSAlgo.cdl @@ -39,7 +39,6 @@ is end Caller; class ToolContainer; - ---Purpose: Returns tools used by AlgoContainer class AlgoContainer; ---Purpose: Provides initerface to the algorithms from Shape Healing diff --git a/src/XSAlgo/XSAlgo_ToolContainer.cdl b/src/XSAlgo/XSAlgo_ToolContainer.cdl index e5171726ce..069bb2e065 100644 --- a/src/XSAlgo/XSAlgo_ToolContainer.cdl +++ b/src/XSAlgo/XSAlgo_ToolContainer.cdl @@ -15,7 +15,7 @@ class ToolContainer from XSAlgo inherits TShared from MMgt - ---Purpose: + ---Purpose: Returns tools used by AlgoContainer is Create returns ToolContainer from XSAlgo; diff --git a/src/XSDRAW/XSDRAW.cdl b/src/XSDRAW/XSDRAW.cdl index a9631fdec4..845c0c7311 100644 --- a/src/XSDRAW/XSDRAW.cdl +++ b/src/XSDRAW/XSDRAW.cdl @@ -30,11 +30,6 @@ uses TCollection, TColStd, TopTools, is class Functions; - ---Purpose : Gathers general commands for XSDRAW : initialisation control, - -- also commands to analyse the result of a transfer - -- (it is an appendix made of user callable functions) - -- - -- Loaded by LoadDraw class Vars; ---Purpose : Takes variables to/from the DRAW session diff --git a/src/XmlMDF/XmlMDF.cdl b/src/XmlMDF/XmlMDF.cdl index 5a171dc61e..940f81277b 100644 --- a/src/XmlMDF/XmlMDF.cdl +++ b/src/XmlMDF/XmlMDF.cdl @@ -50,7 +50,7 @@ is ADriver from XmlMDF, AsciiString from TCollection); - ---Purpose: Storage and Retrieval attributes drivers + ---Category: Storage and Retrieval attributes drivers -- ======================================== class TagSourceDriver; diff --git a/src/XmlMDataStd/XmlMDataStd.cdl b/src/XmlMDataStd/XmlMDataStd.cdl index 6644cd0fcb..d8dd1fa472 100644 --- a/src/XmlMDataStd/XmlMDataStd.cdl +++ b/src/XmlMDataStd/XmlMDataStd.cdl @@ -22,7 +22,7 @@ uses XmlMDF, CDM is - ---Purpose: Storage/Retrieval drivers for TDataStd attributes + ---Category: Storage/Retrieval drivers for TDataStd attributes -- ======================================= class NameDriver; diff --git a/src/XmlMDataXtd/XmlMDataXtd.cdl b/src/XmlMDataXtd/XmlMDataXtd.cdl index 2e81457021..c99ba2d3d3 100644 --- a/src/XmlMDataXtd/XmlMDataXtd.cdl +++ b/src/XmlMDataXtd/XmlMDataXtd.cdl @@ -22,7 +22,7 @@ uses XmlMDF, CDM is - ---Purpose: Storage/Retrieval drivers for TDataXtd attributes + ---Category: Storage/Retrieval drivers for TDataXtd attributes -- ======================================= class AxisDriver; diff --git a/src/XmlObjMgt/XmlObjMgt.cdl b/src/XmlObjMgt/XmlObjMgt.cdl index d2b3997b97..2cdfb5f0bf 100644 --- a/src/XmlObjMgt/XmlObjMgt.cdl +++ b/src/XmlObjMgt/XmlObjMgt.cdl @@ -26,10 +26,8 @@ uses is class Persistent; - ---Purpose: root for XML-persistence class GP; - ---Purpose: translation of gp objects imported DOMString; imported Document; diff --git a/src/XmlObjMgt/XmlObjMgt_Persistent.cdl b/src/XmlObjMgt/XmlObjMgt_Persistent.cdl index 960b50fe89..35fe21f2bf 100644 --- a/src/XmlObjMgt/XmlObjMgt_Persistent.cdl +++ b/src/XmlObjMgt/XmlObjMgt_Persistent.cdl @@ -14,6 +14,7 @@ -- commercial license or contractual agreement. class Persistent from XmlObjMgt + ---Purpose: root for XML-persistence uses Element from XmlObjMgt, diff --git a/src/gce/gce.cdl b/src/gce/gce.cdl index 1bb02a2c93..d18976cc0a 100644 --- a/src/gce/gce.cdl +++ b/src/gce/gce.cdl @@ -51,124 +51,73 @@ enumeration ErrorType is Done, ConfusedPoints, NegativeRadius, ColinearPoints, private deferred class Root; - ---Purpose: Root of classes with error report. class MakeDir2d; - ---Purpose: Makes a dir2d from gp. class MakeLin2d; - ---Purpose: Makes a Lin2d from gp. class MakeCirc2d; - ---Purpose: Makes a Circ2d from gp. class MakeHypr2d; - ---Purpose: Makes an hypr2d from gp. class MakeElips2d; - ---Purpose: Makes an Elips2d from gp. class MakeParab2d; - ---Purpose: Makes a parab2d from gp. --------------------------------------------------------------------------- - ---Purpose : Constructions of Trsf2d from gp. + --- Constructions of Trsf2d from gp. --------------------------------------------------------------------------- class MakeTranslation2d; - ---Purpose: Returns a translation transformation. class MakeMirror2d; - ---Purpose: Returns a symmetry transformation. class MakeRotation2d; - ---Purpose: Returns a rotation transformation. class MakeScale2d; - ---Purpose: Returns a scaling transformation. --------------------------------------------------------------------------- - ---Purpose: scalar product. ---------------------------------------------------------------------------- - ---class MakeDot; - ---Purpose: Makes a scalar product between the two vectors P1P2 and P3P4. - ---------------------------------------------------------------------------- - ---Purpose: vector product. ---------------------------------------------------------------------------- - ---class MakeCross2d; - ---Purpose: Makes a Cross between the two vectors P1P2 and P1P3. - ---class MakeDotCross; - ---Purpose: Makes the triple scalar product P1P2 * (P3P4 ^ P5P6). - ---------------------------------------------------------------------------- - ---Purpose : Constructions of 3d geometrical elements from gp. + --- Constructions of 3d geometrical elements from gp. --------------------------------------------------------------------------- class MakeDir; - ---Purpose: Makes a dir from gp. class MakeLin; - ---Purpose: Makes a Line from gp. class MakeCirc; - ---Purpose: Makes a Circle from gp. class MakeHypr; - ---Purpose: Makes an hyperbola from gp. class MakeElips; - ---Purpose: Makes an ellipse from gp. class MakeParab; - ---Purpose: Makes a parabola

from gp. --------------------------------------------------------------------------- - ---Purpose : Constructions of planes from gp. + --- Constructions of planes from gp. --------------------------------------------------------------------------- class MakePln; - ---Purpose: Makes a plane from gp. --------------------------------------------------------------------------- - ---Purpose: Construction of surfaces from gp. + --- Construction of surfaces from gp. --------------------------------------------------------------------------- class MakeCylinder; - ---Purpose: Makes a cylinder from gp. class MakeCone; - ---Purpose: Makes a cone from gp. --------------------------------------------------------------------------- - ---Purpose : Constructions of Trsf from gp. + --- Constructions of Trsf from gp. --------------------------------------------------------------------------- class MakeTranslation; - ---Purpose: returns a translation transformation. class MakeMirror; - ---Purpose: returns a symmetry transformation. class MakeRotation; - ---Purpose: returns a rotation transformation. class MakeScale; - ---Purpose: returns a scaling transformation. ---------------------------------------------------------------------------- - ---Purpose: vector product. ---------------------------------------------------------------------------- - ---class MakeCross; - ---Purpose: Makes a Cross product between the two vectors P1P2 and P1P3. - ---class MakeDotCross; - ---Purpose: Makes the triple scalar product P1P2 * (P3P4 ^ P5P6). - end gce; diff --git a/src/gce/gce_MakePln.cdl b/src/gce/gce_MakePln.cdl index c9bc6a6091..e2271037b2 100644 --- a/src/gce/gce_MakePln.cdl +++ b/src/gce/gce_MakePln.cdl @@ -17,7 +17,7 @@ class MakePln from gce inherits Root from gce ---Purpose : This class implements the following algorithms used - -- to create a Pln from gp. + -- to create a Plane from gp. -- * Create a Pln parallel to another and passing -- through a point. -- * Create a Pln passing through 3 points. diff --git a/src/gp/gp.cdl b/src/gp/gp.cdl index 634c5e3ca7..73fe69dd84 100644 --- a/src/gp/gp.cdl +++ b/src/gp/gp.cdl @@ -33,10 +33,11 @@ is exception VectorWithNullMagnitude inherits DomainError; - ---Purpose: Identifies the type of a geometric transformation. enumeration TrsfForm is Identity, Rotation, Translation, PntMirror, Ax1Mirror, Ax2Mirror, Scale, - CompoundTrsf, Other; + CompoundTrsf, Other + end TrsfForm; + ---Purpose: Identifies the type of a geometric transformation. ---Purpose: Enumerates all 24 possible variants of generalized -- Euler angles, defining general 3d rotation by three @@ -88,126 +89,74 @@ is ; class XYZ; - --- Purpose : 3D Cartesian Coordinates {X, Y, Z} class Mat; - --- Purpose : Matrix 3*3 class Quaternion; - --- Purpose : Quaternion representing 3d rotation class Trsf; - --- Purpose : - -- Elementary geometric transformation. This transformation never - -- change the nature of the objects. class GTrsf; - --- Purpose : - -- General transformation. A GTrsf can be used only to transform - -- a point or a triplet of coordinates. class Pnt; - --- Purpose : Cartesian Point. class Vec; - --- Purpose : Vector. class Dir; - --- Purpose : Direction, it is an unitary vector. class Ax1; - --- Purpose : axis placement (Coordinate system -one axis) class Ax2; - --- Purpose : axis placement (Direct Coordinate system two - -- axis) class Ax3; - --- Purpose : axis placement (Coordinate system two axis, can - -- be direct or indirect) class Lin; - --- Purpose : Line. class Circ; - --- Purpose : Circle. class Elips; - --- Purpose : Ellipse. class Hypr; - --- Purpose : Hyperbola. class Parab; - --- Purpose : Parabola. class Pln; - --- Purpose : Plane. class Cylinder; - --- Purpose : Infinite cylindrical surface . class Sphere; - --- Purpose : Spherical surface. class Torus; - --- Purpose : Toroidal surface. class Cone; - --- Purpose : Conical surface. - - - - - --- Purpose : Geometric entities for 2D. - - class XY; - --- Purpose : 2D cartesian Coordinates {X, Y} class Mat2d; - --- Purpose : Matrix 2*2 class Trsf2d; - --- Purpose : - -- Elementary geometric transformation. This transformation never - -- change the nature of the objects. class GTrsf2d; - --- Purpose : - -- General transformation. A GTrsf can be used only to transform - -- a point or a triplet of coordinates. class Pnt2d; - --- Purpose : Cartesian point. class Vec2d; - --- Purpose : Vector. class Dir2d; - --- Purpose : Direction, it is an unitary vector. class Ax2d; - --- Purpose : axis placement (Coordinate system - one axis) class Ax22d; - --- Purpose : axis placement (Coordinate system - two axis) class Lin2d; - --- Purpose : Line. class Circ2d; - --- Purpose : Circle. class Elips2d; - --- Purpose : Ellipse. class Hypr2d; - --- Purpose : Hyperbola. class Parab2d; - --- Purpose : Parabola. diff --git a/src/gp/gp_Trsf.cdl b/src/gp/gp_Trsf.cdl index 506f3be3d2..2ebff2d577 100644 --- a/src/gp/gp_Trsf.cdl +++ b/src/gp/gp_Trsf.cdl @@ -32,7 +32,7 @@ class Trsf from gp inherits Storable -- where {V1, V2, V3} defines the vectorial part of the -- transformation and T defines the translation part of the -- transformation. - + -- This transformation never change the nature of the objects. uses Ax1 from gp, diff --git a/src/gp/gp_Trsf2d.cdl b/src/gp/gp_Trsf2d.cdl index a98a0d436c..474f82e538 100644 --- a/src/gp/gp_Trsf2d.cdl +++ b/src/gp/gp_Trsf2d.cdl @@ -30,7 +30,7 @@ class Trsf2d from gp inherits Storable -- -- where {V1, V2} defines the vectorial part of the transformation -- and T defines the translation part of the transformation. - + -- This transformation never change the nature of the objects. uses Ax2d from gp, Mat2d from gp,