tuple.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 TUPLE_H
#define TUPLE_H

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

#ifndef ANY_LITE_H
#include "SheafSystem/any_lite.h"
#endif

#ifndef ARRAY_POSET_DOF_MAP_H
#include "SheafSystem/array_poset_dof_map.h"
#endif

#ifndef FIBER_BUNDLE_H
#include "SheafSystem/fiber_bundle.h"
#endif

#ifndef TOTAL_POSET_MEMBER_H
#include "SheafSystem/total_poset_member.h"
#endif

#ifndef TUPLE_TABLE_DOFS_TYPE_H
#include "SheafSystem/tuple_table_dofs_type.h"
#endif
 

// #ifndef POSET_H
// #include "SheafSystem/poset.h"
// #endif

// #ifndef STD_VECTOR_H
// #include "SheafSystem/std_vector.h"
// #endif

namespace sheaf
{
  class namespace_poset;
  class poset;
  class schema_descriptor;
  template <class T> class wsv_block;
}

namespace fiber_bundle
{

using namespace sheaf;

class fiber_bundles_namespace;
class tuple_space;

//==============================================================================
// CLASS TUPLE_LITE
//==============================================================================

class SHEAF_DLL_SPEC tuple_lite : public any_lite
{
  //============================================================================
  //============================================================================

public:

  typedef tuple_table_dofs_type table_dofs_type;

  tuple_lite();

  tuple_lite(const tuple_lite& xother);

  tuple_lite& operator=(const tuple_lite& xother);

  virtual ~tuple_lite();

  virtual int factor_ct() const = 0;

protected:
private:



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

public:

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

  static const std::string& static_class_name();
  
  virtual tuple_lite* clone() const;

  table_dofs_type table_dofs() const;

protected:
private:



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

public:

  virtual bool is_ancestor_of(const any_lite& xother) const;

  bool invariant() const;

protected:
private:

};


//==============================================================================
// CLASS TUPLE
//==============================================================================

class SHEAF_DLL_SPEC tuple : public total_poset_member
{

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

public:

  typedef fiber_bundles_namespace namespace_type;

  typedef tuple_space host_type;

  typedef tuple_table_dofs_type table_dofs_type;

  typedef tuple_lite volatile_type;

  static const std::string& standard_schema_poset_name();

  static const poset_path& standard_schema_path();

  static void make_standard_schema(namespace_poset& xns);

  template <typename F>
  SHEAF_DLL_SPEC
  static poset_path standard_host_path(const std::string& xsuffix);

  template <typename F>
  SHEAF_DLL_SPEC
  static bool standard_host_is_available(namespace_type& xns, const std::string& xsuffix, bool xauto_access);

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

protected:

private:


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

public:

  // Typedefs:
  tuple();

  // New handle/old state constructors.

  tuple(const poset_state_handle* xhost, pod_index_type xhub_id);

  tuple(const poset_state_handle* xhost, const scoped_index& xid);

  tuple(const poset_state_handle* xhost, const std::string& xname);

  explicit tuple(const abstract_poset_member* xother);

  tuple(poset_state_handle* xhost, bool xauto_access = true);

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

  tuple& operator=(const tuple& xother);

  virtual ~tuple();

  enum static_const_int {FACTOR_CT = 0};  

  virtual int factor_ct() const;

  int factor_ct(bool xauto_access) const;

  virtual array_poset_dof_map& dof_map(bool xrequire_write_access = false);

  virtual const array_poset_dof_map& dof_map(bool xrequire_write_access = false) const;

  virtual bool dof_map_is_ancestor_of(const poset_dof_map* xdof_map) const;

protected:
private:



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

public:

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

  static const std::string& static_class_name();

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

protected:
private:


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

public:

  host_type* host() const;

  virtual bool host_is_ancestor_of(const poset_state_handle* other) const;

protected:

private:

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

public:

  bool is_ancestor_of(const any* other) const;
  
  virtual tuple* clone() const;

  virtual bool invariant() const;

protected:
private:

};

} // namespace fiber_bundle

#endif // ifndef TUPLE_H