gathered_insertion_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 GATHERED_INSERTION_INDEX_SPACE_HANDLE_H
#define GATHERED_INSERTION_INDEX_SPACE_HANDLE_H

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

#ifndef EXPLICIT_INDEX_SPACE_HANDLE_H
#include "SheafSystem/explicit_index_space_handle.h"
#endif

namespace sheaf
{

class gathered_insertion_index_space_state;
  
class SHEAF_DLL_SPEC gathered_insertion_index_space_handle : public explicit_index_space_handle
{

  friend class gathered_insertion_index_space_state;
  friend class id_space_names_record;

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

public:

  gathered_insertion_index_space_handle();

  gathered_insertion_index_space_handle(const gathered_insertion_index_space_handle& xother);

  gathered_insertion_index_space_handle(const index_space_family& xid_spaces, pod_type xindex);

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

  gathered_insertion_index_space_handle& operator=(const gathered_insertion_index_space_handle& xother);

  virtual ~gathered_insertion_index_space_handle();

protected:

  using explicit_index_space_handle::state;

  gathered_insertion_index_space_state& state();

  const gathered_insertion_index_space_state& state() const;

private:



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

public:

  void push_back(const scoped_index& xhub_id);

  void push_back(pod_type xid);

  void push(index_space_iterator& xitr, const scoped_index& xhub_id);

  void push(index_space_iterator& xitr, pod_type xhub_id);

  pod_type next_id() const;

  size_type remove(const scoped_index& xid, bool update_extrema);

  size_type remove(pod_type xid, bool update_extrema);

  size_type remove_hub(pod_type xhub_id, bool update_extrema);

  void remove(index_space_iterator& xitr, bool update_extrema);

  void gather();
  
  void update_extrema();

  void reserve(size_type xcapacity);

  size_type capacity() const;

  void clear();

protected:

private:



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

public:

protected:

private:



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

public:

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

  virtual gathered_insertion_index_space_handle* clone() const;

protected:

private:



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

public:

  void put_is_persistent(bool xis_persistent);

protected:

private:



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

public:

  using explicit_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
// ===========================================================

SHEAF_DLL_SPEC 
size_t deep_size(const gathered_insertion_index_space_handle& xn, bool xinclude_shallow = true);
  
} // end namespace sheaf

#endif // ifndef GATHERED_INSERTION_INDEX_SPACE_HANDLE_H