/home/amesfoort/DAL/dal/hdf5/Node.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_NODE_H
#define DAL_NODE_H

#include <string>
#include <vector>
#include <typeinfo>
#include "types/hid_gc.h"
#include "types/FileInfo.h"
#include "types/versiontype.h"

namespace dal {

class Group;

class Node {
public:
  typedef /*FileInfo::FileMode*/int FileMode; // TODO: have SWIG declare FileInfo::FileMode constants, also as Node members
  // Not an enum, because enums cannot be forward declared (until C++11) and
  // we (only) need all values here. The enum here instead would give a circular dep with FileInfo.
  //static const FileMode NONE        = 0; // value used in FileInfoType only
  static const FileMode READ        = 1;
  static const FileMode READWRITE   = 2;
  static const FileMode CREATE      = 3;
  static const FileMode CREATE_EXCL = 4;


  Node();

  Node( Group &parent, const std::string &name );

  virtual ~Node();

  Node& operator=(Node rhs);

  friend void swap(Node& first, Node& second);

  std::string name() const { return _name; }

  virtual bool exists() const { return false; }

  bool supported() { return minVersion <= fileInfoVersion(); }

/*
  std::string className() const { return typeid(*this).name(); }
*/

  const std::string& filename() const;

  FileMode fileMode() const;

  bool canWrite() const;

  const std::string& versionAttrName() const;

protected:
  hid_gc parent;
  std::string _name;

  VersionType minVersion; // TODO: move this elsewhere?

  FileInfo fileInfo; // proxy/reference object to reference-counted structure

  Node( const hid_gc &parent, const std::string &name, FileInfo fileInfo);

  int fileDirfd() const;

  VersionType& fileInfoVersion() const; // keep protected to avoid escaped dangling ref in applications

  void setFileInfoVersion(const VersionType& newVersion);
};

}

#endif