Test for 0022778: Bug in BRepMesh
[occt.git] / src / XSControl / XSControl_FuncShape.cdl
1 -- Created on: 1995-03-16
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1995-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23 class FuncShape  from XSControl
24
25     ---Purpose : Defines additionnal commands for XSControl to :
26     --           - control of initialisation (xinit, xnorm, newmodel)
27     --           - analyse of the result of a transfer (recorded in a
28     --             TransientProcess for Read, FinderProcess for Write) :
29     --             statistics, various lists (roots,complete,abnormal), what
30     --             about one specific entity, producing a model with the
31     --             abnormal result
32     --             
33     --           This appendix of XSControl is compiled separately to distinguish
34     --           basic features from user callable forms
35
36 uses CString, AsciiString from TCollection,
37      WorkSession from XSControl, HSequenceOfShape from TopTools
38
39 is
40
41     Init (myclass);
42     ---Purpose : Defines and loads all functions which work on shapes for XSControl (as ActFunc)
43
44     MoreShapes (myclass; session : WorkSession from XSControl;
45                 list : in out mutable HSequenceOfShape from TopTools;
46                 name : CString) returns Integer;
47     ---Purpose : Analyses a name as designating Shapes from a Vars or from
48     --           XSTEP transfer (last Transfer on Reading). <name> can be :
49     --           "*" : all the root shapes produced by last Transfer (Read)
50     --                 i.e. considers roots of the TransientProcess
51     --           a name : a name of a variable DRAW
52     --           
53     --           Returns the count of designated Shapes. Their list is put in
54     --           <list>. If <list> is null, it is firstly created. Then it is
55     --           completed (Append without Clear) by the Shapes found
56     --           Returns 0 if no Shape could be found
57
58     FileAndVar (myclass; session : WorkSession from XSControl;
59                 file, var, def : CString;
60                  resfile, resvar : out AsciiString from TCollection)
61         returns Boolean;
62     ---Purpose : Analyses given file name and variable name, with a default
63     --           name for variables. Returns resulting file name and variable
64     --           name plus status "file to read"(True) or "already read"(False)
65     --           In the latter case, empty resfile means no file available
66     --           
67     --           If <file> is null or empty or equates ".", considers Session
68     --             and returned status is False
69     --           Else, returns resfile = file and status is True
70     --           If <var> is neither null nor empty, resvar = var
71     --           Else, the root part of <resfile> is considered, if defined
72     --           Else, <def> is taken
73
74
75 end FuncShape;