explicit_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 EXPLICIT_INDEX_SPACE_HANDLE_H
#define EXPLICIT_INDEX_SPACE_HANDLE_H

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

#ifndef INDEX_SPACE_HANDLE_H
#include "SheafSystem/index_space_handle.h"
#endif

namespace sheaf
{

class explicit_index_space_state;
class index_space_family;

class SHEAF_DLL_SPEC explicit_index_space_handle : public index_space_handle
{

  friend class explicit_index_space_state;

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

public:

  explicit_index_space_handle();

  explicit_index_space_handle(const explicit_index_space_handle& xother);

  explicit_index_space_handle(const index_space_family& xid_spaces,
                  pod_type xindex);

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

  explicit_index_space_handle& operator=(const explicit_index_space_handle& xother);

  virtual ~explicit_index_space_handle();

protected:

  explicit_index_space_state& state();

  const explicit_index_space_state& state() const;

  explicit_index_space_state* _state;

private:



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

public:

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

  virtual explicit_index_space_handle* clone() const;

protected:

private:



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

public:

  virtual const index_space_family& id_spaces() const;

  virtual index_space_family& id_spaces();

  virtual size_type ct() const;

  virtual pod_type begin() const;

  virtual pod_type end() const;

  using index_space_handle::contains;

  virtual bool contains(pod_type xid) const;

  virtual bool contains_unglued_hub(pod_type xid) const;

  virtual bool contains_glued_hub(pod_type xid) const;

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

  using index_space_handle::pod;

  virtual pod_type pod(pod_type xid) const;

  virtual pod_type unglued_hub_pod(pod_type xid) const;

  virtual pod_type glued_hub_pod(pod_type xid) const;

  virtual bool is_persistent() const;

protected:

private:



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

public:

  virtual void new_product_structure(const abstract_product_structure& xproduct);

  virtual void delete_product_structure();

  using index_space_handle::product_structure;

  virtual const abstract_product_structure& product_structure() const;

  virtual abstract_product_structure& product_structure();

  virtual bool has_product_structure() const;

protected:

private:



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

public:

  virtual const index_space_collection& host() const;

  virtual pod_type index() const;

  virtual bool is_attached() const;

  using index_space_handle::attach_to;

  virtual void attach_to(pod_type xindex);

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

  virtual void detach();

  using index_space_handle::conforms_to_state;

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

protected:

  void attach_to(explicit_index_space_state* xstate);

  virtual bool conforms_to_state(explicit_index_space_state* xstate) const;

  explicit_index_space_state* state(pod_type xindex) const;

  explicit_index_space_state* state(const index_space_collection& xhost,
                    pod_type xlocal_id) const;

private:



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

public:

  virtual index_space_handle& get_id_space() const;

  virtual void release_id_space() const;

  virtual bool allocated_id_space() const;

protected:

private:



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

public:

  virtual index_space_iterator& get_iterator() const;

  virtual void release_iterator(index_space_iterator& xitr) const;

  virtual bool allocated_iterator(const index_space_iterator& xitr) const;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // end namespace sheaf

#endif // ifndef EXPLICIT_INDEX_SPACE_HANDLE_H