namespace_poset_member.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 NAMESPACE_POSET_MEMBER_H
#define NAMESPACE_POSET_MEMBER_H

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

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

#ifndef NAMESPACE_POSET_DOF_MAP_H
#include "SheafSystem/namespace_poset_dof_map.h"
#endif

#ifndef POSET_TYPE_H
#include "SheafSystem/poset_type.h"
#endif

#ifndef STD_STRING_H
#include "SheafSystem/std_string.h"
#endif

namespace sheaf
{

class poset_state_handle;
class namespace_poset;
  
class SHEAF_DLL_SPEC namespace_poset_member : public total_poset_member
{

  friend class poset_state_handle;
  friend class namespace_poset;

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

public:

  namespace_poset_member();

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

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

  namespace_poset_member& operator=(const namespace_poset_member& xother);

  virtual ~namespace_poset_member();

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

  // NEW HANDLE, NEW STATE CONSTRUCTORS

  namespace_poset_member(namespace_poset* xhost,
                         const scoped_index* xexpansion,
                         int xexpansion_ct,
                         const tern& xnew_jem,
                         bool xauto_access);


  // NEW HANDLE, EXISTING STATE CONSTRUCTORS

  namespace_poset_member(const namespace_poset* xhost, pod_index_type xhub_id);

  namespace_poset_member(const namespace_poset* xhost, const scoped_index& xid);

  namespace_poset_member(const namespace_poset* xhost, const std::string& xname);

  namespace_poset_member(const poset_state_handle& xmember_poset);

  poset_state_handle* poset_pointer() const;

  poset_type poset_type_id() const;

  const char* poset_class() const;

  pod_index_type poset_prereq_id(int xi) const;

  bool poset_is_external() const;

protected:

  explicit namespace_poset_member(namespace_poset* xhost,
                                  namespace_poset_dof_map* xdof_map = 0,
                                  bool xcopy_dof_map = false,
                                  bool xauto_access = true);

  void put_poset_pointer(const poset_state_handle* xposet);

  void put_poset_type_id(poset_type xtype_id);

  void put_poset_class(const char* xclass);

  void put_poset_prereq_id(int xi, pod_index_type xid);

  void put_poset(const poset_state_handle& xposet);

private:



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

public: 

  virtual namespace_poset_dof_map& dof_map(bool xrequire_write_access = false);

  virtual const namespace_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: 

  inline namespace_poset_member* greatest_jem() const
  {
    return static_cast<namespace_poset_member*>(abstract_poset_member::greatest_jem());
  };

  inline namespace_poset_member* least_jem() const
  {
    return static_cast<namespace_poset_member*>(abstract_poset_member::least_jem());
  };

protected:

private:



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

public: 

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

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

protected:

private:



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

public: 

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

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

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

protected:

private:



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

public: 

  namespace_poset* host() const;

  virtual bool host_is_ancestor_of(const poset_state_handle* xther) const;

protected:

private:



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

public: 

  virtual bool is_ancestor_of(const any* other) const;

  virtual namespace_poset_member* clone() const;

  virtual bool invariant() const;

protected:

private:

};
  
} // namespace sheaf

#endif // NAMESPACE_POSET_MEMBER_H