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

#ifndef NAMESPACE_RELATIVE_MEMBER_INDEX_H
#define NAMESPACE_RELATIVE_MEMBER_INDEX_H

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

#ifndef ASSERT_CONTRACT_H
#include "SheafSystem/assert_contract.h"
#endif

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

namespace sheaf
{
  
struct SHEAF_DLL_SPEC namespace_relative_member_index
{

  typedef namespace_relative_member_index_pod_type pod_type;

  inline namespace_relative_member_index()
  {
    // Scoped_index data members are invalid by default.

    // Postconditions:

    ensure(!is_valid());

    // Exit:

    return;
  };


  inline explicit namespace_relative_member_index(const index_space_handle& xid_space, const pod_type& xpod)
      : poset_id(xid_space, xpod.poset_id),
    member_id(xid_space, xpod.member_id)
  {
    // Postconditions:

    ensure((pod() == xpod) || !is_valid());

    // Exit:

    return;
  };

  scoped_index poset_id;

  scoped_index member_id;

  inline bool operator==(const namespace_relative_member_index& xother) const
  {
    bool result;

    // Preconditions:

    // Body:

    result = ((poset_id == xother.poset_id) && (member_id == xother.member_id));

    // Postconditions:

    ensure(result == ((poset_id == xother.poset_id) && (member_id == xother.member_id)));

    // Exit:

    return result;
  };

  inline bool is_valid() const
  {
    bool result;

    // Preconditions:

    // Body:

    result = (poset_id.is_valid() && member_id.is_valid());

    // Postconditions:

    // Exit:

    return result;
  };

  void invalidate()
  {
    // Preconditions:

    // Body:

    poset_id.invalidate();
    member_id.invalidate();

    // Postconditions:

    ensure(!is_valid());

    // Exit:

    return;
  };

  inline static const namespace_relative_member_index& INVALID()
  {
    // Preconditions:

    // Body:

    // Default constructor ensures invalid.

    static const namespace_relative_member_index result;

    // Postconditions:

    ensure(!result.is_valid());

    // Exit:

    return result;
  };

  inline pod_type pod() const
  {
    pod_type result;
    result.poset_id = poset_id.pod();
    result.member_id = member_id.pod();

    return result;
  };

  inline void put_pod(pod_type xpod)
  {

    // Preconditions:

    // Body:

    poset_id.put_pod(xpod.poset_id);
    member_id.put_pod(xpod.member_id);

    // Postconditions:

    ensure(pod() == xpod || !is_valid());

    // Exit:

    return;
  };


} ;

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

SHEAF_DLL_SPEC 
std::ostream&
operator<<(std::ostream& xos, const namespace_relative_member_index& xindex);

SHEAF_DLL_SPEC 
std::istream&
operator>>(std::istream& xis, namespace_relative_member_index& xindex);

 
} // namespace sheaf


#endif // ifndef NAMESPACE_RELATIVE_MEMBER_INDEX_H