member_record_set.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 member_record_set

#ifndef MEMBER_RECORD_SET_H
#define MEMBER_RECORD_SET_H

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

#ifndef RECORD_SET_H
#include "SheafSystem/record_set.h"
#endif

#ifndef INTERVAL_INDEX_SPACE_RECORD_H
#include "SheafSystem/interval_index_space_record.h"
#endif

#ifndef MEMBER_RECORD_H
#include "SheafSystem/member_record.h"
#endif

#ifndef INTERVAL_INDEX_SPACE_HANDLE_H
#include "SheafSystem/interval_index_space_handle.h"
#endif


namespace sheaf
{

class dof_tuple_record_set;
class index_equivalence_iterator;
  
class SHEAF_DLL_SPEC member_record_set : public record_set
{

public:

  // =============================================================================
  // ANY FACET
  // =============================================================================

  virtual member_record_set* clone() const;

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  // =============================================================================
  // MEMBER_RECORD_SET FACET
  // =============================================================================

  member_record_set(const sheaf_file& xfile,
                    int xbuffer_ub,
                    const poset_scaffold& xscaffold,
                    const dof_tuple_record_set& xdof_tuple_records);

  member_record_set(const member_record_set& xother);

  virtual ~member_record_set();

  virtual const std::string& suffix() const;

  void internalize(pod_index_type xmax_row_int_id);

  void internalize(const scoped_index& xmax_row_int_id);

  void externalize(pod_index_type xmax_row_int_id);

  void externalize(const scoped_index& xmax_row_int_id);

  dof_tuple_record_set& dof_tuple_records();

  const member_record& record() const;

  static pod_index_type first_member_record();

protected:

  // Default constructor;
  // not supported because can not initialize reference data members.
  // member_record_set();

  virtual hid_t create_dataset();

  virtual void create_int_data_type();

  void read_record(const record_index& xext_id);

  void read_selection();

  void write_selection();

  void make_internal_dataspace();

private:

  hid_t _member_record_type;

  hvl_t* _hdf_bufs;

  void delete_external_buffers();

  void delete_hdf_buffers();


  hsize_t (*_hdf_selection)[1];

  member_record _record;

  poset_scaffold& _scaffold;

  dof_tuple_record_set& _dof_tuple_records;

  void write_record_buffer();

  void clean_upper_covers();

  interval_index_space_record _id_space_record;

  interval_index_space_handle _record_id_space;

  static pod_index_type record_id_space_record();
  
  static pod_index_type interval_id_space_record();

  std::string _interval_id_space_name;

  interval_index_space_handle _interval_id_space; 

  void write_id_space_record(const interval_index_space_handle& xid_space, pod_index_type xrecord_id);
  
  void read_id_space_record(interval_index_space_handle& xid_space, pod_index_type xrecord_id);
  
  void read_member(const scoped_index& xindex, record_index& xext_id);

  void make_idorder_file_id_spaces(const abstract_poset_member& xmbr);

};
 
} // namespace sheaf

#endif // ifndef MEMBER_RECORD_SET_H