index_equivalence_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_EQUIVALENCE_ITERATOR_H
#define INDEX_EQUIVALENCE_ITERATOR_H

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

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

#ifndef INDEX_EQUIVALENCE_CLASS_H
#include "SheafSystem/index_equivalence_class.h"
#endif

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

namespace sheaf
{

class index_space_family;

class SHEAF_DLL_SPEC index_equivalence_iterator : public any
{

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

public:

  typedef index_equivalence_class::member_type member_type;

  index_equivalence_iterator(const index_space_family& xid_spaces,
                 pod_index_type xrep_id,
                 bool xonly_persistent,
                 bool xsort_ids);

  index_equivalence_iterator(const index_space_family& xid_spaces,
                 const scoped_index& xrep_id,
                 bool xonly_persistent,
                 bool xsort_ids);

  index_equivalence_iterator(const index_space_family& xid_spaces,
                 bool xonly_persistent,
                 bool xsort_ids);

  virtual ~index_equivalence_iterator();

  const index_space_family& id_spaces() const;

  pod_index_type rep_id() const;

  void rep_id(scoped_index& result) const;

  bool only_persistent() const;

  bool is_sorted() const;

  void put_rep_id(pod_index_type xrep_id);

  void put_rep_id(const scoped_index& xrep_id);

  const member_type& item() const;

  bool is_done() const;

  size_type ct() const;

  void next();

  void reset();

protected:

  typedef index_equivalence_class::list_type::const_iterator iterator_type;

  index_equivalence_iterator() { };

  const index_space_family* _id_spaces;

  pod_index_type _rep_id;

  bool _only_persistent;

  bool _is_sorted;

  index_equivalence_class _equivalence_class;

  iterator_type _itr;

  iterator_type _end;

  member_type _item;

  bool _is_done;

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual index_equivalence_iterator* clone() const;

  index_equivalence_iterator& operator=(const index_equivalence_iterator& xother);

  virtual bool invariant() const;

protected:

private:


};

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

#endif // ifndef INDEX_EQUIVALENCE_ITERATOR_H