sheaf::namespace_relative_record_index Class Reference

Record index equivalent to namespace_relative_member_index and namespace_relative_subposet_index. More...

#include <record_index.h>

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

Public Member Functions
	namespace_relative_record_index ()
	Default constructor. More...
	namespace_relative_record_index (const namespace_relative_record_index &xother)
	Copy constructor. More...
namespace_relative_record_index &	operator= (const namespace_relative_record_index &xother)
	Assignment operator. More...
bool	operator== (const namespace_relative_record_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_record_index &	INVALID ()
	The invalid id. More...

Public Attributes
record_index	poset_id
	The record index of the poset relative to the namespace. More...
record_index	member_id
	The record index of the member relative to the poset. More...

Detailed Description

Record index equivalent to namespace_relative_member_index and namespace_relative_subposet_index.

Definition at line 67 of file record_index.h.

Member Typedef Documentation

pod_type

typedef namespace_relative_record_index_pod_type sheaf::namespace_relative_record_index::pod_type

The POD (plain old data) type associated this.

Definition at line 74 of file record_index.h.

Constructor & Destructor Documentation

namespace_relative_record_index() [1/2]

sheaf::namespace_relative_record_index::namespace_relative_record_index ( )

inline

Default constructor.

Postcondition

• !is_valid()

Definition at line 79 of file record_index.h.

References sheaf::is_valid().

namespace_relative_record_index() [2/2]

sheaf::namespace_relative_record_index::namespace_relative_record_index ( const namespace_relative_record_index &  xother )

inline

Copy constructor.

Postcondition

• *this == xother

Definition at line 109 of file record_index.h.

Member Function Documentation

INVALID()

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

inlinestatic

The invalid id.

Postcondition

• !result.is_valid()

Definition at line 216 of file record_index.h.

References is_valid().

invalidate()

void sheaf::namespace_relative_record_index::invalidate ( )

inline

Make this invalid.

Postcondition

• !is_valid()

Definition at line 195 of file record_index.h.

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

is_valid()

bool sheaf::namespace_relative_record_index::is_valid ( ) const

inline

True if this is a valid id.

Definition at line 175 of file record_index.h.

References sheaf::scoped_index::is_valid().

Referenced by INVALID().

operator=()

namespace_relative_record_index& sheaf::namespace_relative_record_index::operator= ( const namespace_relative_record_index &  xother )

inline

Assignment operator.

Postcondition

• *this == xother

Definition at line 130 of file record_index.h.

References member_id, and poset_id.

operator==()

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

inline

Equality operator.

Postcondition

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

Definition at line 153 of file record_index.h.

References member_id, and poset_id.

pod()

pod_type sheaf::namespace_relative_record_index::pod ( ) const

inline

The "plain old data" storage of this.

Definition at line 238 of file record_index.h.

References sheaf::scoped_index::pod().

Referenced by sheaf::poset_scaffold::convert_subposet_id_to_record_id().

put_pod()

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

inline

Sets pod() to xpod.

Postcondition

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

Definition at line 250 of file record_index.h.

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

Member Data Documentation

member_id

record_index sheaf::namespace_relative_record_index::member_id

The record index of the member relative to the poset.

Definition at line 104 of file record_index.h.

Referenced by sheaf::poset_scaffold::convert_subposet_id_to_record_id(), operator=(), and operator==().

poset_id

record_index sheaf::namespace_relative_record_index::poset_id

The record index of the poset relative to the namespace.

Definition at line 94 of file record_index.h.

Referenced by sheaf::poset_scaffold::convert_record_id_to_member_id(), sheaf::poset_scaffold::convert_record_id_to_subposet_id(), sheaf::poset_scaffold::convert_subposet_id_to_record_id(), operator=(), and operator==().

---

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

• record_index.h