poset_state.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 POSET_STATE

#ifndef POSET_STATE_H
#define POSET_STATE_H

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

#ifndef READ_WRITE_MONITOR_H
#include "SheafSystem/read_write_monitor.h"
#endif

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


namespace sheaf
{

class abstract_poset_member;
class array_poset_dof_map;
class poset_crg_state;
class poset_powerset_state;
class poset_table_state;
class schema_poset_member;  

class SHEAF_DLL_SPEC poset_state: public read_write_monitor
{

  friend SHEAF_DLL_SPEC size_t deep_size(const poset_state& xp, bool xinclude_shallow, size_t xresults[4]);

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

public:

  poset_state(const abstract_poset_member* xschema, poset_type xtype_id, const std::string& xname);

//   ///
//   /// Constructor
//   ///
//   poset_state(const abstract_poset_member* xschema,
//               poset_type xtype_id,
//               size_type xmbr_ct = 16,
//               size_type xlink_ct = 64,
//               size_type xsubset_ct = 4);

  ~poset_state();

  const std::string& name() const;

  void put_name(const std::string& xname);

  poset_type type_id() const;

  //   ///
  //   ///
  //   const char* poset_class();

  poset_crg_state* crg();

  poset_powerset_state* powerset();

  poset_table_state* table() const;

protected:

  poset_state() {};

  std::string _name;

  poset_type _type_id;

  poset_crg_state* _crg;

  poset_powerset_state* _powerset;

  poset_table_state* _table;

private:



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual poset_state* clone() const;

  virtual bool invariant() const;

protected:

private:

};

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

SHEAF_DLL_SPEC size_t deep_size(const poset_state& xp,
         bool xinclude_shallow = true,
         size_t xresults[4] = 0);

} // namespace poset

#endif // ifndef POSET_STATE_H