poset_bounds_descriptor.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_bounds_descriptor

#ifndef POSET_BOUNDS_DESCRIPTOR_H
#define POSET_BOUNDS_DESCRIPTOR_H

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

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef POSET_STATE_HANDLE_H
#include "SheafSystem/poset_state_handle.h"
#endif

#ifndef SUBPOSET_H
#include "SheafSystem/subposet.h"
#endif

namespace sheaf
{

class poset_bounds;

class SHEAF_DLL_SPEC poset_bounds_descriptor : public any
{

  friend class poset_bounds; // To get default constructor.

public:

  poset_bounds_descriptor(const poset_bounds_descriptor& xother);

  poset_bounds_descriptor& operator=(const poset_bounds_descriptor& xother);

  bool operator==(const poset_bounds_descriptor& xother) const;

  virtual poset_bounds_descriptor* clone() const;

  virtual ~poset_bounds_descriptor();

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  // POSET_BOUNDS_DESCRIPTOR FACET


  enum specification_mode
  {
    MEMBER_MEMBER,     // lb = member,   ub = member
    MEMBER_SUBPOSET,   // lb = member,   ub = subposet
    SUBPOSET_MEMBER,   // lb = subposet, ub = member
    SUBPOSET_SUBPOSET, // lb = subposet, ub = subposet
    NOT_A_MODE
  };

  static int mode_to_int(specification_mode xmode);

  static specification_mode int_to_mode(int xmode);

  poset_bounds_descriptor(specification_mode xmode,
                          pod_index_type xlb_id,
                          pod_index_type xub_id);

  poset_bounds_descriptor(specification_mode xmode,
              const scoped_index& xlb_id,
              const scoped_index& xub_id);

  specification_mode mode() const;

  bool lb_is_member() const;

  bool ub_is_member() const;

  pod_index_type lb_id() const;

  void put_lb_id(pod_index_type xlb_id);

  void put_lb_id(const scoped_index& xlb_id);

  pod_index_type ub_id() const;

  void put_ub_id(pod_index_type xub_id);

  void put_ub_id(const scoped_index& xub_id);
  bool lb_is_valid_for(const poset_state_handle& xposet) const;

  bool ub_is_valid_for(const poset_state_handle& xposet) const;

  bool is_valid_for(const poset_state_handle& xposet) const;

  bool lb_member_is_bottom() const;

  bool ub_member_is_not_top() const;

  static const poset_bounds_descriptor& BOTTOM_TOP;

  static const poset_bounds_descriptor& BOTTOM_BOTTOM;

protected:

  poset_bounds_descriptor();


private:

  // PRIVATE MEMBERS

  specification_mode _mode;

  pod_index_type _lb_id;

  pod_index_type _ub_id;
};

} // namespace sheaf

#endif // ifndef POSET_BOUNDS_DESCRIPTOR_H