binary_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 binary_section_dof_iterator

#ifndef BINARY_SECTION_DOF_ITERATOR_H
#define BINARY_SECTION_DOF_ITERATOR_H

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

#ifndef SECTION_DOF_ITERATOR_H
#include "SheafSystem/section_dof_iterator.h"
#endif

namespace fiber_bundle
{

class binary_section_space_schema_member;

class SHEAF_DLL_SPEC binary_section_dof_iterator : public section_dof_iterator
{

public:

  // CANONICAL MEMBERS

  binary_section_dof_iterator();

  binary_section_dof_iterator(const binary_section_dof_iterator& xother);

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

  binary_section_dof_iterator& operator=(const binary_section_dof_iterator& xother);

  virtual ~binary_section_dof_iterator();

  virtual bool is_ancestor_of(const any* other) const;

  virtual binary_section_dof_iterator* clone() const;

  virtual bool invariant() const;

  // OTHER CONSTRUCTORS

  explicit binary_section_dof_iterator(const binary_section_space_schema_member& xanchor,
                                       bool xis_table_dof = false,
                                       int xversion = ANCHOR_VERSION);

  // ITERATOR FACET

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

  binary_section_space_schema_member& anchor();

  const binary_section_space_schema_member& anchor() const;

  // DOF ITERATOR FACET

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

  binary_section_space_schema_member& item();

  const binary_section_space_schema_member& item() const;

  virtual bool item_is_ancestor_of(const schema_poset_member& xmbr) const;

protected:

  virtual void reset_item();

  virtual void update_item();

  void initialize(const binary_section_space_schema_member& xanchor,
                  bool xis_table_dof,
                  int xversion);

};

} // namespace fiber_bundle

#endif // ifndef BINARY_SECTION_DOF_ITERATOR_H