array_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 ARRAY_INDEX_SPACE_ITERATOR_H
#define ARRAY_INDEX_SPACE_ITERATOR_H

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

#ifndef AUTO_BLOCK_H
#include "SheafSystem/auto_block.h"
#endif

#ifndef EXPLICIT_INDEX_SPACE_ITERATOR_H
#include "SheafSystem/explicit_index_space_iterator.h"
#endif

namespace sheaf
{

class SHEAF_DLL_SPEC array_index_space_iterator : public explicit_index_space_iterator
{

  friend class array_index_space_state;

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

public:

  array_index_space_iterator();

  array_index_space_iterator(const array_index_space_iterator& xother);

  array_index_space_iterator(const index_space_family& xid_spaces,
                 pod_type xindex);

  array_index_space_iterator(const index_space_family& xid_spaces,
                 const std::string& xname);

  array_index_space_iterator& operator=(const array_index_space_iterator& xother);

  virtual ~array_index_space_iterator();

protected:

  typedef auto_block<pod_type, invalid_block_initialization_policy<pod_type> > to_hub_type;

  const to_hub_type* _to_hub;

  pod_type _end;

private:



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

public:

protected:

private:



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

public:

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

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

  virtual array_index_space_iterator* clone() const;

protected:

private:



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

public:

  virtual void next();

  virtual void reset();

protected:

private:



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

public:

  using explicit_index_space_iterator::attach_to;

  using explicit_index_space_iterator::conforms_to_state;

protected:

  virtual void attach_to(explicit_index_space_state* xstate);

  virtual bool conforms_to_state(explicit_index_space_state* xstate) 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 ARRAY_INDEX_SPACE_ITERATOR_H