section_component_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_component_iterator

#ifndef SECTION_COMPONENT_ITERATOR_H
#define SECTION_COMPONENT_ITERATOR_H

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

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

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

#ifndef POSTORDER_ITERATOR_H
#include "SheafSystem/postorder_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_component_iterator : public any
{

public:

  // CANONICAL MEMBERS

  section_component_iterator();

  section_component_iterator(const section_component_iterator& xother);

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

  virtual ~section_component_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual section_component_iterator* clone() const = 0;

  bool invariant() const;

  // OTHER CONSTRUCTORS

  explicit section_component_iterator(const section_space_schema_member& xanchor);
  // Explicit above prevents interpretation as conversion from section_space_schema_meber

  // ITERATOR FACET

  bool is_initialized() const;

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

  section_space_schema_member& anchor();

  const section_space_schema_member& anchor() const;

  void put_anchor(const section_space_schema_member* xanchor);

  bool is_done() const;

  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& xid) const;

  virtual bool has_visited(const section_space_schema_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.

  section_space_schema_member& item();

  const section_space_schema_member& item() const;

  virtual bool item_is_ancestor_of(const section_space_schema_member& xmbr) const;

  virtual const scoped_index& index() const;

protected:

  virtual void reset_anchor(const section_space_schema_member& xanchor);

  section_space_schema_member* _anchor;

  virtual void reset_item() = 0;

  virtual void update_item();

  section_space_schema_member* _item;

  postorder_iterator _itr;

};

} // namespace fiber_bundle

#endif // ifndef SECTION_COMPONENT_ITERATOR_H