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

#ifndef ARRAY_POSET_DOF_MAP_H
#define ARRAY_POSET_DOF_MAP_H

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

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

namespace sheaf
{
  
class dof_descriptor_array;
class dof_map_factory;
class poset_dof_iterator;
class schema_poset_member;

class SHEAF_DLL_SPEC array_poset_dof_map : public poset_dof_map
{

  friend class namespace_poset;

public:

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

  static const std::string& static_class_name();

  // CANONICAL MEMBERS

  array_poset_dof_map();

  virtual array_poset_dof_map* clone() const;

  array_poset_dof_map(const array_poset_dof_map& xother);

  virtual array_poset_dof_map* copy() const;

  array_poset_dof_map& operator=(const array_poset_dof_map& xother);

  virtual ~array_poset_dof_map();

  virtual bool invariant() const;

  // OTHER CONSTRUCTORS

  array_poset_dof_map(const poset_state_handle* xhost,
                      bool xis_table_dof_map,
                      void* xdofs = 0,
                      size_t xdofs_ub = 0);

  array_poset_dof_map(const schema_poset_member* xschema, bool xis_table_dof_map);

  // ===========================================================
  // MAP FACET
  // ===========================================================

  virtual dof_tuple_type type_id() const;

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

  // ===========================================================
  //  NEW DOF ACCESS FACET
  // ===========================================================
 
  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;

  using poset_dof_map::get_dof_tuple;

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

  using poset_dof_map::put_dof_tuple;

  virtual void put_dof_tuple(const void* xbuf, size_t xbuflen);
  
  char* dof_ptr(const schema_poset_member& xschema_mbr);

  char* dof_ptr(int xclient_id);

  inline char* dofs()
  {
    return static_cast<char*>(dof_tuple());
  }

  inline const char* dofs() const
  {
    return static_cast<const char*>(dof_tuple());
  }


protected:

  void init_dofs(void* xdofs);

  virtual void allocate_dofs();

  bool dof_in_bounds(pod_index_type xdof_id) const;

private:

  dof_descriptor_array* _dof_descriptors;

  char* _dofs;

  bool _this_owns_dofs;

  static bool make_prototype();

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // namespace sheaf

#endif // ifndef ARRAY_POSET_DOF_MAP_H