filtered_depth_first_member_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 filtered_depth_first_member_iterator

#ifndef FILTERED_DEPTH_FIRST_MEMBER_ITERATOR_H
#define FILTERED_DEPTH_FIRST_MEMBER_ITERATOR_H

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

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

#ifndef FILTERED_DEPTH_FIRST_ITERATOR_H
#include "SheafSystem/filtered_depth_first_iterator.h"
#endif

namespace sheaf
{

class subposet;
class zn_to_bool;  

class SHEAF_DLL_SPEC filtered_depth_first_member_iterator : public any
{

public:

  // CANONICAL MEMBERS

  filtered_depth_first_member_iterator(const filtered_depth_first_member_iterator& xother);

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

  virtual ~filtered_depth_first_member_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual filtered_depth_first_member_iterator* clone() const = 0;

  bool invariant() const;

  // SOME USEFUL CONSTANTS

/*   static const bool DOWN; */

/*   /// */
/*   /// Iteration directions */
/*   /// */
/*   static const bool UP; */

/*   /// */
/*   /// Iteration marker reset control */
/*   /// */
/*   static const bool RESET; */

/*   /// */
/*   /// Iteration marker reset control */
/*   /// */
/*   static const bool NO_RESET; */

/*   /// */
/*   /// Iteration strictness control */
/*   /// */
/*   static const bool STRICT; */

/*   /// */
/*   /// Iteration strictness control */
/*   /// */
/*   static const bool NOT_STRICT; */


  // ITERATOR FACET

  depth_first_iterator::order_type order();

  bool is_initialized() const;

  virtual abstract_poset_member& anchor();

  virtual const abstract_poset_member& anchor() const;

  virtual void put_anchor(const abstract_poset_member* xanchor);

  virtual void put_anchor(pod_index_type xanchor_hub_id);

  void put_anchor(const scoped_index& xanchor_id);

  const subposet& filter() const;

  void put_filter(const subposet& filter);

  void put_filter(const std::string& xfilter_name);

  void put_filter(pod_index_type xfilter_hub_id);

  void put_filter(const scoped_index& xfilter_id);

  bool descending() const;

  void put_descending(bool xdescending);

  bool strict() const;

  void put_strict(bool xstrict);

  bool is_done() const;

  virtual void next();

  virtual void reset(bool xreset_markers = RESET);

  int ct(bool xreset = false);

  bool has_visited(pod_index_type xhub_id) const;

  bool has_visited(const scoped_index& xid) const;

  bool has_visited(const abstract_poset_member& xmbr) const;

  void put_has_visited(pod_index_type xhub_id, bool xvalue);

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

  const scoped_index& greater_index() const;

  const scoped_index& lesser_index() const;

  // MEMBER ITERATOR FACET

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

  abstract_poset_member& item();

  const abstract_poset_member& item() const;

  virtual bool item_is_ancestor_of(const abstract_poset_member& xmbr) const;

  virtual bool anchor_is_ancestor_of(const abstract_poset_member& xmbr) const;


protected:

  filtered_depth_first_member_iterator(filtered_depth_first_iterator* xitr,
                                       abstract_poset_member* xitem);

  virtual void update_item();

  abstract_poset_member* _item;

  filtered_depth_first_iterator* _iterator;

private:

  filtered_depth_first_member_iterator();

};

} // namespace sheaf

#endif // ifndef FILTERED_DEPTH_FIRST_MEMBER_ITERATOR_H