Changeset 25 for trunk

Timestamp:

11/02/05 19:52:18 (19 years ago)

Author:

thauvin

Message:

• document way of life (Michele Thetis)
• doc about ObsData? module
• functions to dir by type of data

Location:

trunk/soft

Files:

• ObsData/ObsData.pm (modified) (6 diffs, 1 prop)
• ObsData/ObsData/Data.pm (modified) (2 diffs, 1 prop)
• ObsData/t/O-01.t (modified) (1 diff, 1 prop)
• ObsData/t/O-02.t (modified) (2 diffs, 1 prop)
• ObsData/testdata/obsdata-conftest (modified) (1 diff, 1 prop)
• README (modified) (1 diff, 1 prop)

trunk/soft/ObsData/ObsData.pm

@@ -8 +8 @@
 
 our $VERSION = 0.01;
+
+=head1 NAME
+
+ObsData - Main object to manage data files
+
+=head1 SYNOPSIS
+
+    use ObsData;
+    my $conf = "configfile";
+    my $obsdata = ObsData->new($conf);
+
+=head1 METHODS
+
+=head2 new($configfile)
+
+Create a new Obsdata object from $configfile
+
+=cut
 
 sub new {
@@ -23 +41 @@
 }
 
+=head2 checkconfig()
+
+Check the validity of information contains in configfile.
+
+Notice: This test does not include the syntaxe validity
+
+=cut
+
 sub checkconfig {
     my ($self) = @_;
@@ -28 +54 @@
         my ($obs) = $g =~ /\S+\s+(.*)/;
         if (!$self->{config}->SectionExists($obs)) {
-            print "E: '$obs' is listed as Obs but it does not exists\n";
+            print STDERR "E: '$obs' is listed as Obs but it does not exists\n";
             next;
         }
@@ -36 +62 @@
 }
 
+=head2 getvalue($section, $var, $default)
+
+Return a value from the configuration, $default is assumed if the value is not set
+
+=cut
+
 sub getvalue {
     my ($self, $section, $var, $default) = @_;
     $self->{config}->val($section, $var, $default);
 }
+
+=head2 list_obs
+
+Return the list of observatories defined in configuration
+
+=cut
 
 sub list_obs {
@@ -48 +86 @@
 }
 
+=head2 is_obs($obsname)
+
+Return True if $obsname is an observatory
+
+=cut
+
 sub is_obs {
     my ($self, $obs) = @_;
@@ -53 +97 @@
 }
 
-sub list_datadir {
+=head2 list_obsdatadir($obsname)
+
+Return a hash of data directories per data type for $obsname observatories
+
+=cut
+
+sub list_obsdatadir {
     my ($self, $obs) = @_;
     $self->is_obs($obs) or return undef;
-    map { m,^datadir/(.*),; ( $1 => $self->{config}->val($obs, $_) ) }
-        grep { m,^datadir/, } 
+    map { m,^datadir/(.*),; ( ($1 || "") => $self->{config}->val($obs, $_) ) }
+        grep { m,^datadir/, || $_ eq 'datadir' }
         $self->{config}->Parameters($obs)
 }
+
+=head2 list_typedatadir($type)
+
+List all directories for $type data
+
+=cut
+
+sub list_typedatadir {
+    my ($self, $type) = @_;
+    my %dirs;
+    foreach my $obs ($self->list_obs) {
+        $dirs{$_} = 1 foreach(grep { $_ } $self->get_datadir($obs, $type));
+    }
+    keys %dirs; 
+        
+}
+
+=head2 get_datadir($obs, $type)
+
+Return a list of directories for $type data on $obs observatory
+
+=cut
 
 sub get_datadir {
     my ($self, $obs, $type) = @_;
     $self->is_obs($obs) or return undef;
-    $self->getvalue($obs, "datadir/$type");
+    grep { defined($_) } ($self->getvalue($obs, "datadir/$type"), $self->getvalue($obs, "datadir"));
 }
 

trunk/soft/ObsData/ObsData/Data.pm

@@ -11 +11 @@
         obsdata => $obsdata,
         datafile => $file,
+        datatype => undef,
     };
 
@@ -23 +24 @@
     my ($self) = @_;
     # check if the config has all info need for proccessing
+    if(!$self->{datatype}) {
+        return 0;
+    }
+    # if ($self->{obsdata}->getvalue($self->{datatype}, '
 }
+
+
 
 1;

trunk/soft/ObsData/t/O-01.t

@@ -5 +5 @@
 use_ok('ObsData');
 
-can_ok('ObsData', qw(list_obs list_datadir get_datadir getvalue is_obs));
+can_ok('ObsData', qw(list_obs list_obsdatadir list_typedatadir get_datadir getvalue is_obs));
 
 ok(ObsData->new('testdata/obsdata-conftest'), "Can create object");

trunk/soft/ObsData/t/O-02.t

@@ -1 +1 @@
 # $Id$
 
-use Test::More tests => 8;
+use Test::More tests => 9;
 
 use_ok('ObsData');
@@ -8 +8 @@
 ok($o->getvalue('ohp', 'description'), "can get value");
 
-ok(grep { 'ohp' } $o->list_obs, "Can list observatories");
+ok(eq_set([ $o->list_obs ], [ 'ohp' ]), "Can list observatories");
 
 ok($o->is_obs('ohp'), "check is an obs is defined");
 ok(!$o->is_obs('NOohp'), "check is an obs is not defined");
 
-my %datadir =  $o->list_datadir('ohp');
+{
+my %datadir =  $o->list_obsdatadir('ohp');
 ok($datadir{ozone} eq 'testdata/ohp/ozone', "Can get list of data directory");
-ok($o->get_datadir('ohp', 'ozone') eq 'testdata/ohp/ozone', 'Can retrive data directory');
+}
+
+ok(eq_set([ $o->list_typedatadir('ozone') ], [ 'testdata/ohp/ozone', 'testdata/ohp' ]) , 'Can list data directory');
+ok(eq_set([ $o->get_datadir('ohp', 'ozone') ], [ 'testdata/ohp/ozone', 'testdata/ohp' ]) , 'Can retrive data directory');

trunk/soft/ObsData/testdata/obsdata-conftest

@@ -9 +9 @@
 [ohp]
 description=Observatoire de Haute Provence
+datadir=testdata/ohp
 datadir/ozone=testdata/ohp/ozone
-
 
 [ozone]
 
+[oxygene]

trunk/soft/README

@@ +1 @@
+$Id$
+
 ObsData : Perl Libary to manage data files
 
-$Id$
+***********
+* Methode *
+***********
+
+- répertoire d'arrivée des données
+    - 1 répertoire par station !
+    - lister les archives présentes
+    - filtrer les archives encore à traiter (comment identifier ?)
+        - on listes les fichiers de données contenu
+        - si une règle de traitement est applicable => applique le traitement
+        - sinon => poser le fichier dans les rejets
+
+Besoin par archive:
+    - date de traitement
+    - fichiers data
+        - regle apliquée
+        - destination finale
+
+[STATION]
+source = /sources/archives
+
+[LIDAR]
+match = ^LIDAR.*
+properties = ^LIDAR-([^-]*)-([^\.]*)$ date extension
+archive_properties = ^LIDAR-([^-]*)-([^\.]*)$ date extension
+destination = /foo/%s/name/LIDAR/ date