0024624: Lost word in license statement in source files
[occt.git] / src / ShapeExtend / ShapeExtend_MsgRegistrator.cdl
1 -- Created on: 2000-01-28
2 -- Created by: data exchange team
3 -- Copyright (c) 2000-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class MsgRegistrator from ShapeExtend inherits BasicMsgRegistrator from ShapeExtend
17
18     ---Purpose: Attaches messages to the objects (generic Transient or shape).
19     --          The objects of this class are transmitted to the Shape Healing
20     --          algorithms so that they could collect messages occurred during
21     --          processing.
22     --
23     --          Messages are added to the Maps (stored as a field) that can be
24     --          used, for instance, by Data Exchange processors to attach those
25     --          messages to initial file entities.
26
27 uses
28
29     Shape                       from TopoDS,
30     Gravity                     from Message,
31     Msg                         from Message,
32     ListOfMsg                   from Message,
33     DataMapOfTransientListOfMsg from ShapeExtend,
34     DataMapOfShapeListOfMsg     from ShapeExtend
35
36 is
37
38     Create returns mutable MsgRegistrator from ShapeExtend;
39         ---Purpose: Creates an object.
40         
41     
42     Send (me: mutable; object : Transient;
43                        message: Msg from Message;
44                        gravity: Gravity from Message) is redefined;
45         ---Purpose: Sends a message to be attached to the object.
46         --          If the object is in the map then the message is added to the
47         --          list, otherwise the object is firstly added to the map.
48
49     Send (me: mutable; shape  : Shape from TopoDS;
50                        message: Msg from Message;
51                        gravity: Gravity from Message) is redefined;
52         ---Purpose: Sends a message to be attached to the shape.
53         --          If the shape is in the map then the message is added to the
54         --          list, otherwise the shape is firstly added to the map.
55
56     MapTransient (me) returns DataMapOfTransientListOfMsg from ShapeExtend;
57         ---C++    : inline
58         ---C++    : return const&
59         ---Purpose: Returns a Map of objects and message list
60         
61     MapShape (me) returns DataMapOfShapeListOfMsg from ShapeExtend;
62         ---C++    : inline
63         ---C++    : return const&
64         ---Purpose: Returns a Map of shapes and message list
65
66 fields
67
68     myMapTransient: DataMapOfTransientListOfMsg from ShapeExtend;
69     myMapShape: DataMapOfShapeListOfMsg from ShapeExtend;
70     
71 end MsgRegistrator;