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

#ifndef VD_SPACE_H
#define VD_SPACE_H

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

#ifndef TUPLE_SPACE_H
#include "SheafSystem/tuple_space.h"
#endif
  
#ifndef VD_TABLE_DOFS_TYPE_H
#include "SheafSystem/vd_table_dofs_type.h"
#endif

namespace fiber_bundle
{

  using namespace sheaf;  

  class vd;
  class at0_space;
  
  
class SHEAF_DLL_SPEC vd_space : public tuple_space
{
  friend class fiber_bundles_namespace;

public:

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

public:

  typedef vd member_type;

  typedef at0_space scalar_space_type;
  
  static const std::string& standard_schema_poset_name();

  static const poset_path& standard_schema_path();
  
  typedef vd_table_dofs_type table_dofs_type;

  static vd_space& new_table(namespace_type& xhost, 
                 const poset_path& xpath, 
                 const poset_path& xschema_path,
                 const poset_path& xscalar_space_path,
                 bool xauto_access);
  
  //============================================================================
  // TABLE DOFS
  //============================================================================

  using tuple_space::factor_ct;
  
  static int factor_ct(int xd);
  
  int d() const;

  int d(bool xauto_access) const;

  static int d(const namespace_poset& xns, 
           const poset_path& xvector_space_path, 
           bool xauto_access);

  poset_path scalar_space_path() const;

  poset_path scalar_space_path(bool xauto_access) const;

  static poset_path scalar_space_path(const namespace_poset& xns, 
                      const poset_path& xvector_space_path, 
                      bool xauto_access);

  bool contains_variance_subposets(bool xauto_access) const;

  virtual bool is_vector(pod_index_type xmbr_id, bool xauto_access) const;

  bool is_vector(const scoped_index& xmbr_id, bool xauto_access) const;

  virtual void put_is_vector(pod_index_type xmbr_id, bool xauto_access);

  void put_is_vector(const scoped_index& xmbr_id, bool xauto_access);

  virtual bool is_covector(pod_index_type xmbr_id, bool xauto_access) const;;

  bool is_covector(const scoped_index& xmbr_id, bool xauto_access) const;;

  virtual void put_is_covector(pod_index_type xmbr_id, bool xauto_access);

  void put_is_covector(const scoped_index& xmbr_id, bool xauto_access);

protected:

  vd_space();

  vd_space(const vd_space& xother) { };

  virtual ~vd_space();

  vd_space(vd* xtop, vd* xbottom);

  static std::string covariant_subposet_name(int xi);

  void create_variance_subposets();

  virtual size_type covariant_subposet_ct() const;

private:


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

public:

protected:

private:

  static bool make_prototype();

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

public:

  virtual poset_type type_id() const;

  virtual const char* class_name() const;

  virtual pod_index_type prereq_id(int xi) const;

protected:

  vd_space& operator=(const poset_state_handle& xother)
  {
    return const_cast<vd_space&>(*this);
  };

  virtual void initialize_standard_subposets(const std::string& xname);

private:

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

public:

  virtual bool is_ancestor_of(const any* xother) const;

  virtual vd_space* clone() const;

  virtual bool invariant() const;

protected:
private:

 
};


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

  SHEAF_DLL_SPEC void print_prereq_paths(std::ostream &xos, 
              const vd_space& xspace, 
              const std::string& xheading,
              const std::string& xindent,
              bool xauto_access = true);

} // namespace fiber_bundle


#endif // VD_SPACE_H