poset_dof_iterator.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//

// Interface for class poset_dof_iterator

#ifndef POSET_DOF_ITERATOR_H
#define POSET_DOF_ITERATOR_H

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

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

#ifndef POSTORDER_ITERATOR_H
#include "SheafSystem/postorder_iterator.h"
#endif

namespace sheaf
{

class subposet;
class schema_poset_member;
class zn_to_bool;
  
class SHEAF_DLL_SPEC poset_dof_iterator : public any
{

public:

  // CANONICAL MEMBERS

  poset_dof_iterator();

  poset_dof_iterator(const poset_dof_iterator& xother);

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

  virtual ~poset_dof_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual poset_dof_iterator* clone() const;

  virtual bool invariant() const;

  // SOME USEFUL CONSTANTS


  enum anchor_version_index
  {
    ANCHOR_VERSION = CURRENT_MEMBER_VERSION,
    ANCHOR_HOST_VERSION = CURRENT_HOST_VERSION
  };

  // OTHER CONSTRUCTORS

  explicit poset_dof_iterator(const schema_poset_member& xanchor,
                              bool xis_table_dof = false,
                              int xversion = ANCHOR_VERSION);

  // ITERATOR FACET

  virtual bool is_initialized() const;

  // Anchor is not virtual; descendant redefinitions
  // with covariant signature hide this version.

  schema_poset_member& anchor();

  const schema_poset_member& anchor() const;

  virtual void put_anchor(const schema_poset_member* xanchor, int xversion);

  virtual void put_anchor(pod_index_type xindex);

  void put_anchor(const scoped_index& xid);

  virtual bool is_done() const;

  virtual void force_is_done();

  virtual void next();

  virtual void reset(bool xreset_markers = RESET);

  virtual int ct(bool xreset = false);

  virtual bool has_visited(pod_index_type xhub_id) const;

  bool has_visited(const scoped_index& xindex) const;

  virtual bool has_visited(const schema_poset_member& xmbr) const;

  virtual void put_has_visited(pod_index_type xhub_id, bool xvalue);

  void put_has_visited(const scoped_index& xid, bool xvalue);

  // DOF ITERATOR FACET

  // Item is not virtual; descendant redefinitions
  // with covariant signature hide this version.

  schema_poset_member& item();

  const schema_poset_member& item() const;

  virtual bool item_is_ancestor_of(const schema_poset_member& xmbr) const;

  virtual const scoped_index& index();

  bool is_table_dof() const;

protected:

  schema_poset_member* _anchor;

  virtual void reset_item();

  virtual void update_item();

  schema_poset_member* _item;

  postorder_iterator _itr;

  bool _is_table_dof;
};

} // namespace sheaf

#endif // ifndef POSET_DOF_ITERATOR_H