preorder_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 preorder_member_iterator

#ifndef PREORDER_MEMBER_ITERATOR_H
#define PREORDER_MEMBER_ITERATOR_H

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

#ifndef FILTERED_DEPTH_FIRST_MEMBER_ITERATOR_H
#include "SheafSystem/filtered_depth_first_member_iterator.h"
#endif

namespace sheaf
{

class subposet;
class zn_to_bool;  

class SHEAF_DLL_SPEC preorder_member_iterator : public filtered_depth_first_member_iterator
{

public:

  // CANONICAL MEMBERS

  preorder_member_iterator();

  preorder_member_iterator(const preorder_member_iterator& xother);

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

  preorder_member_iterator& operator=(const preorder_member_iterator& xother);

  virtual ~preorder_member_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual preorder_member_iterator* clone() const;

  bool invariant() const;

  // OTHER CONSTRUCTORS

  preorder_member_iterator(const abstract_poset_member& xanchor,
               bool xdown,
               bool xstrict);

  preorder_member_iterator(const abstract_poset_member& xanchor,
               const subposet& xfilter,
               bool xdown,
               bool xstrict);

  preorder_member_iterator(const abstract_poset_member& xanchor,
               pod_index_type xfilter_index,
               bool xdown,
               bool xstrict);

  preorder_member_iterator(const abstract_poset_member& xanchor,
               const scoped_index& xfilter_index,
               bool xdown,
               bool xstrict);

  preorder_member_iterator(const abstract_poset_member& xanchor,
               const std::string& xfilter_name,
               bool xdown,
               bool xstrict);

  // ITERATOR FACET

  void truncate();

};

} // namespace sheaf

#endif // ifndef PREORDER_MEMBER_ITERATOR_H