Changeset 167

Timestamp:

12/19/05 19:57:53 (18 years ago)

Author:

thauvin

Message:

• add documentation

File:

• trunk/soft/ObsData/ObsData/Event.pm (modified) (6 diffs, 1 prop)

trunk/soft/ObsData/ObsData/Event.pm

@@ -5 +5 @@
 
 package ObsData::Event;
+
+=head1 NAME
+
+ObsData::Event - A simple class to manage message between backend
+and main software.
+
+=head1 SYNOPSIS
+
+    my $callback = sub {
+        my ($events) = @_;
+        print $events->message . "\n";
+    }
+
+    my $oe = ObsData::Event->new('id', 'what should I do');
+
+    $callback($oe);
+
+=head1 METHODS
+
+=head2 new($id $message)
+
+Create a new ObsData::Event object to handle $message with $id
+
+=cut
 
 sub new {
@@ -24 +48 @@
 }
 
+=head2 id
+
+Return the id of the object
+
+=cut
+
 sub id {
     my ($self) = @_;
@@ -29 +59 @@
 }
 
+=head2 message
+
+Return the message handle by the object
+
+=cut
+
 sub message {
     my ($self) = @_;
     return($self->{message});
 }
+
+=head2 add_test($test_id, $message, $result)
+
+Add a new test into the object.
+
+=cut
 
 sub add_test {
@@ -43 +85 @@
 }
 
+=head2 list_test
+
+List test currently stored into the object. Return the list of test id.
+
+=cut
+
 sub list_test {
     my ($self) = @_;
@@ -48 +96 @@
 }
 
+=head2 test_message($test_id)
+
+Return the message associated to a test.
+
+=cut
+
 sub test_message {
     my ($self, $test_id) = @_;
     return($self->{test}{$test_id}{message});
 }
+
+=head2 test_result($test_id)
+
+Return the result associated to a test
+
+=cut
 
 sub test_result {
@@ -60 +120 @@
 1;
 
+__END__
+
+=head1 AUTHOR
+
+Olivier Thauvin <olivier.thauvin@aerov.jussieu.fr>
+
+=cut