# DCsample.ctl:020:Controls Sampling
# $Id: DCsample.ctl,v 1.3 2013/10/30 07:18:47 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/SAMPLE/DCsample.ctl,v 1.3 2013/10/30 07:18:47 RDA Exp $
#
# Change History
# 20130422  MSC  Improve the validation.

=head1 NAME

SAMPLE:DCsample - Provides RDA Sampling Overview

=head1 DESCRIPTION

This module provides an overview of the available RDA samples.

=cut

echo tput('bold'),'Processing SAMPLE.SAMPLE module ...',tput('off')

# Initialization
var $TOC = '%TOC%'
var $TOP = '[[#Top][Back to top]]'

# Provide the overview
debug ' Inside SAMPLE module, retrieving available sample archives/files'
report overview
title '---+!! Sampling Overview'
title $TOC
title 'The content of this report can be obsolete if the background collection \
       is running. It should be stopped for producing this report and for \
       packaging the files.'

# List the sample archives
if ?testDir('d',$dir = ${OUT.A})
{prefix
 {write '---+ Sample Archives'
  write '|*File*| *Size*|'
 }
 loop $fil (grepDir($dir,'^RDA_smp_','it'))
  write '|[[../archive/',$fil,'][',encode($fil),']]| ',\
         getSize(catFile($dir,$fil)),'|'
 if hasOutput(true)
  write $TOP
}

# List the sample files
if ?testDir('d',$dir = ${OUT.S})
{prefix
 {write '---+ Sample Files'
  write '|*File*| *Size*|'
 }
 loop $fil (grepDir($dir,'\.(dat|txt)$','in'))
  write '|[[../sample/',$fil,'][',encode($fil),']]| ',\
         getSize(catFile($dir,$fil)),'|'
 if hasOutput(true)
  write $TOP
}

# Generate the index contributions if the report has some content
if isCreated()
{toc '1:Sampling'
 toc '2:[[',getFile(),'][rda_report][Overview]]'
}

=head1 SEE ALSO

L<SAMPLE:DCextra|collect::SAMPLE:DCextra>,
L<SAMPLE:DCnperf|collect::SAMPLE:DCnperf>,
L<SAMPLE:DCrperf|collect::SAMPLE:DCrperf>

=begin credits

=over 10

=item RDA 4.1:  John Peeken, John Sobecki, Michel Villette.

=back

=end credits

=head1 COPYRIGHT NOTICE

Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.

=head1 TRADEMARK NOTICE

Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.

=cut