section_dof_iterator.h

//
// 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.
//

// Interface for class section_dof_iterator

#ifndef SECTION_DOF_ITERATOR_H
#define SECTION_DOF_ITERATOR_H

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

#ifndef POSET_DOF_ITERATOR_H
#include "SheafSystem/poset_dof_iterator.h"
#endif

namespace sheaf
{
class subposet;
class zn_to_bool;
}

namespace fiber_bundle
{

using namespace sheaf;


class section_space_schema_member;

class SHEAF_DLL_SPEC section_dof_iterator : public poset_dof_iterator
{

public:

  // CANONICAL MEMBERS

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

  section_dof_iterator& operator=(const section_dof_iterator& xother);

  virtual ~section_dof_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual section_dof_iterator* clone() const = 0;

  virtual bool invariant() const;

  // OTHER CONSTRUCTORS

  // ITERATOR FACET

  virtual bool is_initialized() const;

  // Anchor is not virtual; covariant signature hides
  // inherited version.

  section_space_schema_member& anchor();

  const section_space_schema_member& anchor() const;

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

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

  using poset_dof_iterator::has_visited;

  virtual bool has_visited(pod_index_type xhub_id) const;

  virtual bool has_visited(const schema_poset_member& xmbr) const;

  using poset_dof_iterator::put_has_visited;

  virtual void put_has_visited(pod_index_type xhub_id, bool xvalue);

  // DOF ITERATOR FACET

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

  section_space_schema_member& item();

  const section_space_schema_member& item() const;

  virtual bool item_is_ancestor_of(const schema_poset_member& xmbr) const;

protected:

  section_dof_iterator();

  section_dof_iterator(const section_dof_iterator& xother);

  virtual void reset_item() = 0;

  virtual void update_item() = 0;

  depth_first_iterator* _discretization_itr;

};
 
} // namespace fiber_bundle

#endif // ifndef SECTION_DOF_ITERATOR_H