attr_list_hdf.h

Go to the documentation of this file.

//Copyright 2010 Thomas A Caswell
//tcaswell@uchicago.edu
//http://jfi.uchicago.edu/~tcaswell
//
//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 3 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, see <http://www.gnu.org/licenses>.
//

#ifndef HDF_ATTTR_LIST
#define HDF_ATTTR_LIST

#include <list>
#include <string>
#include "tuple.h"
#include "enum_utils.h"
// forward declare classes
namespace H5
{
class H5Object;
}

namespace utilities
{


class Attr_list_hdf
{
public:
  Attr_list_hdf(H5::H5Object * obj);
  ~Attr_list_hdf();

  bool contains_attr(const std::string & key) const;
  
  int get_value(const std::string & key, int & value_out) const ;
  void set_value(const std::string & key,  const int &   value_in,bool over_write = false) ;
  float get_value(const std::string & key, float & value_out) const ;
  void set_value(const std::string & key,  const float & value_in,bool over_write = false) ;
  
  template<int N>
  utilities::Tuple<float,N> get_value(const std::string & key, utilities::Tuple<float,N> & value_out) const ;
  template<int N>
  void set_value(const std::string & key,  const utilities::Tuple<float,N> & value_in,bool over_write = false) ;
  std::string get_value(const std::string & key,std::string & value_out)const;
  void set_value(const std::string & key,const std::string & value_out,bool over_write = false);
  
  bool get_value(const std::string & key,bool & value_out)const;
  void set_value(const std::string & key,const bool & value_out,bool over_write = false);

  
  unsigned int get_value(const std::string & key,unsigned int& value_out)const;
  void set_value(const std::string & key,const unsigned int & value_out,bool over_write = false);

  
  
  

  void remove_attr(const std::string & key);

  
  void print()const;
  
  std::list<std::string> contents()const;
  utilities::V_TYPE get_type(const std::string& key)const;
  
  
private:
  std::list<std::string> keys_;
  H5::H5Object * obj_;
  
  

};
}

  

#endif