implicit_crg_interval.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 IMPLICIT_CRG_INTERVAL_H
#define IMPLICIT_CRG_INTERVAL_H

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

#ifndef CRG_INTERVAL_H
#include "SheafSystem/crg_interval.h"
#endif

namespace sheaf
{

// Forward declarations to support friend declaration.

class implicit_crg_interval;

class SHEAF_DLL_SPEC implicit_crg_interval : public crg_interval
{

  friend SHEAF_DLL_SPEC size_t deep_size(const implicit_crg_interval& xp, bool xinclude_shallow);

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

public:

  implicit_crg_interval();

  virtual ~implicit_crg_interval();

protected:

private:



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

public:

  pod_index_type implicit_begin() const;

  void implicit_begin(scoped_index& result) const;

  pod_index_type interval_member() const;

  void interval_member(scoped_index& result) const;

  bool is_interval_member(pod_index_type xindex) const;

  bool is_interval_member(const scoped_index& xindex) const;

protected:

private:



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

public:

protected:

  static std::string implicit_cover_name(bool xlower, const scoped_index& xmbr_index);

  static std::string implicit_cover_name(bool xlower, pod_index_type xmbr_index);

private:



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

public:

  virtual bool is_jim(pod_index_type xmbr_index) const = 0;

  bool is_jim(const scoped_index& xmbr_index) const;

  virtual pod_index_type dof_tuple_id(pod_index_type xmbr_index) const = 0;

  pod_index_type dof_tuple_id(const scoped_index& xmbr_index) const;

  block<pod_index_type>& dof_tuple_ids();

  const block<pod_index_type>& dof_tuple_ids() const;

  bool dof_tuple_ids_initialized() const;

  void initialize_dof_tuple_ids(const block<pod_index_type>& xdof_tuple_ids);

protected:

  block<pod_index_type> _dof_tuple_ids;

  bool _dof_tuple_ids_initialized;

private:



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

public:

  void clean_cover(bool xlower, pod_index_type xmbr_index);

protected:

private:



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

public:

  // $$SCRIBBLE: implicit-cover-reorganization
  // Made private data functions non-virtual.

  size_type private_data_size() const;

  void get_private_data(block<pod_index_type>& xdata) const;

  void put_private_data(const block<pod_index_type>& xdata);

  bool private_data_initialized() const;

protected:

  // $$SCRIBBLE: implicit-cover-reorganization
  // Added implicit private data function

  virtual size_type implicit_private_data_size() const = 0;

  virtual void get_implicit_private_data(block<pod_index_type>& xdata) const = 0;

  virtual void put_implicit_private_data(const block<pod_index_type>& xdata) = 0;

  bool _private_data_initialized;

private:



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

public:

  virtual void finalize(poset_state_handle& xhost);

protected:

  bool _is_finalized;

private:



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

public:

  void initialize(const namespace_poset& xnamespace);

  virtual bool is_initialized() const;

  virtual const std::string& class_name() const;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual implicit_crg_interval* clone() const = 0;

  virtual bool invariant() const;

protected:

private:

};

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

SHEAF_DLL_SPEC 
size_t deep_size(const implicit_crg_interval& xp, bool xinclude_shallow = true);

} // namespace sheaf

#endif // ifndef IMPLICIT_CRG_INTERVAL_H