index_space_handle.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 INDEX_SPACE_HANDLE_H
#define INDEX_SPACE_HANDLE_H

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

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef POD_TYPES_H
#include "SheafSystem/pod_types.h"
#endif

namespace sheaf
{

class abstract_product_structure;
class hub_index_space_handle;
class index_space_collection;
class index_space_family;
class index_space_iterator;
class scoped_index;

class SHEAF_DLL_SPEC index_space_handle : public any
{

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

public:

  typedef pod_index_type pod_type;

  virtual ~index_space_handle();

  virtual index_space_handle& operator=(const index_space_handle& xother);

  bool operator==(const index_space_handle& xother) const;

  virtual index_space_handle* clone() const = 0;

protected:

  index_space_handle();

  index_space_handle(const index_space_handle& xother) { };

private:



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

public:

  virtual const index_space_family& id_spaces() const = 0;

  virtual index_space_family& id_spaces() = 0;

  const hub_index_space_handle& hub_id_space() const;

  virtual size_type ct() const = 0;

  bool is_empty() const;

  virtual pod_type begin() const = 0;

  virtual pod_type end() const = 0;

  bool is_gathered() const;
    
  virtual bool contains(pod_type xid) const = 0;

  bool contains(const scoped_index& xid) const;

  bool contains_hub(pod_type xid) const;

  virtual bool contains_unglued_hub(pod_type xid) const = 0;

  virtual bool contains_glued_hub(pod_type xid) const = 0;

  bool contains(pod_type xid, const scoped_index& xhub_id) const;

  virtual bool contains(pod_type xid, pod_type xhub_id) const = 0;

  virtual pod_type pod(pod_type xid) const = 0;

  pod_type pod(const scoped_index& xid) const;

  pod_type hub_pod(pod_type xid) const;

  virtual pod_type unglued_hub_pod(pod_type xid) const = 0;

  virtual pod_type glued_hub_pod(pod_type xid) const = 0;

  virtual bool is_persistent() const = 0;

protected:

private:



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

public:

  virtual void new_product_structure(const abstract_product_structure& xproduct) = 0;

  virtual void delete_product_structure() = 0;

  virtual const abstract_product_structure& product_structure() const = 0;

  virtual abstract_product_structure& product_structure() = 0;

  template<typename T>
  const T& product_structure() const;

  template<typename T>
  T& product_structure();

  virtual bool has_product_structure() const = 0;

  template<typename T>
  bool product_structure_conforms_to() const;

protected:

private:



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

public:

  virtual const index_space_collection& host() const = 0;

  virtual pod_type index() const = 0;

  std::string name() const;

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

  virtual bool is_attached() const = 0;

  void attach_to(const index_space_family& xid_spaces, pod_type xindex);

  void attach_to(const index_space_family& xid_spaces, const std::string& xname);

  virtual void attach_to(pod_type xindex) = 0;

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

  void attach_to(const index_space_handle& xother);

  bool conforms_to_state(const index_space_family& xid_spaces,
             pod_type xindex) const;

  bool conforms_to_state(const index_space_family& xid_spaces,
             const std::string& xname) const;

  bool conforms_to_state(pod_type xid) const;

  bool conforms_to_state(const std::string& xname) const;

  bool conforms_to_state(const index_space_handle& xother) const;

  virtual void attach_to(const index_space_collection& xhost,
             pod_type xlocal_id) = 0;

  virtual void detach() = 0;

  virtual bool conforms_to_state(const index_space_collection& xhost,
                 pod_type xlocal_id) const = 0;

protected:

private:



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

public:

  virtual index_space_handle& get_id_space() const = 0;

  virtual void release_id_space() const = 0;

  virtual bool allocated_id_space() const = 0;

protected:

private:



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

public:

  virtual index_space_iterator& get_iterator() const = 0;

  virtual void release_iterator(index_space_iterator& xitr) const = 0;

  virtual bool allocated_iterator(const index_space_iterator& xitr) const = 0;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
SHEAF_DLL_SPEC 
std::ostream & operator << (std::ostream &xos, const index_space_handle& xi);

SHEAF_DLL_SPEC 
size_t deep_size(const index_space_handle& xn, bool xinclude_shallow = true);
  
} // end namespace sheaf

#endif // ifndef INDEX_SPACE_HANDLE_H