explicit_index_space_iterator.h

Go to the documentation of this file.

//
// 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.
//


#ifndef EXPLICIT_INDEX_SPACE_ITERATOR_H
#define EXPLICIT_INDEX_SPACE_ITERATOR_H

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

#ifndef INDEX_SPACE_ITERATOR_H
#include "SheafSystem/index_space_iterator.h"
#endif

namespace sheaf
{

class explicit_index_space_state;

class SHEAF_DLL_SPEC explicit_index_space_iterator : public index_space_iterator
{

  friend class explicit_index_space_state;

  // ===========================================================
  // ===========================================================

public:

  virtual ~explicit_index_space_iterator();

protected:

  explicit_index_space_iterator();

  explicit_index_space_iterator(const explicit_index_space_iterator& xother);

  explicit_index_space_iterator& operator=(const explicit_index_space_iterator& xother);

  explicit_index_space_state& state();

  const explicit_index_space_state& state() const;

  explicit_index_space_state* _state;

private:



  // ===========================================================
  // ===========================================================

public:

  virtual explicit_index_space_iterator& operator=(const index_space_iterator& xother);

  virtual bool operator==(const index_space_iterator& xother) const;

  virtual explicit_index_space_iterator* clone() const = 0;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual const index_space_collection& host() const;

  virtual pod_type index() const;

  virtual bool is_attached() const;

  using index_space_iterator::attach_to;

  virtual void attach_to(pod_type xindex);

  virtual void attach_to(const index_space_collection& xhost,
             pod_type xlocal_id);

  virtual void detach();

  using index_space_iterator::conforms_to_state;

  virtual bool conforms_to_state(const index_space_collection& xhost,
                 pod_type xlocal_id) const;

protected:

  virtual void attach_to(explicit_index_space_state* xstate) = 0;

  virtual bool conforms_to_state(explicit_index_space_state* xstate) const = 0;

  explicit_index_space_state* state(pod_type xindex) const;

  explicit_index_space_state* state(const index_space_collection& xhost,
                    pod_type xlocal_id) const;

private:



  // ===========================================================
  // ===========================================================

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================


} // namespace sheaf

#endif // ifndef EXPLICIT_INDEX_SPACE_ITERATOR_H