TIMPI::Status Class Reference

Encapsulates the MPI_Status struct. More...

#include <status.h>

Public Member Functions
	Status ()=default
	~Status ()=default
	Status (const Status &)=default
	Status (Status &&)=default
Status &	operator= (const Status &)=default
Status &	operator= (Status &&)=default
	Status (const data_type &type)
	Status (const status &status)
	Status (const status &status, const data_type &type)
	Status (const Status &status, const data_type &type)
status *	get ()
status const *	get () const
int	source () const
int	tag () const
data_type &	datatype ()
const data_type &	datatype () const
CountType	size (const data_type &type) const
CountType	size () const

Private Attributes
status	_status
data_type	_datatype

Detailed Description

Encapsulates the MPI_Status struct.

Allows the source and size of the message to be determined.

Definition at line 75 of file status.h.

Constructor & Destructor Documentation

Status() [1/7]

TIMPI::Status::Status ( )

default

~Status()

TIMPI::Status::~Status ( )

default

Status() [2/7]

TIMPI::Status::Status ( const Status &  )

default

Status() [3/7]

TIMPI::Status::Status ( Status &&  )

default

Status() [4/7]

TIMPI::Status::Status ( const data_type &  type )

inlineexplicit

Definition at line 120 of file status.h.

                                             :
  _status(),
  _datatype(type)
{}

Status() [5/7]

TIMPI::Status::Status ( const status &  status )

inlineexplicit

Definition at line 125 of file status.h.

                                          :
  _status(stat),
  _datatype()
{}

Status() [6/7]

TIMPI::Status::Status ( const status &  status, const data_type &  type  )

inline

Definition at line 130 of file status.h.

                                               :
  _status(stat),
  _datatype(type)
{}

Status() [7/7]

TIMPI::Status::Status ( const Status &  status, const data_type &  type  )

inline

Definition at line 136 of file status.h.

                                               :
  _status(stat._status),
  _datatype(type)
{}

Member Function Documentation

datatype() [1/2]

data_type& TIMPI::Status::datatype ( )

inline

Definition at line 103 of file status.h.

References _datatype.

Referenced by size().

{ return _datatype; }

datatype() [2/2]

const data_type& TIMPI::Status::datatype ( ) const

inline

Definition at line 105 of file status.h.

References _datatype.

{ return _datatype; }

get() [1/2]

status* TIMPI::Status::get ( )

inline

Definition at line 95 of file status.h.

References _status.

Referenced by TIMPI::Communicator::packed_range_probe(), TIMPI::Communicator::possibly_receive(), and TIMPI::Communicator::receive().

{ return &_status; }

get() [2/2]

status const* TIMPI::Status::get ( ) const

inline

Definition at line 97 of file status.h.

References _status.

{ return &_status; }

operator=() [1/2]

Status& TIMPI::Status::operator= ( const Status &  )

default

operator=() [2/2]

Status& TIMPI::Status::operator= ( Status &&  )

default

size() [1/2]

CountType TIMPI::Status::size ( const data_type &  type ) const

inline

Definition at line 161 of file status.h.

References _status, and TIMPI::ignore().

Referenced by TIMPI::Communicator::nonblocking_receive_packed_range(), and TIMPI::Communicator::possibly_receive().

{
  ignore(type); // We don't use this ifndef TIMPI_HAVE_MPI
  CountType msg_size = 1;
  timpi_call_mpi
    (TIMPI_GET_COUNT(const_cast<MPI_Status*>(&_status), type,
                     &msg_size));

  timpi_assert_greater_equal (msg_size, 0);
  return msg_size;
}

size() [2/2]

CountType TIMPI::Status::size ( ) const

inline

Definition at line 173 of file status.h.

References datatype().

{ return this->size (this->datatype()); }

source()

int TIMPI::Status::source ( ) const

inline

Definition at line 142 of file status.h.

References _status.

Referenced by TIMPI::Communicator::possibly_receive(), and TIMPI::Communicator::receive_packed_range().

{
#ifdef TIMPI_HAVE_MPI
  return _status.MPI_SOURCE;
#else
  return 0;
#endif
}

tag()

int TIMPI::Status::tag ( ) const

inline

Definition at line 151 of file status.h.

References _status.

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

{
#ifdef TIMPI_HAVE_MPI
  return _status.MPI_TAG;
#else
  timpi_not_implemented();
  return 0;
#endif
}

Member Data Documentation

_datatype

data_type TIMPI::Status::_datatype

private

Definition at line 114 of file status.h.

Referenced by datatype().

_status

status TIMPI::Status::_status

private

Definition at line 113 of file status.h.

Referenced by get(), size(), source(), and tag().

---

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

• src/parallel/include/timpi/status.h