index_space_iterator.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_ITERATOR_H
#define INDEX_SPACE_ITERATOR_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 hub_index_space_handle;
class index_space_collection;
class index_space_family;
class index_space_handle;

class SHEAF_DLL_SPEC index_space_iterator : public any
{

  friend class explicit_index_space_state;
  friend class index_space_collection;
  friend class index_space_handle;

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

public:

  typedef pod_index_type pod_type;

  virtual ~index_space_iterator();

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

  virtual bool operator==(const index_space_iterator& xother) const;

  virtual index_space_iterator* clone() const = 0;

protected:

  index_space_iterator();

  index_space_iterator(const index_space_iterator& xother);

private:



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

public:

  virtual void next() = 0;

  bool is_done() const;

  virtual void reset() = 0;

  void force_is_done();

protected:

  bool _is_done;

private:



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

public:

  pod_type pod() const;

  pod_type hub_pod() const;

  pod_type unglued_hub_pod() const;

  pod_type glued_hub_pod() const;

protected:

  void invalidate_ids();  

  pod_type _pod;

  pod_type _hub_pod;

private:



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

public:

  const index_space_family& id_spaces() const;

  const hub_index_space_handle& hub_id_space() const;

protected:

private:



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

public:

  virtual const index_space_collection& host() const = 0;

  virtual pod_type index() const = 0;

  std::string name() const;

  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& xid_space);

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

  virtual void detach() = 0;

  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;

  virtual bool conforms_to_state(const index_space_collection& xhost,
                 pod_type xlocal_id) 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 
size_t deep_size(const index_space_iterator& xn, bool xinclude_shallow = true);
  
} // namespace sheaf

#endif // ifndef INDEX_SPACE_ITERATOR_H