Référence de la classe Arccore::MessagePassing::GatherMessageInfoBase

Informations pour un message 'gather'. Plus de détails...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/message_passing/arccore/message_passing/GatherMessageInfo.h>

Graphe d'héritage de Arccore::MessagePassing::GatherMessageInfoBase:

Graphe de collaboration de Arccore::MessagePassing::GatherMessageInfoBase:

Types publics
enum class	Mode { Gather , GatherVariable , GatherVariableNeedComputeInfo , Null }
	Mode du message. Plus de détails...

Fonctions membres publiques
	GatherMessageInfoBase ()=default
	Message pout tout le monde et bloquant.
	GatherMessageInfoBase (MessageRank dest_rank)
	Message bloquant ayant pour destination rank.
	GatherMessageInfoBase (MessageRank dest_rank, eBlockingType blocking_type)
	Message ayant pour destination dest_rank et mode bloquant blocking_type.
void	setBlocking (bool is_blocking)
bool	isBlocking () const
	Indique si le message est bloquant.
MessageRank	destinationRank () const
	Rang de la destination du message.
void	setDestinationRank (MessageRank rank)
	Positionne le rang de la destination du message.
Mode	mode () const
	Mode du message.
void	print (std::ostream &o) const
	Affiche le message.
bool	isValid () const

Fonctions membres protégées
void	_setType (Mode t)

Attributs privés
MessageRank	m_destination_rank
bool	m_is_blocking = true
Mode	m_mode = Mode::Null

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

Description détaillée

Informations pour un message 'gather'.

Il faut plutôt utiliser la classe GatherMessageInfo plutôt que cette classe. Cette classe permet d'utiliser les messages de type 'Gather', 'GatherVariable', 'AllGather' et 'AllGatherVariable' de manière générique.

Définition à la ligne 32 du fichier GatherMessageInfo.h.

Documentation des énumérations membres

Mode

enum class Arccore::MessagePassing::GatherMessageInfoBase::Mode

strong

Mode du message.

Définition à la ligne 37 du fichier GatherMessageInfo.h.

Documentation des constructeurs et destructeur

GatherMessageInfoBase() [1/2]

Arccore::MessagePassing::GatherMessageInfoBase::GatherMessageInfoBase ( MessageRank  dest_rank )

inlineexplicit

Message bloquant ayant pour destination rank.

Définition à la ligne 51 du fichier GatherMessageInfo.h.

GatherMessageInfoBase() [2/2]

Arccore::MessagePassing::GatherMessageInfoBase::GatherMessageInfoBase ( MessageRank  dest_rank, eBlockingType  blocking_type  )

inline

Message ayant pour destination dest_rank et mode bloquant blocking_type.

Définition à la ligne 56 du fichier GatherMessageInfo.h.

Documentation des fonctions membres

_setType()

void Arccore::MessagePassing::GatherMessageInfoBase::_setType ( Mode  t )

inlineprotected

Définition à la ligne 103 du fichier GatherMessageInfo.h.

destinationRank()

MessageRank Arccore::MessagePassing::GatherMessageInfoBase::destinationRank ( ) const

inline

Rang de la destination du message.

Définition à la ligne 71 du fichier GatherMessageInfo.h.

isBlocking()

bool Arccore::MessagePassing::GatherMessageInfoBase::isBlocking ( ) const

inline

Indique si le message est bloquant.

Définition à la ligne 68 du fichier GatherMessageInfo.h.

isValid()

bool Arccore::MessagePassing::GatherMessageInfoBase::isValid ( ) const

inline

Définition à la ligne 94 du fichier GatherMessageInfo.h.

mode()

Mode Arccore::MessagePassing::GatherMessageInfoBase::mode ( ) const

inline

Mode du message.

Définition à la ligne 80 du fichier GatherMessageInfo.h.

print()

void Arccore::MessagePassing::GatherMessageInfoBase::print

(

std::ostream &

o

)

const

Affiche le message.

Définition à la ligne 27 du fichier GatherMessageInfo.cc.

setBlocking()

void Arccore::MessagePassing::GatherMessageInfoBase::setBlocking ( bool  is_blocking )

inline

Définition à la ligne 63 du fichier GatherMessageInfo.h.

setDestinationRank()

void Arccore::MessagePassing::GatherMessageInfoBase::setDestinationRank ( MessageRank  rank )

inline

Positionne le rang de la destination du message.

Définition à la ligne 74 du fichier GatherMessageInfo.h.

Documentation des fonctions amies et associées

operator<<

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

friend

Définition à la ligne 85 du fichier GatherMessageInfo.h.

Documentation des données membres

m_destination_rank

MessageRank Arccore::MessagePassing::GatherMessageInfoBase::m_destination_rank

private

Définition à la ligne 110 du fichier GatherMessageInfo.h.

m_is_blocking

bool Arccore::MessagePassing::GatherMessageInfoBase::m_is_blocking = true

private

Définition à la ligne 111 du fichier GatherMessageInfo.h.

m_mode

Mode Arccore::MessagePassing::GatherMessageInfoBase::m_mode = Mode::Null

private

Définition à la ligne 112 du fichier GatherMessageInfo.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• GatherMessageInfo.h
• GatherMessageInfo.cc