ViewVC Help

View File | Revision Log | Show Annotations | Root Listing

root/cvsroot/COMP/SCRAM/src/Utilities/Message.pm

Comparing COMP/SCRAM/src/Utilities/Message.pm (file contents):
Revision 1.2 by williamc, Wed Jan 5 15:45:48 2000 UTC vs.
Revision 1.3 by sashby, Wed Aug 10 17:27:32 2005 UTC

#	Line 1 | Line 1
1	<	#
2	<	# Message.pm
3	<	#
4	<	# Originally Written by Christopher Williams
5	<	#
6	<	# Description
7	<	# -----------
8	<	# Hold a multi level message that can be reconstructed to any level
9	<	#
10	<	# Interface
11	<	# ---------
12	<	# new()         : A new Message object
13	<	# setlevel([level_number]) : set the current level to which messages can
14	<	#                            be assigned.
15	<	# message(string)   : Set a new message at the current level
16	<	# read([level])     : return list of all messages up to level n (or
17	<	#                     current assignment level)
18	<	# readlevel(level)  : read only those messages assigned to the given
19	<	#                       level
20	<	# copy(Message)     : Copy the messages from one object to the current
21	<	#                       starting at the current active level
22	<	# levels()          : return the number of assignment levels
1	>	=head1 NAME
2	>
3	>	Utilities::Message - Hold a multi level message that can be reconstructed to any level.
4	>
5	>	=head1 SYNOPSIS
6	>
7	>	my $obj = Utilities::Message->new();
8	>
9	>	=head1 DESCRIPTION
10	>
11	>	Hold a multi level message that can be reconstructed to any level.
12	>
13	>	=head1 METHODS
14	>
15	>	=over
16	>
17	>	=cut
18	>
19	>	=item C<new()>
20	>
21	>	A new Message object.
22	>
23	>	=item C<setlevel([level_number])>
24	>
25	>	Set the current level to which messages can be assigned.
26	>
27	>	=item C<message(string)>
28	>
29	>	Set a new message at the current level.
30	>
31	>	=item C<read([level])>
32	>
33	>	Return list of all messages up to level n (or current assignment level).
34	>
35	>	=item C<readlevel(level)>
36	>
37	>	Read only those messages assigned to the given level.
38	>
39	>	=item C<copy(Message)>
40	>
41	>	Copy the messages from one object to the current,
42	>	starting at the current active level.
43	>
44	>	=item C<levels()>
45	>
46	>	Return the number of assignment levels.
47	>
48	>	=back
49	>
50	>	=head1 AUTHOR
51	>
52	>	Originally Written by Christopher Williams.
53	>
54	>	=head1 MAINTAINER
55	>
56	>	Shaun ASHBY L<mailTo:Shaun.Ashby@cern.ch>
57	>
58	>	=cut
59
60		package Utilities::Message;
61		require 5.004;

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines