/home/pascal/depot/filedata/src/parasoldata.h

/***************************************************************************
 *   Copyright (C) 2005 by Nicolas PASCAL   *
 *   nicolas.pascal@icare.univ-lille1.fr   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef PARASOLDATAFILE_H
#define PARASOLDATAFILE_H

#include "parasolfilereader.h"

class PARASOLData : public PARASOLFileReader {
    friend class PARASOLFileData;

    PARASOLDataFormat *data_file_format;

public:
    DataFileDescriptorRecord *data_file_descriptor;
protected:
    string filename;

    // record storage classes
    DataRecord *data;

    virtual void read_data_file(const string &data_filename);
    const bool is_record_loaded(const Record &rec);
    void free_records();
    PARASOLFileRecord* init_record(const Record &rec);
    const int get_record_offset(const Record &rec);
    virtual const RecordFormat* get_record_format(const Record &rec);
    PARASOLFileRecord* get_record(const Record &rec);
// //     void get_entry_group_range( const Record & record_code,
// //                                 const RecordFormat::iterator &entry_group_start,
// //                                 RecordFormat::iterator &entry_group_end,
// //                                 int &nb_val);
//     const int get_entry_group_size(const int entry_idx);
//     const int get_entry_group_size(const Record rec, const int entry_idx);
//     const int get_entry_group_nb_val(const Record rec, const int entry_idx) const;
    vector <EntryBlock> get_entry_block (const Record rec, const int entry_idx) const;
//     const int get_entry_offset( const Record rec, const int entry_idx, const int record_idx=-1, const int direction_index=-1, const int val_index=-1);
    template <class T>
    void apply_scaling(double* scaled_data, const T* count_data, const double & slope, const double & offset, const int & nb_val, const T count_fill_value=T(0));
public:
    PARASOLData( const string data_filename="");
    virtual ~PARASOLData();
    void print_data_file_descriptor();
    virtual void print_data(){;};

    bool read_data(void* buf, const int &param_index, int * start, int * edges, const int rank );
    const PARASOLDataFormat * get_data_file_format() {
        return data_file_format;
    }
    const int get_nb_data_record() const;
    const int get_sz_data_record() const;
    const int get_data_entry_index(const string &var_name) const;
    const int get_nb_val(const string &var_name, const int edges=-1, const int dir_idx=-1) const;
    const int get_nb_val(const int &var_index,const int edges=-1, const int dir_idx=-1) const;
};
template <class T>
void PARASOLData::apply_scaling( double* scaled_data, const T* count_data, const double & slope, const double & offset, const int & nb_val, const T count_fill_value )
{

    // the fill value to use in the scaled data
    double decoded_fill_value=-DBL_MAX;
    // the fill values used in the count data
    int level=PARASOLFileFormat::get_level(this->product);
    T missing_value=PARASOLFileFormat::get_missing_value<T>(level);
    T out_of_range_value=PARASOLFileFormat::get_out_of_range_value<T>(level);

    // apply the scaling
    T count_val;
    for (int i = 0 ; i<nb_val ; ++i) {
        count_val=count_data[i];
        if (  (missing_value!=(T)(1) &&  count_val==missing_value ) ||
              (out_of_range_value!=(T)(1) && count_val==out_of_range_value ) )
          // there is a missing value for this type and the count data is a missing one. IDEM for out_of_range values
          scaled_data[i]=decoded_fill_value;
        else
          // good value -> apply the scaling
          scaled_data[i]=offset+slope*count_val;
    }
}


#endif