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


#ifndef PREORDER_ITERATOR_H
#define PREORDER_ITERATOR_H

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

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

namespace sheaf
{
  
class SHEAF_DLL_SPEC preorder_iterator : public filtered_depth_first_iterator
{
public:

  // CANONICAL MEMBERS

  preorder_iterator();

  preorder_iterator(const preorder_iterator& xother);

  ~preorder_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual preorder_iterator* clone() const;

  bool invariant() const;

  // OTHER CONSTRUCTORS

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

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

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

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

  preorder_iterator(const abstract_poset_member& xanchor,
            const std::string& xfilter_name,
            bool xdown,
            bool xstrict);
};
  
} // namespace sheaf

#endif // ifndef PREORDER_ITERATOR_H