TIMPI::MessageTag Class Reference

Encapsulates the MPI tag integers. More...

#include <message_tag.h>

Public Member Functions
	MessageTag (int tagvalue=invalid_tag)
	Explicit constructor, to discourage using "magic numbers" as tags.
	MessageTag (const MessageTag &other)
	Copy constructor.
	MessageTag (MessageTag &&other)
	Move constructor.
MessageTag &	operator= (const MessageTag &other)
	Copy assignment operator.
MessageTag &	operator= (MessageTag &&other)
	Move assignment operator.
	~MessageTag ()
	Destructor.
int	value () const

Static Public Attributes
static const int	invalid_tag = INT_MIN
	Invalid tag, to allow for default construction.

Private Member Functions
	MessageTag (int tagvalue, const Communicator *comm)

Private Attributes
int	_tagvalue
const Communicator *	_comm

Friends
class	Communicator

Detailed Description

Encapsulates the MPI tag integers.

Definition at line 46 of file message_tag.h.

Constructor & Destructor Documentation

MessageTag() [1/4]

TIMPI::MessageTag::MessageTag ( int  tagvalue = invalid_tag )

inlineexplicit

Explicit constructor, to discourage using "magic numbers" as tags.

Communicator::get_unique_tag is recommended instead.

Definition at line 59 of file message_tag.h.

    : _tagvalue(tagvalue), _comm(nullptr) {}

MessageTag() [2/4]

TIMPI::MessageTag::MessageTag

(

const MessageTag &

other

)

Copy constructor.

Helps Communicator do reference counting on unique tags

Definition at line 39 of file message_tag.C.

  : _tagvalue(other._tagvalue), _comm(other._comm)
{
  if (_comm)
    _comm->reference_unique_tag(_tagvalue);
}

References _comm, _tagvalue, and TIMPI::Communicator::reference_unique_tag().

MessageTag() [3/4]

TIMPI::MessageTag::MessageTag

(

MessageTag &&

other

)

Move constructor.

Helps Communicator do reference counting on unique tags

Definition at line 47 of file message_tag.C.

  : _tagvalue(other._tagvalue), _comm(other._comm)
{
  // I stole your tag reference!
  other._comm = nullptr;
}

References TIMPI::cast_int().

~MessageTag()

TIMPI::MessageTag::~MessageTag

(

)

Destructor.

Helps Communicator do reference counting on unique tags

Definition at line 32 of file message_tag.C.

{
  if (_comm)
    _comm->dereference_unique_tag(_tagvalue);
}

References _comm, _tagvalue, and TIMPI::Communicator::dereference_unique_tag().

MessageTag() [4/4]

TIMPI::MessageTag::MessageTag ( int  tagvalue, const Communicator *  comm  )

inlineprivate

Definition at line 101 of file message_tag.h.

    : _tagvalue(tagvalue), _comm(comm) {}

Member Function Documentation

operator=() [1/2]

MessageTag & TIMPI::MessageTag::operator=

(

const MessageTag &

other

)

Copy assignment operator.

Helps Communicator do reference counting on unique tags

Definition at line 55 of file message_tag.C.

{
  if (_comm)
    _comm->dereference_unique_tag(_tagvalue);
 
  _tagvalue = other._tagvalue;
  _comm = other._comm;
 
  if (_comm)
    _comm->reference_unique_tag(_tagvalue);
 
  return *this;
}

References _comm, _tagvalue, TIMPI::cast_int(), TIMPI::Communicator::dereference_unique_tag(), and TIMPI::Communicator::reference_unique_tag().

operator=() [2/2]

MessageTag & TIMPI::MessageTag::operator=

(

MessageTag &&

other

)

Move assignment operator.

Helps Communicator do reference counting on unique tags

Definition at line 70 of file message_tag.C.

{
  if (_comm)
    _comm->dereference_unique_tag(_tagvalue);
 
  _tagvalue = other._tagvalue;
  _comm = other._comm;
 
  // I stole your tag reference!
  other._comm = nullptr;
 
  return *this;
}

References _comm, _tagvalue, TIMPI::cast_int(), and TIMPI::Communicator::dereference_unique_tag().

value()

int TIMPI::MessageTag::value ( ) const

inline

Definition at line 92 of file message_tag.h.

                    {
    return _tagvalue;
  }

References _tagvalue.

Referenced by TIMPI::Communicator::possibly_receive(), TIMPI::Communicator::possibly_receive(), TIMPI::Communicator::probe(), TIMPI::Communicator::receive(), TIMPI::Communicator::receive(), TIMPI::Communicator::send(), TIMPI::Communicator::send(), TIMPI::Communicator::send(), TIMPI::Communicator::send(), and testGetUniqueTagAuto().

Friends And Related Symbol Documentation

Communicator

friend class Communicator

friend

Definition at line 105 of file message_tag.h.

Member Data Documentation

_comm

const Communicator* TIMPI::MessageTag::_comm

private

Definition at line 98 of file message_tag.h.

Referenced by MessageTag(), operator=(), operator=(), and ~MessageTag().

_tagvalue

int TIMPI::MessageTag::_tagvalue

private

Definition at line 97 of file message_tag.h.

Referenced by MessageTag(), operator=(), operator=(), value(), and ~MessageTag().

invalid_tag

const int TIMPI::MessageTag::invalid_tag = INT_MIN

static

Invalid tag, to allow for default construction.

Definition at line 53 of file message_tag.h.

Referenced by TIMPI::Communicator::get_unique_tag().

---

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

• src/parallel/include/timpi/message_tag.h
• src/parallel/src/message_tag.C