1 -- Created on: 1993-07-28
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1993-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 class Functions from IFSelect
19 ---Purpose : Functions gives access to all the actions which can be
20 -- commanded with the resources provided by IFSelect : especially
21 -- WorkSession and various types of Selections and Dispatches
23 -- It works by adding functions by method Init
25 uses CString, HSequenceOfTransient from TColStd,
26 WorkSession from IFSelect , Dispatch from IFSelect
30 GiveEntity (myclass; WS : WorkSession; name : CString = "")
32 ---Purpose : Takes the name of an entity, either as argument, or (if <name>
33 -- is empty) on keybord, and returns the entity
34 -- name can be a label or a number (in alphanumeric), it is
35 -- searched by NumberFromLabel from WorkSession.
36 -- If <name> doesn't match en entity, a Null Handle is returned
38 GiveEntityNumber (myclass; WS : WorkSession; name : CString = "")
40 ---Purpose : Same as GetEntity, but returns the number in the model of the
41 -- entity. Returns 0 for null handle
43 GiveList (myclass; WS : WorkSession; first, second : CString = "")
44 returns HSequenceOfTransient;
45 ---Purpose : Computes a List of entities from a WorkSession and two idents,
46 -- first and second, as follows :
47 -- if <first> is a Number or Label of an entity : this entity
48 -- if <first> is the name of a Selection in <WS>, and <second>
49 -- not defined, the standard result of this Selection
50 -- if <first> is for a Selection and <second> is defined, the
51 -- standard result of this selection from the list computed
52 -- with <second> (an entity or a selection)
53 -- If <second> is erroneous, it is ignored
55 GiveDispatch (myclass; WS : WorkSession; name : CString;
56 mode : Boolean = Standard_True)
57 returns Dispatch from IFSelect;
58 ---Purpose : Evaluates and returns a Dispatch, from data of a WorkSession
59 -- if <mode> is False, searches for exact name of Dispatch in WS
60 -- Else (D), allows a parameter between brackets :
61 -- ex.: dispatch_name(parameter)
62 -- The parameter can be: an integer for DispPerCount or DispPerFiles
63 -- or the name of a Signature for DispPerSignature
64 -- Returns Null Handle if not found not well evaluated
67 ---Purpose : Defines and loads all basic functions (as ActFunc)