1 -- Created on: 1994-04-26
2 -- Created by: Jean Yves LEBEY
3 -- Copyright (c) 1994-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
6 -- This file is part of Open CASCADE Technology software library.
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
17 package TestTopOpeTools
21 -- Provide Trace control on packages involved in
22 -- topological operations kernel, from Draw command interpretor.
24 -- They may be used by users of topological operation kernel, such as :
26 -- * topological operation performer,
27 -- * hidden line removal performer,
28 -- * fillet, chamfer performer
30 -- Trace control consists in management of
31 -- control functions, activating/desactivating execution of
32 -- instructions considered as purely PASSIVE code,
33 -- performing dumps, prints, and drawing of internal objects
34 -- dealed by some topological operation packages.
36 -- All of the Trace controls in top.ope. kernel
37 -- are enclosed by the C conditional compilation statements :
38 -- #ifdef OCCT_DEBUG ... #endif
40 -- The "Traced" packages of topological operation kernel are :
45 -- How to use the Trace :
46 -- ----------------------
48 -- In a Test.cxx program using the Draw command interpretor, dealing
49 -- a set of commands theCommands (Draw_CommandManager theCommands) :
51 -- TestTopOpeTools::TraceCommands();
53 -- Compile your Test.cxx, run and then, under the command manager prompt :
55 -- Trace : prints the list of the Trace flags available on top.ope. kernel
56 -- Trace <flag> : activates Trace code of <flag>
57 -- Trace <flag> <1 | 0> : activates/desactivates Trace code of <flag>
58 -- Trace <1 | 0> : activates/desactivates all Trace code of top.ope. kernel
60 -- How to add Traces :
61 -- -------------------
63 -- It it possible to add your own "Traced" portions of code in your code.
64 -- In your test program, simply add :
66 -- #include <TestTopOpeTools_AddTrace.hxx>
68 -- and see the file TestTopOpeTools_Trace.hxx for explanations.
90 pointer PMesure to Mesure from TestTopOpeTools;
91 class Array1OfMesure instantiates Array1 from TCollection
92 (Mesure from TestTopOpeTools);
94 class HArray1OfMesure instantiates HArray1 from TCollection
95 (Mesure from TestTopOpeTools, Array1OfMesure from TestTopOpeTools);
97 AllCommands(I : in out Interpretor from Draw);
98 ---Purpose: Defines all topological operation test commands
101 TraceCommands(I : in out Interpretor from Draw);
102 ---Purpose: Defines the dump commands on
103 -- topological operation packages.
105 OtherCommands(I : in out Interpretor from Draw);
106 ---Purpose: Defines auxiliary commands