blob: 169be7d6b649561d0a762f511f82b79633253bca (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
-- File: Message_Messenger.cdl
-- Created: Thu Jun 28 15:49:01 2007
-- Author: OCC Team
---Copyright: Open CASCADE S.A. 2007
class Messenger from Message inherits TShared from MMgt
---Purpose: Messenger is API class providing general-purpose interface for
-- libraries that may issue text messages without knowledge
-- of how these messages will be further processed.
--
-- The messenger contains a sequence of "printers" which can be
-- customized by the application, and dispatches every received
-- message to all the printers.
--
-- For convenience, a number of operators << are defined with left
-- argument being Handle(Message_Messenger); thus it can be used
-- with syntax similar to C++ streams.
-- Note that all these operators use trace level Warning.
uses
Printer from Message,
PrinterOStream from Message,
SequenceOfPrinters from Message,
Gravity from Message,
AsciiString from TCollection,
ExtendedString from TCollection
is
Create returns Messenger from Message;
---Purpose: Empty constructor; initializes by single printer directed to cout.
-- Note: the default messenger is not empty but directed to cout
-- in order to protect against possibility to forget defining printers.
-- If printing to cout is not needed, clear messenger by GetPrinters().Clear()
Create (thePrinter: Printer from Message)
returns Messenger from Message;
---Purpose: Create messenger with single printer
AddPrinter (me: mutable; thePrinter: Printer from Message)
returns Boolean from Standard;
---Purpose: Add a printer to the messenger.
-- The printer will be added only if it is not yet in the list.
-- Returns True if printer has been added.
RemovePrinter (me: mutable; thePrinter: Printer from Message)
returns Boolean from Standard;
---Purpose: Removes specified printer from the messenger.
-- Returns True if this printer has been found in the list
-- and removed.
RemovePrinters (me: mutable; theType: Type from Standard)
returns Integer from Standard;
---Purpose: Removes printers of specified type (including derived classes)
-- from the messenger.
-- Returns number of removed printers.
Printers(me)
returns SequenceOfPrinters from Message;
---C++: inline
---C++: return const &
---Purpose: Returns current sequence of printers
ChangePrinters(me: mutable)
returns SequenceOfPrinters from Message;
---C++: inline
---C++: return &
---Purpose: Returns sequence of printers
-- The sequence can be modified.
Send (me; theString : CString from Standard;
theGravity: Gravity from Message = Message_Warning;
putEndl: Boolean from Standard = Standard_True);
---Purpose: Dispatch a message to all the printers in the list.
-- Three versions of string representations are accepted for
-- convenience, by default all are converted to ExtendedString.
-- The parameter putEndl specifies whether the new line should
-- be started after this message (default) or not (may have
-- sense in some conditions).
Send (me; theString : AsciiString from TCollection;
theGravity: Gravity from Message = Message_Warning;
putEndl: Boolean from Standard = Standard_True);
---Purpose: See above
Send (me; theString : ExtendedString from TCollection;
theGravity: Gravity from Message = Message_Warning;
putEndl: Boolean from Standard = Standard_True);
---Purpose: See above
fields
myPrinters: SequenceOfPrinters from Message;
end Messenger;
|
