kamping::plugin::grid_plugin_helpers::MessageEnvelope< PayloadType, Attributes > Struct Template Reference

Augments a plain message with additional information via. More...

#include <alltoall_grid.hpp>

Inheritance diagram for kamping::plugin::grid_plugin_helpers::MessageEnvelope< PayloadType, Attributes >:

Collaboration diagram for kamping::plugin::grid_plugin_helpers::MessageEnvelope< PayloadType, Attributes >:

Public Types
using	Payload = PayloadType
	Underlying Type of message.

Public Member Functions
	MessageEnvelope ()=default
	Default constructor.
	MessageEnvelope (PayloadType payload)
	Constructor for wrapping a message.
Payload &	get_payload ()
	Return reference to payload.
Payload const &	get_payload () const
	Return const reference to payload.

Public Attributes
Payload	_payload
	payload

Static Public Attributes
static constexpr bool	has_source_information
static constexpr bool	has_destination_information

Friends
std::ostream &	operator<< (std::ostream &out, MessageEnvelope const &msg)
	Output operator.

Detailed Description

template<typename PayloadType, typename... Attributes>
struct kamping::plugin::grid_plugin_helpers::MessageEnvelope< PayloadType, Attributes >

Augments a plain message with additional information via.

Template Parameters

Attributes
PayloadType	Plain message type.
Attributes	source or destination information

Member Data Documentation

has_destination_information

template<typename PayloadType , typename... Attributes>

constexpr bool kamping::plugin::grid_plugin_helpers::MessageEnvelope< PayloadType, Attributes >::has_destination_information

staticconstexpr

Initial value:

=
        internal::type_list<Attributes...>::template contains<Destination>

Indicates whether the envelope contains the destination PE.

has_source_information

template<typename PayloadType , typename... Attributes>

constexpr bool kamping::plugin::grid_plugin_helpers::MessageEnvelope< PayloadType, Attributes >::has_source_information

staticconstexpr

Initial value:

=
        internal::type_list<Attributes...>::template contains<Source>

Indicates whether the envelope contains the source PE.

---

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

• include/kamping/plugin/alltoall_grid.hpp