poset_table_state.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 POSET_TABLE_STATE_H
#define POSET_TABLE_STATE_H

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

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef INDEX_SPACE_FAMILY_H
#include "SheafSystem/index_space_family.h"
#endif

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

namespace sheaf
{

class abstract_poset_member;
class array_poset_dof_map;
class poset_dof_map;
class poset_state_handle;
class schema_poset_member;

class SHEAF_DLL_SPEC poset_table_state : public any
{

  friend class poset_state_handle;
  friend class storage_agent; // needs to create id space.
  friend class poset_scaffold; // needs to create an id space.
  friend SHEAF_DLL_SPEC size_t deep_size(const poset_table_state& xp, bool xinclude_shallow);


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

public:

//   ///
//   /// Create an instance with schema xschema and
//   /// initial storage for xcapacity dof tuples.
//   ///
//   poset_table_state(const schema_poset_member& xschema, size_type xcapacity);

  poset_table_state(const abstract_poset_member* xschema, size_type xcapacity);

  ~poset_table_state();

  schema_poset_member& schema();

  const schema_poset_member& schema() const;

  array_poset_dof_map* table_dofs();

  void put_table_dofs(array_poset_dof_map* xtable_dofs);

  bool contains_row_dof_tuple(pod_index_type xindex) const;

  bool contains_row_dof_tuple(const scoped_index& xindex) const;

  size_type row_dof_tuple_ct() const;

  const scoped_index& row_dof_tuple_index_ub() const;

  size_type standard_row_dof_tuple_ct() const;

  void put_standard_row_dof_tuple_ct(size_type xct);

  poset_dof_map* row_dof_tuple(pod_index_type xindex);

  poset_dof_map* row_dof_tuple(const scoped_index& xindex);

  void put_row_dof_tuple(poset_dof_map* xdof_tuple);

  index_space_iterator& get_row_dof_tuple_id_space_iterator() const;

  void release_row_dof_tuple_id_space_iterator(index_space_iterator& xitr) const;

protected:

private:

  poset_table_state();

  schema_poset_member* _schema;

  array_poset_dof_map* _table_dofs;

  typedef zero_block_initialization_policy<poset_dof_map*> row_dofs_init_type;

  typedef auto_block<poset_dof_map*, row_dofs_init_type> row_dofs_type;

  row_dofs_type _row_dof_tuples;

  scoped_index _row_dof_tuple_index_ub;

  size_type _standard_row_dof_tuple_ct;



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

public:

  const index_space_family& id_spaces() const;

  const hub_index_space_handle& hub_id_space() const;

  const scoped_index& hub_id() const;

  scoped_index hub_id(pod_index_type xid) const;

protected:

private:

  index_space_family _id_spaces;



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

public:

  virtual bool is_ancestor_of(const any* other) const;


  virtual poset_table_state* clone() const;

  virtual bool invariant() const;

protected:

private:


};


// ===========================================================
// NONMEMBER FUNCTIONS
// ===========================================================

SHEAF_DLL_SPEC 
std::ostream& operator << (std::ostream &os, const poset_table_state& p);

SHEAF_DLL_SPEC 
size_t deep_size(const poset_table_state& xp, bool xinclude_shallow = true);
 
} // namespace sheaf

#endif // ifndef POSET_TABLE_STATE_H