binary_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 BINARY_SECTION_SPACE_SCHEMA_MEMBER_H
#define BINARY_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

#ifndef BINARY_SECTION_COMPONENT_ITERATOR_H
#include "SheafSystem/binary_section_component_iterator.h"
#endif

#ifndef BINARY_SECTION_DOF_ITERATOR_H
#include "SheafSystem/binary_section_dof_iterator.h"
#endif

// #ifndef BINARY_SECTION_SPACE_SCHEMA_POSET_H
// #include "SheafSystem/binary_section_space_schema_poset.h"
// #endif

// #ifndef CLIENT_INDEX_H
// #include "SheafSystem/client_index.h"
// #endif

namespace fiber_bundle
{

  class binary_section_space_schema_poset;
  class sec_rep_descriptor;

class SHEAF_DLL_SPEC binary_section_space_schema_member : public section_space_schema_member
{

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

public:

  typedef binary_section_space_schema_poset host_type;

  static const poset_path& standard_schema_path();

  static void make_standard_schema(namespace_poset& xns);
  
  static host_type& new_host(namespace_type& xns, 
                              const poset_path& xhost_path, 
                              const poset_path& xschema_path,
                              const poset_path& xbase_path,
                              const poset_path& xfiber_path,
                              const poset_path& xrep_path,
                              bool xauto_access);
 
  template <typename S>
  static poset_path standard_host_path(const poset_path& xbase_path, 
                                       const poset_path& xrep_path, 
                                       const std::string& xfiber_suffix);
 
  template <typename S>
  static poset_path standard_member_path(const poset_path& xbase_path, 
                                         const poset_path& xrep_path, 
                                         const std::string& xfiber_suffix);

  template <typename S>
  static bool standard_host_is_available(namespace_poset& xns,
                                         const poset_path& xbase_path, 
                                         const poset_path& xrep_path, 
                                         const std::string& xfiber_suffix,
                                         bool xauto_access);
  
  template <typename S>
  static host_type& standard_host(namespace_type& xns, 
                                  const poset_path& xbase_path,
                                  const poset_path& xrep_path,
                                  const std::string& xfiber_suffix,
                                  bool xauto_access);

  
  template <typename S>
  static poset_path standard_member(namespace_type& xns, 
                                    const poset_path& xbase_path,
                                    const poset_path& xrep_path,
                                    const std::string& xfiber_suffix,
                                    bool xauto_access);

protected:

private:

 

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

public:

  binary_section_space_schema_member();

  explicit binary_section_space_schema_member(const binary_section_space_schema_member& xother);

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

  binary_section_space_schema_member& operator=(const binary_section_space_schema_member& xother);

  virtual ~binary_section_space_schema_member();

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

  // NEW HANDLE, NEW STATE CONSTRUCTORS

  // None - section_space_schema_poset is immutable.

  // NEW HANDLE, EXISTING STATE CONSTRUCTORS

  binary_section_space_schema_member(const binary_section_space_schema_poset* xhost,
                                     pod_index_type xhub_id);

  binary_section_space_schema_member(const binary_section_space_schema_poset* xhost,
                                     const scoped_index& xid);

  binary_section_space_schema_member(const binary_section_space_schema_poset* xhost,
                                     const std::string& xname);

  binary_section_space_schema_member(const binary_section_space_schema_poset* xhost,
                                     pod_index_type xbase_space_id,
                                     pod_index_type xfiber_schema_id);


  binary_section_space_schema_member(const binary_section_space_schema_poset* xhost,
                                     const scoped_index& xbase_space_id,
                                     const scoped_index& xfiber_schema_id);


  binary_section_space_schema_member(const binary_section_space_schema_poset* xhost,
                                     const poset_path& xbase_path,
                                     const poset_path& xfiber_schema_path);

  binary_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:

private:



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

public:

  virtual binary_section_component_iterator* component_iterator() const;

protected:

private:



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

public:

  virtual primitive_type dof_tuple_type(bool xis_table_dof) const;

  virtual dof_descriptor_array* dof_descriptors(bool xis_table_dof) const;

  virtual bool is_dof(bool xin_table_dofs) const;

  using section_space_schema_member::size;
  
  virtual size_t size() const;

  using section_space_schema_member::alignment;
  
  virtual size_t alignment() const;

  using section_space_schema_member::type;
  
  virtual sheaf::primitive_type type() const;

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

  inline binary_section_dof_iterator* table_dof_iterator(int xversion = CURRENT_MEMBER_VERSION) const
  {
    return dof_iterator(true, xversion);
  };

  inline binary_section_dof_iterator* row_dof_iterator(int xversion = CURRENT_MEMBER_VERSION) const
  {
    return dof_iterator(false, xversion);
  };

protected:

  virtual void update_row_cache(bool xupdate_id_map = false) const;

private:



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

public:

  virtual index_iterator* get_decomposition(pod_index_type xindex) const;

  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 binary_section_space_schema_member* greatest_jem() const
  {
    return static_cast<binary_section_space_schema_member*>(abstract_poset_member::greatest_jem());
  };

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

protected:

private:



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

public:

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

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

protected:

private:



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

public:

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

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

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

protected:

private:



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

public:

  using section_space_schema_member::attach_to_state;

  virtual void attach_to_state(pod_index_type xbase_space_id,
                               pod_index_type xfiber_schema_id);

  virtual void attach_to_state(const section_space_schema_poset* xhost,
                               pod_index_type xbase_space_id,
                               pod_index_type xfiber_schema_id);


  virtual void attach_to_state(const section_space_schema_poset* xhost,
                               const poset_path& xbase_path,
                               const poset_path& xfiber_schema_path);

protected:

private:



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

public:

  inline binary_section_space_schema_poset* host() const
  {
    return reinterpret_cast<binary_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 binary_section_space_schema_member* clone() const;

  virtual bool invariant() const;

protected:

private:

};

} // namespace fiber_bundle

#endif // BINARY_SECTION_SPACE_SCHEMA_MEMBER_H