sheaf::namespace_relative_subposet_index Struct Reference

Index for identifying a subposet relative to a given name space. More...

#include <namespace_relative_subposet_index.h>

Public Types
typedef namespace_relative_subposet_index_pod_type	pod_type
	The POD (plain old data) type associated this. More...

Public Member Functions
	namespace_relative_subposet_index ()
	Default constructor. More...
	namespace_relative_subposet_index (const index_space_handle &xid_space, const pod_type &xpod)
	Constructor from pod_type. More...
bool	operator== (const namespace_relative_subposet_index &xother) const
	Equality operator. More...
bool	is_valid () const
	True if this is a valid id. More...
void	invalidate ()
	Make this invalid. More...
pod_type	pod () const
	The "plain old data" storage of this. More...
void	put_pod (pod_type xpod)
	Sets pod() to xpod. More...

Static Public Member Functions
static const namespace_relative_subposet_index &	INVALID ()
	The invalid id. More...

Public Attributes
scoped_index	poset_id
	The index of the poset relative to the namespace. More...
scoped_index	subposet_id
	The index of the subposet relative to the poset. More...

Detailed Description

Index for identifying a subposet relative to a given name space.

Definition at line 41 of file namespace_relative_subposet_index.h.

Member Typedef Documentation

pod_type

typedef namespace_relative_subposet_index_pod_type sheaf::namespace_relative_subposet_index::pod_type

The POD (plain old data) type associated this.

Definition at line 46 of file namespace_relative_subposet_index.h.

Constructor & Destructor Documentation

namespace_relative_subposet_index() [1/2]

sheaf::namespace_relative_subposet_index::namespace_relative_subposet_index ( )

inline

Default constructor.

Postcondition

• !is_valid()

Definition at line 51 of file namespace_relative_subposet_index.h.

References sheaf::is_valid().

namespace_relative_subposet_index() [2/2]

sheaf::namespace_relative_subposet_index::namespace_relative_subposet_index ( const index_space_handle &  xid_space, const pod_type &  xpod  )

inlineexplicit

Constructor from pod_type.

Postcondition

• (pod() == xpod) || !is_valid()

Definition at line 68 of file namespace_relative_subposet_index.h.

References sheaf::is_valid().

Member Function Documentation

INVALID()

static const namespace_relative_subposet_index& sheaf::namespace_relative_subposet_index::INVALID ( )

inlinestatic

The invalid id.

Postcondition

• !result.is_valid()

Definition at line 159 of file namespace_relative_subposet_index.h.

References is_valid().

invalidate()

void sheaf::namespace_relative_subposet_index::invalidate ( )

inline

Make this invalid.

Postcondition

• !is_valid()

Definition at line 138 of file namespace_relative_subposet_index.h.

References sheaf::scoped_index::invalidate(), and sheaf::is_valid().

is_valid()

bool sheaf::namespace_relative_subposet_index::is_valid ( ) const

inline

True if this is a valid id.

Definition at line 118 of file namespace_relative_subposet_index.h.

References sheaf::scoped_index::is_valid().

Referenced by INVALID().

operator==()

bool sheaf::namespace_relative_subposet_index::operator== ( const namespace_relative_subposet_index &  xother ) const

inline

Equality operator.

Postcondition

• result == ((poset_id == xother.poset_id) && (subposet_id == xother.subposet_id))

Definition at line 96 of file namespace_relative_subposet_index.h.

References poset_id, and subposet_id.

pod()

pod_type sheaf::namespace_relative_subposet_index::pod ( ) const

inline

The "plain old data" storage of this.

Definition at line 181 of file namespace_relative_subposet_index.h.

References sheaf::scoped_index::pod().

Referenced by sheaf::primitive_value::primitive_value().

put_pod()

void sheaf::namespace_relative_subposet_index::put_pod ( pod_type  xpod )

inline

Sets pod() to xpod.

Postcondition

• pod() == xpod || !is_valid()

Definition at line 193 of file namespace_relative_subposet_index.h.

References sheaf::is_valid(), and sheaf::scoped_index::put_pod().

Member Data Documentation

poset_id

scoped_index sheaf::namespace_relative_subposet_index::poset_id

The index of the poset relative to the namespace.

Definition at line 79 of file namespace_relative_subposet_index.h.

Referenced by sheaf::operator<<(), operator==(), and sheaf::operator>>().

subposet_id

scoped_index sheaf::namespace_relative_subposet_index::subposet_id

The index of the subposet relative to the poset.

Definition at line 89 of file namespace_relative_subposet_index.h.

Referenced by sheaf::operator<<(), operator==(), and sheaf::operator>>().

---

The documentation for this struct was generated from the following file:

• namespace_relative_subposet_index.h