Changeset 36

Show
Ignore:
Timestamp:
01/10/08 14:37:44
Author:
jcleary
Message:

Changes supporting Cached Obs image migration milestone

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • cached_images/trunk/cached_images/CacheBot.pm

    r25 r36  
    99=head1 NAME 
    1010 
    11 Seacoos::CacheBot, cache_wms_map_image, cache_php_map_image - SEACOOS static map image cache'r 
     11Secoora::CacheBot, cache_wms_map_image, cache_php_map_image - Secoora static map image cache'r 
    1212 
    1313=head1 AUTHOR 
     
    1717=head1 SYNOPSIS 
    1818 
    19         use Seacoos::CacheBot; 
    20         Seacoos::CacheBot::cache_wms_map_image(west=>'signed_decimal_longitude', 
     19        use Secoora::CacheBot; 
     20        Secoora::CacheBot::cache_wms_map_image(west=>'signed_decimal_longitude', 
    2121                                               south=>'signed_decimal_latitude', 
    2222                                               east=>'signed_decimal_logitude', 
     
    3030                                               debug=>"yes"); 
    3131 
    32         Seacoos::CacheBot::cache_php_map_image(west=>'signed_decimal_longitude', 
    33                                                south=>'signed_decimal_latitude', 
    34                                                east=>'signed_decimal_logitude', 
    35                                                north=>'signed_decimal_latitude', 
    36                                                layers=>'layers_list', 
    37                                                use_scale=>'scale_flag', 
    38                                                degree_units=>'degree_code'. 
    39                                                velocity_units=>'velocity_code' 
    40                                                width=>'unsigned_integer_#_of_pixels', 
    41                                                web_service=>'URI_of_web_web_service', 
    42                                                time_out=>'unsigned_integer_#_of_seconds_to_wait_on_server', 
    43                                                output=>'image_file_path', 
    44                                                debug=>"yes"); 
    4532 
    4633=head1 DESCRIPTION 
    4734 
    48 Seacoos:CacheBot is a Perl module to generate a single map image file for serving from a cache. 
     35Secoora:CacheBot is a Perl module to generate a single map image file for serving from a cache. 
    4936Ideally, the functions within should be invoked from a cron job. 
    5037 
     
    5340=over 4 
    5441 
    55 =item Seacoos::CacheBot::cache_wms_map_image(%query_parameters) 
     42=item Secoora::CacheBot::cache_wms_map_image(%query_parameters) 
    5643 
    5744I<cache_wms_map_image> generates a map image file via an OpenGIS Consortium (OGC; http://www.opengis.org ) Web Map Service (WMS) compliant web service open standards implementation. 
     
    9380The default is to suppress standard output diagnostics. 
    9481 
    95 =item Seacoos::CacheBot::cache_php_map_image(%query_parameters) 
     82=item Secoora::CacheBot::cache_php_map_image(%query_parameters) 
    9683 
    9784I<cache_php_map_image> generates a map image file via a proprietary PHP enabled remote front-end to map services. 
     
    114101=head1 EXAMPLES 
    115102 
    116  Seacoos::CacheBot::cache_wms_map_image(west=>'-88', 
     103 Secoora::CacheBot::cache_wms_map_image(west=>'-88', 
    117104                                        south=>'22.2', 
    118105                                        east=>'-70.5', 
     
    126113                                        debug=>'yes'); 
    127114 
    128   Seacoos::CacheBot::cache_php_map_image(west=>'-88', 
    129                                          south=>'22.2', 
    130                                          east=>'-70.5', 
    131                                          north=>'36.8', 
    132                                          layers=>'world_filled,us_filled,world_outline,us_outline,country_names,world_capitals,us_big_cities,avhrr_sst', 
    133                                          use_scale=>'1', 
    134                                          degree_units=>'F', 
    135                                          velocity_units=>'KNOTS', 
    136                                          width=>'288', 
    137                                          web_service=>'http://www.yourmapserver.org/yourfolder/yourtemplate.php', 
    138                                          time_out=>'30', 
    139                                          output=>'/home/fubu/public_html/test.png', 
    140                                          debug=>'yes'); 
    141  
    142115=head1 SOURCE 
    143116 
     
    171144 1.04           9/13/04         CBC     cleanup for IPM environment 
    172145 
    173  1.05           03/05           JC      added elapsed time handling for php routine 
    174  
    175  1.06           05/03/05        JC      modified for WMS only - rm'd much php only code 
     146 1.05       03/05           JC  added elapsed time handling for php routine 
     147 
     148 1.06       05/03/05    JC      modified for WMS only - rm'd much php only code 
     149  
     150 2.0        12/20/07    JC Changed naming to SECOORA 
    176151 
    177152=cut 
    178153 
    179 package Seacoos::CacheBot; 
     154package Secoora::CacheBot; 
    180155 
    181156use strict; 
     
    195170 
    196171my $debug               = ''; 
    197 my $agent               = 'Seacoos CacheBot/1.06'; 
     172my $agent               = 'Secoora CacheBot/2.0'; 
    198173my $default_time_out    = 15; 
    199174#rm scale variables