list_index_space_handle.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 LIST_INDEX_SPACE_HANDLE_H
#define LIST_INDEX_SPACE_HANDLE_H

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

#ifndef SCATTERED_INSERTION_INDEX_SPACE_HANDLE_H
#include "SheafSystem/scattered_insertion_index_space_handle.h"
#endif

#ifndef STD_LIST_H
#include "SheafSystem/std_list.h"
#endif

namespace sheaf
{

class list_index_space_state;
class list_index_space_handle;
  
 
SHEAF_DLL_SPEC 
std::ostream & operator << (std::ostream &xos, const list_index_space_handle& xi);

  
class SHEAF_DLL_SPEC list_index_space_handle : public scattered_insertion_index_space_handle
{

  friend class list_index_space_state;
  friend SHEAF_DLL_SPEC std::ostream & operator << (std::ostream &xos, const list_index_space_handle& xi);

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

public:

  static list_index_space_handle new_space(index_space_family& xid_spaces,
                       const std::string& xname,
                       bool xis_persistent);

protected:

private:



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

public:

  list_index_space_handle();

  list_index_space_handle(const list_index_space_handle& xother);

  list_index_space_handle(const index_space_family& xid_spaces, pod_type xindex);

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

  list_index_space_handle& operator=(const list_index_space_handle& xother);

  virtual ~list_index_space_handle();

  void reverse(bool xupdate_extrema);

  pod_type front() const;

  pod_type back() const;

  void push_front(pod_type xhub_id);

  void replace_range_id(pod_type xold_range_id, pod_type xnew_range_id);

protected:

  list_index_space_handle(list_index_space_state& xstate);

  using scattered_insertion_index_space_handle::state;

  list_index_space_state& state();

  const list_index_space_state& state() const;

private:



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

public:

protected:

private:


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

public:

  typedef std::list<pod_type> to_range_type;

  to_range_type& to_range();

  const to_range_type& to_range() const;

protected:

private:

 

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

public:

protected:

private:



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

public:

  virtual list_index_space_handle& operator=(const index_space_handle& xother);

  virtual list_index_space_handle* clone() const;

protected:

private:



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

public:

  using scattered_insertion_index_space_handle::conforms_to_state;

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

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // end namespace sheaf

#endif // ifndef LIST_INDEX_SPACE_HANDLE_H