HDF5Array.h

Go to the documentation of this file.

// This file is part of hdf5_handler a HDF5 file handler for the OPeNDAP
// data server.

// Author: Hyo-Kyung Lee <hyoklee@hdfgroup.org> and Muqun Yang
// <myang6@hdfgroup.org> 

// Copyright (c) 2009-2013 The HDF Group, Inc. and OPeNDAP, Inc.
//
// This is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your
// option) any later version.
//
// This software 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 Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
// You can contact The HDF Group, Inc. at 1800 South Oak Street,
// Suite 203, Champaign, IL 61820  

#ifndef _hdf5array_h
#define _hdf5array_h 1

#include <H5Ipublic.h>
#include <H5Rpublic.h>

#include "Array.h"
#include "h5get.h"

using namespace libdap;

class HDF5Array:public Array {
  private:
    int d_num_dim;
    int d_num_elm;
    hid_t d_dset_id;
    hid_t d_ty_id;
    size_t d_memneed;
    
    // Parse constraint expression and make HDF5 coordinate point location.
    // return number of elements to read. 
    int format_constraint(int *cor, int *step, int *edg);

    // Handling constraint expression on array of structure requires the
    // following linearizion function since the HDF5 array of structure is
    // 1-D (linear) while constraint expression can be multi-dimensional.
    // Based on the \param start, \param stride, and \param count,
    // this function will pick the corresponding array indexes from HDF5 array
    // and the picked indexes will be stored under \param picks.
    int linearize_multi_dimensions(int *start, int *stride, int *count,
                                   int *picks);
    hid_t mkstr(int size, H5T_str_t pad);

    bool m_array_of_structure(); // Used by read()
    bool m_array_in_structure();
    void m_insert_simple_array(hid_t s1_tid, hsize_t *size2);
    bool m_array_of_reference();
    void m_intern_plain_array_data(char *convbuf);

  public:
     H5T_class_t d_type;

    HDF5Array(const string & n, const string &d, BaseType * v);
    virtual ~ HDF5Array();

    virtual BaseType *ptr_duplicate();

    virtual bool read();

    friend string return_type(hid_t datatype);

    hid_t get_did();
    hid_t get_tid();

    bool read_vlen_string(hid_t d_dset_id, hid_t d_ty_id, int nelms,
                          int *offset, int *step, int *count);

    void set_did(hid_t dset);

    void set_tid(hid_t type);

    void set_memneed(size_t need);

    void set_numdim(int ndims);

    void set_numelm(int nelms);
};

#endif