Test for 0022778: Bug in BRepMesh
[occt.git] / src / XSControl / XSControl_SelectForTransfer.cdl
CommitLineData
b311480e 1-- Created on: 1996-03-26
2-- Created by: Christian CAILLET
3-- Copyright (c) 1996-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
7fd59977 21
22
23class SelectForTransfer from XSControl inherits SelectExtract from IFSelect
24
25 ---Purpose : This selection selects the entities which are recognised for
26 -- transfer by an Actor for Read : current one or another one.
27 --
28 -- An Actor is an operator which runs transfers from interface
29 -- entities to objects for Imagine. It has a method to recognize
30 -- the entities it can process (by default, it recognises all,
31 -- this method can be redefined).
32 --
33 -- A TransferReader brings an Actor, according to the currently
34 -- selected norm and transfer conditions.
35 --
36 -- This selection considers, either the current Actor (brought by
37 -- the TransferReader, updated as required), or a precise one.
38
39uses AsciiString from TCollection, InterfaceModel,
40 ActorOfTransientProcess, TransferReader
41
42is
43
44 Create returns mutable SelectForTransfer;
45 ---Purpose : Creates a SelectForTransfer, non initialised
46 -- it sorts nothing, unless an Actor has been defined
47
48 Create (TR : TransferReader) returns mutable SelectForTransfer;
49 ---Purpose : Creates a SelectForTransfer, which will work with the
50 -- currently defined Actor brought by the TransferReader
51
52 SetReader (me : mutable; TR : TransferReader);
53 ---Purpose : Sets a TransferReader to sort entities : it brings the Actor,
54 -- which may change, while the TransferReader does not
55
56 SetActor (me : mutable; act : mutable ActorOfTransientProcess);
57 ---Purpose : Sets a precise actor to sort entities
58 -- This definition oversedes the creation with a TransferReader
59
60 Actor (me) returns ActorOfTransientProcess;
61 ---Purpose : Returns the Actor used as precised one.
62 -- Returns a Null Handle for a creation from a TransferReader
63 -- without any further setting
64
65 Reader (me) returns TransferReader;
66 ---Purpose : Returns the Reader (if created with a Reader)
67 -- Returns a Null Handle if not created with a Reader
68
69
70 Sort (me; rank : Integer; ent : Transient; model : InterfaceModel)
71 returns Boolean;
72 ---Purpose : Returns True for an Entity which is recognized by the Actor,
73 -- either the precised one, or the one defined by TransferReader
74
75 --Sort (me; ent : in out Transient) returns Boolean;
76
77 ExtractLabel (me) returns AsciiString from TCollection;
78 ---Purpose : Returns a text defining the criterium : "Recognized for Transfer [(current actor)]"
79
80fields
81
82 theTR : TransferReader;
83 theAC : ActorOfTransientProcess;
84
85end SelectForTransfer;