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

#ifndef PRIMITIVES_POSET_DOF_MAP_H
#define PRIMITIVES_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

#ifndef PRIMITIVE_TYPE_H
#include "SheafSystem/primitive_type.h"
#endif

namespace sheaf
{

class dof_map_factory;
class primitives_poset;
  
class SHEAF_DLL_SPEC primitives_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

  primitives_poset_dof_map();

  virtual primitives_poset_dof_map* clone() const;

  primitives_poset_dof_map(const primitives_poset_dof_map& xother);

  virtual primitives_poset_dof_map* copy() const;

  primitives_poset_dof_map& operator=(const primitives_poset_dof_map& xother);

  virtual ~primitives_poset_dof_map();

  virtual bool invariant() const;

  // OTHER CONSTRUCTORS

  primitives_poset_dof_map(const poset_state_handle* xhost, int xprimitive_index);

  virtual void init_row_dof_map(const poset_state_handle* xhost,
                                pod_index_type xschema_mbr_id,
                                int xschema_version);

  // MAP INTERFACE

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

  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;

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

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

  size_t size() const;

  void put_size(size_t xsize);

  size_t alignment() const;

  void put_alignment(size_t xalignment);

  primitive_type type() const;

  void put_type(int xindex);

protected:

  virtual void put_host(const poset_state_handle* xhost);

  virtual void allocate_dofs() {};


private:

  primitive_descriptor _dofs;

  static bool make_prototype();

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

} // namespace sheaf

#endif // ifndef PRIMITIVES_POSET_DOF_MAP_H