product_section_space_schema_member.h

Go to the documentation of this file.

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


#ifndef PRODUCT_SECTION_SPACE_SCHEMA_MEMBER_H
#define PRODUCT_SECTION_SPACE_SCHEMA_MEMBER_H

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

#ifndef SECTION_SPACE_SCHEMA_MEMBER_H
#include "SheafSystem/section_space_schema_member.h"
#endif

namespace fiber_bundle
{

class product_section_space_schema_poset;
class sec_rep_descriptor;

class SHEAF_DLL_SPEC product_section_space_schema_member : public section_space_schema_member
{
  // ===========================================================
  // ===========================================================

public:

  product_section_space_schema_member();

  explicit product_section_space_schema_member(const product_section_space_schema_member& xother);

  virtual product_section_space_schema_member& operator=(const abstract_poset_member& xother);

  product_section_space_schema_member& operator=(const product_section_space_schema_member& xother);

  virtual ~product_section_space_schema_member();

  inline product_section_space_schema_member* clone(bool xnew_state,
      bool xauto_access = true) const
  {
    return static_cast<product_section_space_schema_member*>
           (section_space_schema_member::clone(xnew_state, xauto_access));
  }

  // NEW HANDLE, NEW STATE CONSTRUCTORS

  explicit product_section_space_schema_member(poset* xhost,
                           array_poset_dof_map* xdof_map = 0,
                           bool xcopy_dof_map = false,
                           bool xauto_access = true);

  product_section_space_schema_member(poset* xhost,
                      const scoped_index& xdof_tuple_id,
                      bool xauto_access);

  product_section_space_schema_member(poset* xhost,
                      scoped_index* xexpansion,
                      int xexpansion_ct,
                      const tern& xnew_jem,
                      bool xauto_access);

  // NEW HANDLE, EXISTING STATE CONSTRUCTORS

  product_section_space_schema_member(const product_section_space_schema_poset* xhost,
                      pod_index_type xhub_id);

  product_section_space_schema_member(const product_section_space_schema_poset* xhost,
                      const scoped_index& xid);

  product_section_space_schema_member(const product_section_space_schema_poset* xhost,
                                     const std::string& xname);

  product_section_space_schema_member(const product_section_space_schema_poset* xhost,
                                     pod_index_type xbase_space_id,
                                     pod_index_type xfiber_schema_id);


  product_section_space_schema_member(const product_section_space_schema_poset* xhost,
                                     const scoped_index& xbase_space_id,
                                     const scoped_index& xfiber_schema_id);


  product_section_space_schema_member(const product_section_space_schema_poset* xhost,
                                     const poset_path& xbase_path,
                                     const poset_path& xfiber_schema_path);

  product_section_space_schema_member(const namespace_poset& xns,
                                     const poset_path& xpath,
                                     bool xauto_access = true);


  // EXISTING HANDLE, NEW STATE "CONSTRUCTORS"

  // None - section_space_schema_member is immutable

protected:

  void update_row_cache_without_disc_id_space() const;

  void update_row_cache_with_disc_id_space() const;

  void update_row_dof_id_space() const;  

private:



  // ===========================================================
  // ===========================================================

public:

protected:

private:



  // ===========================================================
  // ===========================================================

public:

//   ///
//   /// The type of table dofs (xis_table_dof == true) or
//   /// row dofs (xis_table_dof == false) defined by this schema.
//   /// Returns NOT_A_PRIMITIVE_TYPE if the dofs are
//   /// not all the same type.
//   ///
//   virtual primitive_type dof_tuple_type(bool xis_table_dof) const;

//   ///
//   /// The number of bytes in this dof
//   ///
//   virtual size_t size() const;

//   ///
//   /// The alignment for this dof
//   ///
//   virtual size_t alignment() const;

//   ///
//   /// The primitive type index of the dof defined by this.
//   ///
//   virtual sheaf::primitive_type type() const;

//   ///
//   /// True if this is in the table dofs part (xin_table_dofs == true)
//   /// or in the row dofs part (xin_table_dofs == false) of some schema.
//   ///
//   virtual bool is_dof(bool xin_table_dofs) const;

  virtual poset_dof_iterator* dof_iterator(bool xis_table_dofs,
                       int xversion = CURRENT_MEMBER_VERSION) const;

protected:

  virtual dof_descriptor_array* dof_descriptors(bool xis_table_dof) const;

  virtual void update_row_cache(bool xupdate_id_space = false) const;

private:



  // ===========================================================
  // ===========================================================

public:
 
  using schema_poset_member::size;
  
  virtual size_type size(pod_index_type xdof_id,
             bool xis_table_dof) const;
 
  virtual size_type size(pod_index_type xdisc_id, 
             pod_index_type xfiber_dof_id, 
             bool xis_table_dof) const;

  virtual size_type size(const scoped_index& xdisc_id,
             const scoped_index& xfiber_dof_id,
             bool xis_table_dof,
             bool xauto_access) const;

  using schema_poset_member::alignment;

  virtual size_type alignment(pod_index_type xdof_id,
                  bool xis_table_dof) const;

  virtual size_type alignment(pod_index_type xdisc_id,
                  pod_index_type xfiber_dof_id,
                  bool xis_table_dof) const;

  virtual size_type alignment(const scoped_index& xdisc_id,
                  const scoped_index& xfiber_dof_id,
                  bool xis_table_dof,
                  bool xauto_access) const;

  using schema_poset_member::type;

  virtual primitive_type type(pod_index_type xdof_id,
                  bool xis_table_dof) const;

  virtual primitive_type type(pod_index_type xdisc_id,
                  pod_index_type xfiber_dof_id,
                  bool xis_table_dof) const;

  virtual primitive_type type(const scoped_index& xdisc_id,
                  const scoped_index& xfiber_dof_id,
                  bool xis_table_dof, 
                  bool xauto_access) const;

  using schema_poset_member::offset;

  virtual size_type offset(pod_index_type xdof_id,
               bool xis_table_dof) const;

  virtual size_type offset(pod_index_type xdisc_id,
               pod_index_type xfiber_dof_id,
               bool xis_table_dof) const;

  virtual size_type offset(const scoped_index& xdisc_id,
               const scoped_index& xfiber_dof_id,
               bool xis_table_dof, 
               bool xauto_access) const;

protected:
 
private:



  // ===========================================================
  // ===========================================================

public:

  virtual index_iterator* get_decomposition(pod_index_type xindex) const;


//   ///
//   /// Gets the internal id corresponding to xext_id in the id space
//   /// with name xid_space_name.
//   /// @hack the product subposet hack, version 2.
//   /// This member exists only to encapsulate the hack.
//   ///
//   virtual pod_index_type get_int_id(pod_index_type xext_id,
//                  const std::string& xid_space_name) const;

  virtual void get_ext_ids(const std::string& xid_space_name,
                           pod_index_type& xschema_poset_ext_id,
                           pod_index_type& xschema_member_ext_id,
                           pod_index_type& xbase_space_ext_id,
                           pod_index_type& xfiber_schema_ext_id,
                           pod_index_type& xlocal_schema_ext_id) const;


  virtual schema_poset_member& ext_data_type_schema();

  virtual size_t ext_data_type_ct(bool xis_table_schema) const;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual primitives_poset_dof_map& dof_map(bool xrequire_write_access = false);

  virtual const primitives_poset_dof_map& dof_map(bool xrequire_write_access = false) const;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  inline product_section_space_schema_member* greatest_jem() const
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::greatest_jem());
  };

  inline product_section_space_schema_member* least_jem() const
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::least_jem());
  };

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  inline product_section_space_schema_member* p_join(abstract_poset_member* other) const
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::p_join(other));
  };

  inline product_section_space_schema_member* p_meet(abstract_poset_member* other)
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::p_meet(other));
  };

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  inline product_section_space_schema_member* l_join(abstract_poset_member* other, bool xnew_jem = true)
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::l_join(other, xnew_jem));
  };

  inline product_section_space_schema_member* l_meet(abstract_poset_member* other, bool xnew_jem = true)
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::l_meet(other, xnew_jem));
  };

  inline product_section_space_schema_member* l_not(bool xnew_jem = true) const
  {
    return static_cast<product_section_space_schema_member*>(abstract_poset_member::l_not(xnew_jem));
  };

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  inline product_section_space_schema_poset* host() const
  {
    return reinterpret_cast<product_section_space_schema_poset*>(section_space_schema_member::host());
  }

  virtual bool host_is_ancestor_of(const poset_state_handle* other) const;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual product_section_space_schema_member* clone() const;

  virtual bool invariant() const;

protected:

private:

};

} // namespace fiber_bundle

#endif // PRODUCT_SECTION_SPACE_SCHEMA_MEMBER_H