Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::MessagePassing::GatherMessageInfoBase Class Reference

Brief information for a 'gather' message. More...

#include <arccore/message_passing/GatherMessageInfo.h>

Public Types

enum class  Mode { Gather , GatherVariable , GatherVariableNeedComputeInfo , Null }
 Message mode. More...

Public Member Functions

 GatherMessageInfoBase ()=default
 Message for everyone and blocking.
 GatherMessageInfoBase (MessageRank dest_rank)
 Blocking message having destination rank.
 GatherMessageInfoBase (MessageRank dest_rank, eBlockingType blocking_type)
 Message having destination dest_rank and blocking mode blocking_type.
void setBlocking (bool is_blocking)
bool isBlocking () const
 Indicates if the message is blocking.
MessageRank destinationRank () const
 Rank of the message destination.
void setDestinationRank (MessageRank rank)
 Sets the rank of the message destination.
Mode mode () const
 Message mode.
void print (std::ostream &o) const
 Prints the message.
bool isValid () const

Protected Member Functions

void _setType (Mode t)

Friends

std::ostream & operator<< (std::ostream &o, const GatherMessageInfoBase &pmessage)

Detailed Description

Brief information for a 'gather' message.

It is better to use the GatherMessageInfo class rather than this class. This class allows using 'Gather', 'GatherVariable', 'AllGather', and 'AllGatherVariable' messages generically.

Definition at line 36 of file GatherMessageInfo.h.

Member Enumeration Documentation

◆ Mode

enum class Arcane::MessagePassing::GatherMessageInfoBase::Mode
strong

Message mode.

Definition at line 41 of file GatherMessageInfo.h.

Constructor & Destructor Documentation

◆ GatherMessageInfoBase() [1/2]

Arcane::MessagePassing::GatherMessageInfoBase::GatherMessageInfoBase ( MessageRank dest_rank)
inlineexplicit

Blocking message having destination rank.

Definition at line 55 of file GatherMessageInfo.h.

◆ GatherMessageInfoBase() [2/2]

Arcane::MessagePassing::GatherMessageInfoBase::GatherMessageInfoBase ( MessageRank dest_rank,
eBlockingType blocking_type )
inline

Message having destination dest_rank and blocking mode blocking_type.

Definition at line 60 of file GatherMessageInfo.h.

Member Function Documentation

◆ _setType()

void Arcane::MessagePassing::GatherMessageInfoBase::_setType ( Mode t)
inlineprotected

Definition at line 108 of file GatherMessageInfo.h.

◆ destinationRank()

MessageRank Arcane::MessagePassing::GatherMessageInfoBase::destinationRank ( ) const
inline

Rank of the message destination.

Definition at line 75 of file GatherMessageInfo.h.

◆ isBlocking()

bool Arcane::MessagePassing::GatherMessageInfoBase::isBlocking ( ) const
inline

Indicates if the message is blocking.

Definition at line 72 of file GatherMessageInfo.h.

◆ isValid()

bool Arcane::MessagePassing::GatherMessageInfoBase::isValid ( ) const
inline

Definition at line 99 of file GatherMessageInfo.h.

◆ mode()

Mode Arcane::MessagePassing::GatherMessageInfoBase::mode ( ) const
inline

Message mode.

Definition at line 84 of file GatherMessageInfo.h.

◆ print()

void Arcane::MessagePassing::GatherMessageInfoBase::print ( std::ostream & o) const

Prints the message.

Definition at line 27 of file GatherMessageInfo.cc.

◆ setBlocking()

void Arcane::MessagePassing::GatherMessageInfoBase::setBlocking ( bool is_blocking)
inline

Definition at line 67 of file GatherMessageInfo.h.

◆ setDestinationRank()

void Arcane::MessagePassing::GatherMessageInfoBase::setDestinationRank ( MessageRank rank)
inline

Sets the rank of the message destination.

Definition at line 78 of file GatherMessageInfo.h.

◆ operator<<

std::ostream & operator<< ( std::ostream & o,
const GatherMessageInfoBase & pmessage )
friend

Definition at line 89 of file GatherMessageInfo.h.

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