sheaf_file.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class sheaf_file

#ifndef SHEAF_FILE_H
#define SHEAF_FILE_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef STD_HDF5_H
#include "SheafSystem/std_hdf5.h"
#endif

#ifndef STD_STRING_H
#include "SheafSystem/std_string.h"
#endif

namespace sheaf
{

class data_type_map;
class dof_tuple_record_set;
class member_record_set;
  
class SHEAF_DLL_SPEC sheaf_file : public any
{

  friend class data_type_map;
  friend class record_set;
  friend class attributes_record_set;
  friend class member_record_set;
  friend class dof_tuple_record_set;

public:

  // CANONICAL MEMBERS

  sheaf_file();

  sheaf_file(const sheaf_file& xother);

  virtual sheaf_file* clone() const;

  virtual ~sheaf_file();

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  // SHEAF_FILE INTERFACE

  

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

  enum access_mode {NONE, READ_ONLY, READ_WRITE};

  void open(const std::string &xname, access_mode xmode = READ_WRITE, bool xclobber = true);

  bool is_open() const;

  access_mode mode() const;

  void close();

  data_type_map& type_map();

  const data_type_map& type_map() const;

  bool type_map_defined() const;


private:

  std::string _name;

  hid_t _hdf_id;

  hid_t hdf_id() const;

  access_mode _mode;

  data_type_map* _type_map;

};

} // namespace sheaf

#endif // ifndef SHEAF_FILE_H