/home/amesfoort/DAL/dal/hdf5/Attribute.h

/* Copyright 2011-2012  ASTRON, Netherlands Institute for Radio Astronomy
 * This file is part of the Data Access Library (DAL).
 *
 * This library 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 3 of the License, or (at your option) any later version.
 *
 * This library 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, see <http://www.gnu.org/licenses/>.
 */
#ifndef DAL_ATTRIBUTE_H
#define DAL_ATTRIBUTE_H

#include <cstdlib>
#include <string>
#include <vector>
#include <ostream>
#include <hdf5.h>
#include "types/h5typemap.h"
#include "types/versiontype.h"
#include "Node.h"

namespace dal {

class Group;

class AttributeBase: public Node {
public:
  AttributeBase( Group &parent, const std::string &name ): Node(parent, name) {}

  virtual ~AttributeBase() {}

  virtual bool exists() const;

  void remove() const;

  size_t size() const;

  virtual bool valid() const;
};

#ifndef SWIG

template<typename T> class Attribute;

template<typename T> class AttributeValue {
public:
  AttributeValue<T>& operator=( const T& value );

  AttributeValue<T>& operator=( const AttributeValue<T>& value );

  operator T() const;

  void del() const;

private:
  // Do not allow copying, as attr of the copy might get out of scope
  AttributeValue( const AttributeValue& );

  AttributeValue( Attribute<T> &attr ): attr(attr) {}

  Attribute<T> &attr;

  // Only Attribute<T> can create instances
  friend class Attribute<T>;
};

template<typename T> std::ostream& operator<<(std::ostream &out, const AttributeValue<T> &val);

#endif /* !SWIG */

template<typename T> class Attribute: public AttributeBase {
public:
  typedef T value_type;

  Attribute( Group &parent, const std::string &name ): AttributeBase(parent, name), value(*this) {}

  Attribute( const Attribute &other ): AttributeBase(other), value(*this) {}

  virtual ~Attribute() {}

  Attribute<T>& create();

  T get() const;

  void set( const T &value );

  virtual bool valid() const;

  AttributeValue<T> value;
};

template<typename T> class Attribute< std::vector<T> >: public AttributeBase {
public:
  typedef std::vector<T> value_type;

  Attribute( Group &parent, const std::string &name ): AttributeBase(parent, name), value(*this) {}

  Attribute( const Attribute &other ): AttributeBase(other), value(*this) {}

  virtual ~Attribute() {}

  Attribute< std::vector<T> > &create( size_t length = 0 );

  std::vector<T> get() const;

  void set( const std::vector<T> &value );

  virtual bool valid() const;

  AttributeValue< std::vector<T> > value;
};

}

#include "Attribute.tcc"

#endif