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

#ifndef ID_BLOCK_H
#define ID_BLOCK_H

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

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

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

#ifndef SHEAF_H
#include "SheafSystem/sheaf.h"
#endif

namespace sheaf
{

class any;
class poset_state_handle;

class SHEAF_DLL_SPEC id_block : public block<scoped_index>
{

public:

  // =============================================================================
  // ANY FACET
  // =============================================================================

  virtual bool is_ancestor_of(const any* other) const;

  virtual id_block* clone() const;

  id_block& operator=(const id_block& xother);

  virtual bool invariant() const;

  // =============================================================================
  // ID_BLOCK FACET
  // =============================================================================

  id_block(const id_block& xother);

  virtual ~id_block();

  id_block(const poset_state_handle& xhost,
           const index_space_handle& xid_space,
           int xub,
           const scoped_index *xids = 0,
           int xct = 0);

  poset_state_handle& host();

  const poset_state_handle& host() const;

  const index_space_handle& id_space() const;

  void put_id_space(const index_space_handle& xnew_id_space, bool xauto_access);

  void put_member_id_space(bool xauto_access);

  bool is_member_hub_id_space() const;


private:

  id_block();

  poset_state_handle* _host;

  index_space_handle* _id_space;

};

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

SHEAF_DLL_SPEC
std::ostream&
operator << (std::ostream& xos, const id_block& xblk);

} // namespace sheaf

#endif // ifndef ID_BLOCK_H