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-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class FuncShape  from XSControl
  18
  19     ---Purpose : Defines additionnal commands for XSControl to :
  20     --           - control of initialisation (xinit, xnorm, newmodel)
  21     --           - analyse of the result of a transfer (recorded in a
  22     --             TransientProcess for Read, FinderProcess for Write) :
  23     --             statistics, various lists (roots,complete,abnormal), what
  24     --             about one specific entity, producing a model with the
  25     --             abnormal result
  26     --
  27     --           This appendix of XSControl is compiled separately to distinguish
  28     --           basic features from user callable forms
  29
  30 uses CString, AsciiString from TCollection,
  31      WorkSession from XSControl, HSequenceOfShape from TopTools
  32
  33 is
  34
  35     Init (myclass);
  36     ---Purpose : Defines and loads all functions which work on shapes for XSControl (as ActFunc)
  37
  38     MoreShapes (myclass; session : WorkSession from XSControl;
  39                 list : in out HSequenceOfShape from TopTools;
  40                 name : CString) returns Integer;
  41     ---Purpose : Analyses a name as designating Shapes from a Vars or from
  42     --           XSTEP transfer (last Transfer on Reading). <name> can be :
  43     --           "*" : all the root shapes produced by last Transfer (Read)
  44     --                 i.e. considers roots of the TransientProcess
  45     --           a name : a name of a variable DRAW
  46     --
  47     --           Returns the count of designated Shapes. Their list is put in
  48     --           <list>. If <list> is null, it is firstly created. Then it is
  49     --           completed (Append without Clear) by the Shapes found
  50     --           Returns 0 if no Shape could be found
  51
  52     FileAndVar (myclass; session : WorkSession from XSControl;
  53                 file, var, def : CString;
  54                  resfile, resvar : out AsciiString from TCollection)
  55         returns Boolean;
  56     ---Purpose : Analyses given file name and variable name, with a default
  57     --           name for variables. Returns resulting file name and variable
  58     --           name plus status "file to read"(True) or "already read"(False)
  59     --           In the latter case, empty resfile means no file available
  60     --
  61     --           If <file> is null or empty or equates ".", considers Session
  62     --             and returned status is False
  63     --           Else, returns resfile = file and status is True
  64     --           If <var> is neither null nor empty, resvar = var
  65     --           Else, the root part of <resfile> is considered, if defined
  66     --           Else, <def> is taken
  67
  68
  69 end FuncShape;