unstructured_block.h

//
// 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.
//

// Interface for class UNSTRUCTURED_BLOCK

#ifndef UNSTRUCTURED_BLOCK_H
#define UNSTRUCTURED_BLOCK_H

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

#ifndef HOMOGENEOUS_BLOCK_H
#include "SheafSystem/homogeneous_block.h"
#endif

namespace fiber_bundle
{
  
  using namespace sheaf;

class unstructured_block_builder;

// to create the host poset for instances of this class.
class SHEAF_DLL_SPEC unstructured_block : public homogeneous_block
{

  friend class unstructured_block_builder;

public:

  // ===========================================================
  // HOST FACTORY FACET
  // ===========================================================

  static const poset_path& static_prototype_path();

  static host_type& new_host(namespace_type& xns, 
                 const poset_path& xhost_path, 
                 const poset_path& xschema_path, 
                 int xmax_db,
                 bool xauto_access);

  static host_type& standard_host(namespace_type& xns,
                  const poset_path& xhost_path,
                  int xmax_db,
                  bool xauto_access);
  

  // ===========================================================
  // ANY FACET
  // ===========================================================

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  virtual unstructured_block& operator=(const abstract_poset_member& xother);

  unstructured_block& operator=(const unstructured_block& xother);

  // ===========================================================
  // ABSTRACT POSET MEMBER FACET
  // ===========================================================

  virtual unstructured_block* clone() const;

  inline unstructured_block* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<unstructured_block*>(homogeneous_block::clone(xnew_state, xauto_access));
  }

  // ===========================================================
  // ORDERING RELATION FACET
  // ===========================================================

  inline unstructured_block* greatest_jem() const
  {
    return static_cast<unstructured_block*>(homogeneous_block::greatest_jem());
  };

  inline unstructured_block* least_jem() const
  {
    return static_cast<unstructured_block*>(homogeneous_block::least_jem());
  };


  // ===========================================================
  // POSET ALGEBRA FACET
  // ===========================================================

  inline unstructured_block* p_join(abstract_poset_member* other) const
  {
    return static_cast<unstructured_block*>(homogeneous_block::p_join(other));
  };

  inline unstructured_block* p_meet(abstract_poset_member* other)
  {
    return static_cast<unstructured_block*>(homogeneous_block::p_meet(other));
  };


  // ===========================================================
  // LATTICE ALGEBRA FACET
  // ===========================================================

  inline unstructured_block* l_join(abstract_poset_member* other, bool xnew_jem = true)
  {
    return static_cast<unstructured_block*>(homogeneous_block::l_join(other, xnew_jem));
  };

  inline unstructured_block* l_meet(abstract_poset_member* other, bool xnew_jem = true)
  {
    return static_cast<unstructured_block*>(homogeneous_block::l_meet(other, xnew_jem));
  };

  inline unstructured_block* l_not(bool xnew_jem = true) const
  {
    return static_cast<unstructured_block*>(homogeneous_block::l_not(xnew_jem));
  };


  // ===========================================================
  // UNSTRUCTURED_BLOCK FACET
  // ===========================================================

  enum static_const_int {DB = -1};  

  // ===========================================================
  // CANONICAL CONSTRUCTORS
  // ===========================================================

  unstructured_block();

  explicit unstructured_block(const abstract_poset_member& xother,
                              bool xnew_jem = false);

  virtual ~unstructured_block();

  // ===========================================================
  // NEW HANDLE, NEW STATE CONSTRUCTORS
  // ===========================================================

  //*/
  unstructured_block(poset* xhost,
                     const std::string& xlocal_cell_prototype_name,
                     bool xis_prototype_name,
                     bool xauto_access);

  unstructured_block(poset* xhost,
                     const poset_path& xlocal_cell_prototype_path,
                     const scoped_index* xids,
                     int xub,
                     bool xauto_access);


  unstructured_block(poset* xhost,
                     const base_space_member& xlocal_cell_prototype,
                     const scoped_index* xids,
                     int xub,
                     bool xauto_access);

  unstructured_block(poset* xhost,
                     const poset_path& xlocal_cell_prototype_path,
                     const pod_index_type* xids,
                     int xub,
                     bool xauto_access);


  unstructured_block(poset* xhost,
                     const base_space_member& xlocal_cell_prototype,
                     const pod_index_type* xids,
                     int xub,
                     bool xauto_access);

  unstructured_block(poset* xhost,
                     const poset_path& xlocal_cell_prototype_path,
                     const size_type& xi_size,
                     bool xauto_access = true);


  unstructured_block(poset* xhost,
                     const base_space_member& xlocal_cell_prototype,
                     const size_type& xi_size,
                     bool xauto_access = true);

  unstructured_block(poset* xhost,
                     const poset_path& xlocal_cell_prototype_path,
                     const size_type& xi_size,
                     const size_type& xj_size,
                     bool xauto_access = true);


  unstructured_block(poset* xhost,
                     const base_space_member& xlocal_cell_prototype,
                     const size_type& xi_size,
                     const size_type& xj_size,
                     bool xauto_access = true);

  unstructured_block(poset* xhost,
                     const poset_path& xlocal_cell_prototype_path,
                     const size_type& xi_size,
                     const size_type& xj_size,
                     const size_type& xk_size,
                     bool xauto_access = true);


  unstructured_block(poset* xhost,
                     const base_space_member& xlocal_cell_prototype,
                     const size_type& xi_size,
                     const size_type& xj_size,
                     const size_type& xk_size,
                     bool xauto_access = true);


  // ===========================================================
  // NEW HANDLE, EXISTING STATE CONSTRUCTORS
  // ===========================================================

  unstructured_block(const poset* xhost, scoped_index xindex);

  unstructured_block(const poset* xhost, const std::string& xname);

  unstructured_block(const namespace_poset* xnamespace,
                     const poset_path& xpath,
                     bool xauto_access = true);

  unstructured_block(const namespace_poset* xnamespace,
                     const scoped_index& xposet_id,
                     const scoped_index& xmember_id);

  // ===========================================================
  // EXISTING HANDLE, NEW STATE "CONSTRUCTORS"
  // ===========================================================

  virtual void new_state(poset* xhost,
                         const std::string& xlocal_cell_prototype_name,
                         bool xauto_access);

  virtual void new_state(const poset_path& xlocal_cell_prototype_path,
                         const scoped_index* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(const base_space_member& xlocal_cell_prototype,
                         const scoped_index* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const poset_path& xlocal_cell_prototype_path,
                         const scoped_index* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const base_space_member& xlocal_cell_prototype,
                         const scoped_index* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(const poset_path& xlocal_cell_prototype_path,
                         const pod_index_type* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(const base_space_member& xlocal_cell_prototype,
                         const pod_index_type* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const poset_path& xlocal_cell_prototype_path,
                         const pod_index_type* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const base_space_member& xlocal_cell_prototype,
                         const pod_index_type* ids,
                         int xub,
                         bool xauto_access);

  virtual void new_state(const poset_path& xlocal_cell_prototype_path,
                         const size_type& xi_size,
                         bool xauto_access);

  virtual void new_state(const base_space_member& xlocal_cell_prototype,
                         const size_type& xi_size,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const poset_path& xlocal_cell_prototype_path,
                         const size_type& xi_size,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const base_space_member& xlocal_cell_prototype,
                         const size_type& xi_size,
                         bool xauto_access);


  virtual void new_state(const poset_path& xlocal_cell_prototype_path,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         bool xauto_access);

  virtual void new_state(const base_space_member& xlocal_cell_prototype,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const poset_path& xlocal_cell_prototype_path,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const base_space_member& xlocal_cell_prototype,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         bool xauto_access);

  virtual void new_state(const poset_path& xlocal_cell_prototype_path,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         const size_type& xk_size,
                         bool xauto_access);

  virtual void new_state(const base_space_member& xlocal_cell_prototype,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         const size_type& xk_size,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const poset_path& xlocal_cell_prototype_path,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         const size_type& xk_size,
                         bool xauto_access);

  virtual void new_state(poset* xhost,
                         const base_space_member& xlocal_cell_prototype,
                         const size_type& xi_size,
                         const size_type& xj_size,
                         const size_type& xk_size,
                         bool xauto_access);

  // ===========================================================
  // ROW DOFS
  // ===========================================================

  // ===========================================================
  // OTHER FEATURES
  // ===========================================================

  void refine(const poset_path& xlocal_cell_prototype_path,
              const scoped_index* ids,
              int xub,
              bool xauto_access);

  void refine(const base_space_member& xlocal_cell_prototype,
              const scoped_index* ids,
              int xub,
              bool xauto_access);

  static bool host_created_with_new_host(const poset_state_handle& xhost);
  
  static void make_standard_subposets_persistent(poset_state_handle& xhost);

protected:

private:

};
 
} // namespace fiber_bundle

#endif // UNSTRUCTURED_BLOCK_H