namespace_poset_dof_map.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 namespace_poset_dof_map;
// map from client dof id to dof value

#ifndef NAMESPACE_POSET_DOF_MAP_H
#define NAMESPACE_POSET_DOF_MAP_H

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

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef POSET_DOF_MAP_H
#include "SheafSystem/poset_dof_map.h"
#endif

#ifndef POSET_TYPE_H
#include "SheafSystem/poset_type.h"
#endif

namespace sheaf 
{

class dof_map_factory;
class namespace_poset;
  
class SHEAF_DLL_SPEC namespace_poset_dof_map : public poset_dof_map
{

  friend class poset_state_handle;
  friend class namespace_poset;
  friend class namespace_poset_member;

public:

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

  static const std::string& static_class_name();

  // CANONICAL MEMBERS

  namespace_poset_dof_map();

  virtual namespace_poset_dof_map* clone() const;

  namespace_poset_dof_map(const namespace_poset_dof_map& xother);

  virtual namespace_poset_dof_map* copy() const;

  namespace_poset_dof_map& operator=(const namespace_poset_dof_map& xother);

  virtual ~namespace_poset_dof_map();

  virtual bool invariant() const;

  // OTHER CONSTRUCTORS

  namespace_poset_dof_map(const namespace_poset* xhost);

  // MAP INTERFACE

  virtual dof_tuple_type type_id() const
  {
    return  NAMESPACE_POSET_DOF_TUPLE_ID;
  };

  // ===========================================================
  //  NEW DOF ACCESS FACET
  // ===========================================================

  using poset_dof_map::get_dof;
  using poset_dof_map::put_dof;

  virtual void get_dof(pod_index_type xdof_id, void* xdof, size_type xdof_size) const;

  virtual void put_dof(pod_index_type xdof_id, const void* xdof, size_type xdof_size);
  
  
  // ===========================================================
  //  END NEW DOF ACCESS FACET
  // ===========================================================

  virtual void* dof_tuple();

  virtual const void* dof_tuple() const;

  virtual void get_dof_tuple(void* xbuf, size_t xbuflen) const;

  virtual void put_dof_tuple(const void* xbuf, size_t xbuflen);

  poset_state_handle* poset_pointer() const;

  poset_type poset_type_id() const;

  const char* poset_class() const;

  int poset_prereq_id(int xi) const;

  // ===========================================================
  // I/O SUPPORT FACET
  // ===========================================================

  void extend_to_top();


protected:

  void put_poset_pointer(const poset_state_handle* xposet);

  void put_poset_type_id(poset_type xtype_id);

  void put_poset_class(const char* xclass);

  void put_poset_prereq_id(int xi, int xid);

  virtual void allocate_dofs();

private:

  struct SHEAF_DLL_SPEC dof_struct
  {
    poset_state_handle* pointer;
    int type_id;
    const char* class_name;
    int prereq_ids[5];
  }
  _dofs;

  block<pod_index_type> _storage_map;

  static bool make_prototype();

};

} // namespace sheaf

#endif // ifndef NAMESPACE_POSET_DOF_MAP_H