namespace_poset.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 NAMESPACE_POSET_H
#define NAMESPACE_POSET_H

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

#ifndef POSET_STATE_HANDLE_H
#include "SheafSystem/poset_state_handle.h"
#endif

#ifndef NAMESPACE_POSET_DOF_MAP_H
#include "SheafSystem/namespace_poset_dof_map.h"
#endif

#ifndef NAMESPACE_POSET_SCHEMA_H
#include "SheafSystem/namespace_poset_schema.h"
#endif

#ifndef SCATTERED_INSERTION_INDEX_SPACE_HANDLE_H
#include "SheafSystem/scattered_insertion_index_space_handle.h"
#endif

#ifndef PRIMITIVES_POSET_H
#include "SheafSystem/primitives_poset.h"
#endif

#ifndef PRIMITIVES_POSET_SCHEMA_H
#include "SheafSystem/primitives_poset_schema.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

namespace sheaf
{

class namespace_poset_member;
class poset_path;
class poset;
class sheaf_file;
class storage_agent;  

class SHEAF_DLL_SPEC namespace_poset : public poset_state_handle
{

  friend class poset_state_handle;
  friend class storage_agent;

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

public:

  namespace_poset(const std::string& xname);

  virtual ~namespace_poset();

protected:

  namespace_poset();

  namespace_poset(namespace_poset_member* xtop, namespace_poset_member* xbottom);

  namespace_poset(const namespace_poset& xother) { };

  namespace_poset& operator=(const namespace_poset& xother) 
  {
    return const_cast<namespace_poset&>(*this);
  };

  namespace_poset& operator=(const poset_state_handle& xother)
  {
    return const_cast<namespace_poset&>(*this);
  };

private:

  static bool make_prototype();


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

public:

  inline primitives_poset& primitives()
  {
    return _primitives;
  };

  inline const primitives_poset& primitives() const
  {
    return _primitives;
  };

  static poset_path primitives_schema_path();

  inline primitives_poset_schema& primitives_schema()
  {
    return _primitives_schema;
  };

  inline const primitives_poset_schema& primitives_schema() const
  {
    return _primitives_schema;
  };

protected:

private:

  primitives_poset _primitives;

  primitives_poset_schema _primitives_schema;



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

public:

  bool contains_poset(pod_index_type xhub_id, bool xauto_access = true) const;

  bool contains_poset(const scoped_index& xid, bool xauto_access = true) const;

  template <typename P>
  SHEAF_DLL_SPEC
  bool contains_poset(pod_index_type xhub_id, bool xauto_access = true) const;

  template <typename P>
  SHEAF_DLL_SPEC
  bool contains_poset(const scoped_index& id, bool xauto_access = true) const;

  bool contains_poset(const poset_path& xpath, bool xauto_access = true) const;

  template <typename P>
  SHEAF_DLL_SPEC
  bool contains_poset(const poset_path& xpath, bool xauto_access = true) const;

  bool owns(const poset_state_handle& xposet, bool xauto_access) const;

  bool contains_poset_member(pod_index_type xposet_hub_id,
                             pod_index_type xmember_hub_id,
                             bool xauto_access = true) const;

  bool contains_poset_member(const scoped_index& xposet_id,
                             const scoped_index& xmember_id,
                             bool xauto_access = true) const;

  bool contains_poset_member(const poset_path& xpath, bool xauto_access = true) const;

  bool contains_poset_members(const std::string& xposet_name,
                              const std::string  xmember_names[],
                              int xmember_names_ct,
                              bool xauto_access = true) const;

  bool contains_poset_subposet(const poset_path& xpath, bool xauto_access = true) const;

  poset_state_handle& member_poset(pod_index_type xhub_id, bool xauto_access = true) const;

  poset_state_handle& member_poset(const scoped_index& xid, bool xauto_access = true) const;

  template <typename P>
  SHEAF_DLL_SPEC
  P& member_poset(pod_index_type xhub_id, bool xauto_access = true) const;

  template <typename P>
  SHEAF_DLL_SPEC
  P& member_poset(const scoped_index& xid, bool xauto_access = true) const;

  poset_state_handle& member_poset(const poset_path& xpath, bool xauto_access = true) const;

  template <typename P>
  SHEAF_DLL_SPEC
  P& member_poset(const poset_path& xpath, bool xauto_access = true) const;

  pod_index_type member_poset_schema_id(const scoped_index& xindex, bool xauto_access) const;

  void delete_poset(pod_index_type xhub_id, bool xauto_access);

  void delete_poset(scoped_index xid, bool xauto_access);

  void delete_poset(std::string xname, bool xauto_access);

  void delete_poset(poset_path xpath, bool xauto_access);

  void delete_poset(namespace_poset_member& xmbr);

protected:

  scoped_index insert_poset(const poset_state_handle& xposet,
                const std::string& xposet_name,
                bool xauto_link);

  scoped_index insert_poset(const poset_state_handle& xposet,
                const std::string& xposet_name,
                bool xauto_link,
                            bool xauto_access);

  virtual void link_poset(const namespace_poset_member& xmbr);

private:


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

public:

  bool contains_path(const poset_path& xpath, bool xauto_access = true) const;

  template <typename P>
  bool contains_path(const poset_path& xpath, bool xauto_access = true) const;

  bool path_is_auto_read_accessible(const poset_path& xpath, bool xauto_access) const;

  template <typename P>
  bool path_is_auto_read_accessible(const poset_path& xpath, bool xauto_access) const;

  bool path_is_auto_read_write_accessible(const poset_path& xpath, bool xauto_access) const;

  template <typename P>
  bool path_is_auto_read_write_accessible(const poset_path& xpath, bool xauto_access) const;

  template <typename P>
  bool path_is_available(const poset_path& xpath, bool xauto_access) const;

  bool path_is_auto_read_available(const poset_path& xpath, bool xauto_access) const;

  template <typename P>
  bool path_is_auto_read_available(const poset_path& xpath, bool xauto_access) const;

  bool path_is_auto_read_write_available(const poset_path& xpath, bool xauto_access) const;

  template <typename P>
  bool path_is_auto_read_write_available(const poset_path& xpath, bool xauto_access) const;

  bool poset_state_is_read_accessible(const poset_path& xpath, bool xauto_access = true) const;

  bool poset_state_is_read_write_accessible(const poset_path& xpath, bool xauto_access = true) const;

protected:

private:



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

public:

  static namespace_poset* current_namespace();

  void put_current_namespace(namespace_poset* xns);

protected:

private:

  static namespace_poset* _current_namespace;

  

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

public: 

  static void initialize_prototypes();

  static void initialize_poset_prototypes();

  static void initialize_crg_interval_prototypes();

  static void initialize_dof_map_prototypes();

  static void initialize_id_space_prototypes();

protected:

  virtual void virtual_initialize_prototypes();

private:



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

public:

  virtual poset_type type_id() const;

  virtual const char* class_name() const;

  virtual void begin_jim_edit_mode(bool xauto_access = true);

  virtual void end_jim_edit_mode(bool xensure_lattice_invariant = true,
                                 bool xauto_access = true);

  virtual void get_read_access() const;

  virtual void get_read_write_access(bool xrelease_read_only_access = false);

  virtual void release_access(bool xall = false) const;

protected:

  using poset_state_handle::new_state;

  void new_state(const std::string& xname);

  virtual void detach_from_state();

  virtual void attach_handle_data_members();

private:



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

public:

  virtual std::string name() const;

  virtual std::string name(bool xauto_access) const;

  virtual poset_path path(bool xauto_access = true) const;

protected:

  using poset_state_handle::initialize_namespace;

  virtual void initialize_namespace(namespace_poset& xns, bool xauto_link = true);

private:



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

public:

  typedef namespace_poset_schema schema_type;

  inline namespace_poset_schema& namespace_schema()
  {
    return _namespace_schema;
  };

  inline const namespace_poset_schema& namespace_schema() const
  {
    return _namespace_schema;
  };

  virtual bool row_dof_map_conforms(const poset_dof_map* xdof_map) const;

  virtual namespace_poset_dof_map& row_dof_map(pod_index_type xtuple_hub_id,
                           bool xrequire_write_access = false) const;

  virtual const scoped_index& new_row_dof_map();

protected:

  namespace_poset_schema _namespace_schema;

private:



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

public:

  namespace_poset_member& top();

  const namespace_poset_member& top() const;

  namespace_poset_member& bottom();

  const namespace_poset_member& bottom() const;

  void clear();

protected:

  virtual void initialize_standard_members();

  virtual void initialize_additional_members();

private:


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

public:

  const index_space_handle& get_member_poset_id_space(bool xauto_access) const;

  void release_member_poset_id_space(index_space_handle& xid_space, bool xauto_access) const;

  index_space_iterator& get_member_poset_id_space_iterator(bool xauto_access) const;

  void release_member_poset_id_space_iterator(index_space_iterator& xid_space, bool xauto_access) const;

protected:

  void initialize_member_poset_id_space();

private:

 

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

public:

  virtual pod_index_type prereq_id(int xi) const;  

protected:

  void put_name(const std::string& xname);

private:



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

public:

  void to_stream(std::ostream& xos = std::cout);


  std::string to_string();

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  namespace_poset* clone() const;

  bool invariant() const;

protected:

private:

};


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

SHEAF_DLL_SPEC 
std::ostream & operator << (std::ostream &os, const namespace_poset& p);

SHEAF_DLL_SPEC 
size_t deep_size(const namespace_poset& xp, bool xinclude_shallow = true, size_t xresults[4] = 0);
 
} // namespace sheaf

#endif // ifndef NAMESPACE_POSET_H