pod_types.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.
//

// Declaration of pod_types facet of namespace sheaf..

#ifndef POD_TYPES_H
#define POD_TYPES_H

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

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

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

namespace sheaf
{

// =============================================================================
// POD TYPES FACET
// =============================================================================

// POD (Plain Old Data) types associated with sheaf primitives of class type.

// If you change pod_index_type, review primitive_type::not_a_primitive_type

typedef int_type pod_index_type;

SHEAF_DLL_SPEC pod_index_type invalid_pod_index();

SHEAF_DLL_SPEC bool is_valid(pod_index_type xpod_index);

SHEAF_DLL_SPEC pod_index_type max_pod_index();

SHEAF_DLL_SPEC pod_index_type min_pod_index();

typedef pod_index_type scoped_index_pod_type;

struct SHEAF_DLL_SPEC namespace_relative_member_index_pod_type
{
  pod_index_type poset_id;
  pod_index_type member_id;

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

  bool is_valid();
};

SHEAF_DLL_SPEC namespace_relative_member_index_pod_type invalid_namespace_relative_member_index_pod();

SHEAF_DLL_SPEC 
std::ostream&
operator<<(std::ostream& xos, const namespace_relative_member_index_pod_type& xpod);

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

struct SHEAF_DLL_SPEC namespace_relative_subposet_index_pod_type
{
  pod_index_type poset_id;
  pod_index_type subposet_id;

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

  bool is_valid();
};

SHEAF_DLL_SPEC namespace_relative_subposet_index_pod_type invalid_namespace_relative_subposet_index_pod();

SHEAF_DLL_SPEC 
std::ostream&
operator<<(std::ostream& xos, const namespace_relative_subposet_index_pod_type& xpod);

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

} // namespace sheaf

#endif // ifndef POD_TYPES_H