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

#ifndef MAP_RECORD_H
#define MAP_RECORD_H

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

#ifndef VARIABLE_LENGTH_RECORD_H
#include "SheafSystem/variable_length_record.h"
#endif

namespace sheaf
{

class member_record_set;
class interval_index_map;
  
class SHEAF_DLL_SPEC map_record : public variable_length_record
{
  // ===========================================================
  // MAP_RECORD FACET
  // ===========================================================

public:

  map_record(member_record_set& xhost);

  map_record(const map_record& xother);

  virtual ~map_record();

protected:

  // Default constructor.
  // Default construction prohibited because scaffold must be initialized
  // inline map_record() {} ;

private:

  // ===========================================================
  // WRITE FACET
  // ===========================================================

public:

  void externalize(hvl_t* xhdf_buffer, const interval_index_map& xmap);

private:

  void transfer_map_to_internal_buffer();

  void convert_internal_buffer_to_external_buffer(const interval_index_map& xmap);

  virtual void initialize_external_buffer(const interval_index_map& xmap);

  void externalize_map_data(size_t& xnext_field_offset, const interval_index_map& xmap);

  void transfer_external_buffer_to_HDF(hvl_t* xbuf);

  // ===========================================================
  // READ FACET
  // ===========================================================

public:

  void internalize(hvl_t* xhdf_buffer, interval_index_map& xmap);

private:

  void transfer_HDF_to_external_buffer(hvl_t* xbuf);

  void convert_external_buffer_to_internal_buffer(interval_index_map& xmap);

  void internalize_map_data(size_t& xnext_field_offset, interval_index_map& xmap);

  void transfer_internal_buffer_to_map();

  // ===========================================================
  // VARIABLE_LENGTH_RECORD FACET
  // ===========================================================

  

  inline int* int_buf() const
  {
    return reinterpret_cast<pod_index_type*>(buf());
  };

  // ===========================================================
  // RECORD FACET
  // ===========================================================

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

public:

  virtual map_record* clone() const;

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

};
 
} // namespace sheaf

#endif // ifndef MAP_RECORD_H