Changeset 105

Timestamp:

12/10/05 23:49:30 (19 years ago)

Author:

thauvin

Message:

• more documentation

File:

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

trunk/soft/ObsData/ObsData.pm

@@ -323 +323 @@
 }
 
+=head2 get_obs_data_handle($obs, $datatype)
+
+Return an ObsData::Repository object about directory for $obs station
+about $datatype data. $datatype can be undefined if you want to get default
+directory
+
+=cut
+
+sub get_obs_data_handle {
+    my ($self, $obs, $datatype) = @_;
+
+    my $dir = $self->getvalue($obs, ($datatype ? "datadir/$datatype" : "datadir"));
+    if (!$dir) {
+        $self->loging(4,
+            "Can't find data directory for %s, type: %s",
+            $obs, $datatype || '(none)'
+        );
+        return undef;
+    }
+    my $or = ObsData::Repository::dir->new(
+        {
+            obsdata => $self,
+            dir => $dir,
+            obs => $obs,
+            datatype => $datatype,
+            statusfile => "$dir/obsdata.ini"
+        }
+    );
+    if (!defined($or)) {
+        $self->loging(4, "Can't parse %s, check directory exists", $dir);
+        return undef;
+    }
+    
+    return($or);
+}
+
+=head2 process_obs($obs)
+
+Process all data handle by $obs station
+
+=cut
+
 sub process_obs {
     my ($self, $obs) = @_;
@@ -335 +377 @@
 }
 
-sub get_obs_data_handle {
-    my ($self, $obs, $datatype) = @_;
-
-    my $dir = $self->getvalue($obs, ($datatype ? "datadir/$datatype" : "datadir"));
-    if (!$dir) {
-        $self->loging(4,
-            "Can't find data directory for %s, type: %s",
-            $obs, $datatype || '(none)'
-        );
-        return undef;
-    }
-    my $or = ObsData::Repository::dir->new(
-        {
-            obsdata => $self,
-            dir => $dir,
-            obs => $obs,
-            datatype => $datatype,
-            statusfile => "$dir/obsdata.ini"
-        }
-    );
-    if (!defined($or)) {
-        $self->loging(4, "Can't parse %s, check directory exists", $dir);
-        return undef;
-    }
-    
-    return($or);
-}
-
 1;
+
+=head1 AUTHOR
+
+Olivier Thauvin <olivier.thauvin@aerov.jussieu.fr>
+
+=cut