ABA_ID Class Reference

instance of the class ABA_ID is used for identification of the same object stored multiple times on different processors. More...

#include <id.h>

Inheritance diagram for ABA_ID:

List of all members.

Public Member Functions
	ABA_ID ()
	ABA_ID (ABA_MESSAGE &msg)
void	pack (ABA_MESSAGE &msg) const
void	initialize (unsigned long sequence, int proc, int index)
void	uninitialize ()
bool	isInitialized () const
unsigned long	sequence () const
int	proc () const
int	index () const
Private Attributes
unsigned long	sequence_
short	proc_
short	index_
Friends
ostream &	operator<< (ostream &out, const ABA_ID &id)
int	operator== (const ABA_ID &lhs, const ABA_ID &rhs)

---

Detailed Description

instance of the class ABA_ID is used for identification of the same object stored multiple times on different processors.

Definition at line 44 of file id.h.

---

Constructor & Destructor Documentation

ABA_ID::ABA_ID

(

)

The constructor.

sequence_ will be set to 0 indicating that the ABA_ID is not initialized.

ABA_ID::ABA_ID

(

ABA_MESSAGE &

msg

)

The message constructor.

Parameters:

msg

The message from which the object is initialized.

---

Member Function Documentation

void ABA_ID::pack

(

ABA_MESSAGE &

msg

)

const

Packs the ABA_ID in an ABA_MESSAGE object.

Parameters:

msg

The ABA_MESSAGE object in which the ABA_ID is packed.

void ABA_ID::initialize	(	unsigned long	sequence,
		int	proc,
		int	index
	)

Sets the processor number and the sequence number.

Parameters:

	sequence	The sequence number of the ABA_ID.
	proc	The processor number of the ABA_ID.
	index	If a constraint/variable is identified, then this optional parameter determines the index of the pool in which the constraint/variable is stored.

void ABA_ID::uninitialize

(

)

Sets the ABA_ID to the uninitialized state.

bool ABA_ID::isInitialized

(

)

const

Tests if the ABA_ID was initialized.

Returns:

false If the ABA_ID is not initialized.

true If the ABA_ID is initialized.

unsigned long ABA_ID::sequence

(

)

const [inline]

Definition at line 113 of file id.h.

int ABA_ID::proc

(

)

const [inline]

Definition at line 114 of file id.h.

int ABA_ID::index

(

)

const [inline]

Definition at line 115 of file id.h.

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	out,
		const ABA_ID &	id
	)			[friend]

The output operator.

Returns:

A reference to the output stream.

Parameters:

	out	The output stream.
	id	The ABA_ID being output.

int operator==	(	const ABA_ID &	lhs,
		const ABA_ID &	rhs
	)			[friend]

The comparison operator.

Returns:

0 If both ABA_ID objects are not equal,

1 otherwise.

Parameters:

	lhs	The left hand side of the comparison.
	rhs	The right hand side of the comparison.

---

Member Data Documentation

unsigned long ABA_ID::sequence_ [private]

Definition at line 109 of file id.h.

short ABA_ID::proc_ [private]

Definition at line 110 of file id.h.

short ABA_ID::index_ [private]

Definition at line 111 of file id.h.

---

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

• Include/abacus/id.h

---