index_space_family_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_FAMILY_ITERATOR_H
#define INDEX_SPACE_FAMILY_ITERATOR_H

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

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

#ifndef INDEX_SPACE_FAMILY_H
#include "SheafSystem/index_space_family.h"
#endif

#ifndef INDEX_SPACE_INTERVAL_ITERATOR_H
#include "SheafSystem/index_space_interval_iterator.h"
#endif

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

namespace sheaf
{

class SHEAF_DLL_SPEC index_space_family_iterator : public any
{

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

public:

  typedef pod_index_type pod_type;

  index_space_family_iterator(const index_space_family& xid_spaces,
                  bool xonly_persistent);

  virtual ~index_space_family_iterator();

  index_space_family_iterator& operator=(const index_space_family_iterator& xother);

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

  index_space_family_iterator* clone() const;

  bool only_persistent() const;

  void next();

  bool is_done() const;

  void reset();

  const index_space_interval& host() const;

  pod_type index() const;

  std::string name() const;

protected:

  index_space_family_iterator() { };

  index_space_family_iterator(const index_space_family_iterator& xother);

  void next_id_space();

  typedef index_space_family::interval_map_type interval_map_type;

  typedef interval_map_type::const_iterator const_interval_iterator_type;

  const index_space_family* _id_spaces;

  const_interval_iterator_type _interval_itr;

  index_space_interval_iterator _id_space_itr;

private:



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

public:

  const index_space_family& id_spaces() const;

  const hub_index_space_handle& hub_id_space() const;

  size_type ct() const;

  pod_type begin() const;

  pod_type end() const;

  bool contains(pod_type xid) const;

  bool contains_hub(pod_type xid) const;

  bool contains_unglued_hub(pod_type xid) const;

  bool contains_glued_hub(pod_type xid) const;

  bool contains(pod_type xid, pod_type xhub_id) const;

  pod_type pod(pod_type xid) const;

  pod_type hub_pod(pod_type xid) const;

  pod_type unglued_hub_pod(pod_type xid) const;

  pod_type glued_hub_pod(pod_type xid) const;

  bool is_persistent() const;

protected:

private:



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

public:

  index_space_handle& get_id_space() const;

  void release_id_space(index_space_handle& xid_space) const;

  bool allocated_id_space(index_space_handle& xid_space) const;

protected:

private:



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

public:

  index_space_iterator& get_id_space_iterator() const;

  void release_id_space_iterator(index_space_iterator& xitr) const;

  bool allocated_id_space_iterator(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
// ===========================================================

} // namespace sheaf

#endif // ifndef INDEX_SPACE_FAMILY_ITERATOR_H