sec_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 SEC_TUPLE_H
#define SEC_TUPLE_H

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

#ifndef SEC_REP_SPACE_MEMBER_H
#include "SheafSystem/sec_rep_space_member.h"
#endif

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

#ifndef TUPLE_H
#include "SheafSystem/tuple.h"
#endif

namespace fiber_bundle
{

class sec_tuple_space;
class fiber_bundles_namespace;  
  
//==============================================================================
// CLASS SEC_TUPLE
//==============================================================================

class SHEAF_DLL_SPEC sec_tuple : public sec_rep_space_member
{

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

public:

  // Typedefs:

  typedef fiber_bundles_namespace namespace_type;

  typedef sec_tuple_space host_type;

  typedef tuple fiber_type;

  typedef sec_tuple scalar_type;

  static const poset_path& standard_rep_path();

  template <typename S>
  static poset_path standard_host_path(const poset_path& xbase_path,
                                       const poset_path& xrep_path,
                                       const std::string& xsection_suffix,
                                       const std::string& xfiber_suffix);

  template <typename S>
  static bool standard_host_is_available(const namespace_poset& xns,
                                         const poset_path& xbase_path,
                                         const poset_path& xrep_path,
                                         const std::string& xsection_suffix,
                                         const std::string& xfiber_suffix,
                                         bool xauto_access);

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

protected:

private:

 

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


public:

  sec_tuple();

  sec_tuple(const sec_rep_space* xhost, pod_index_type xhub_id);

  sec_tuple(const sec_rep_space* xhost, const scoped_index& xid);

  sec_tuple(const sec_rep_space* xhost, const std::string& xname);

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

  explicit sec_tuple(sec_rep_space_member* xother);

  sec_tuple(sec_rep_space* xhost,
            section_dof_map* xdof_map = 0,
            bool xauto_access = true);

  sec_tuple(sec_rep_space* xhost,
            abstract_poset_member& xbase_mbr,
            int xbase_version = CURRENT_HOST_VERSION,
            bool xauto_access = true);

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

  sec_tuple& operator=(const sec_tuple& xother);

  ~sec_tuple();

  virtual int factor_ct() const;

  int factor_ct(bool xauto_access) const;

protected:

private:



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

public:

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

  static const std::string& static_class_name();

  virtual sec_tuple* clone() const;

  inline sec_tuple* clone(bool xnew_state, bool xauto_access = true) const
  {
    return static_cast<sec_tuple*>(
      sec_rep_space_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 fiber_is_ancestor_of(const any* xother) const;

  bool is_ancestor_of(const any* xother) const;

  bool invariant() const;

  using sec_rep_space_member::restrict_to;

  virtual void restrict_to(const abstract_poset_member* xschema);

  virtual void restrict_to(pod_index_type xbase_id,
                           pod_index_type xfiber_schema_id);

  virtual void restrict_to(const abstract_poset_member* xbase, const abstract_poset_member* xfiber_schema);

  virtual void restrict_to_same(const abstract_poset_member* xother);

  void unrestrict();

  scalar_type* comp(int i) const;

  void set_comp(int i, scalar_type* component);

  // STATE INTERFACE

  void detach_from_state();


protected:

  void attach_handle_data_members();

  inline static std::string create_fiber_name(const std::string& xname)
  {
    return xname + "_fiber";
  }

private:


};

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

SHEAF_DLL_SPEC size_t deep_size(const sec_tuple& x0, bool xinclude_shallow = true);

} // namespace fiber_bundle

#endif // ifndef SEC_TUPLE_H