Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ItemFamilySerializeArgs Class Reference

Arguments for the serialization callbacks of entity families. More...

#include <arcane/core/ItemFamilySerializeArgs.h>

Collaboration diagram for Arcane::ItemFamilySerializeArgs:

Public Member Functions

 ItemFamilySerializeArgs (ISerializer *aserializer, Int32 arank, Int32ConstArrayView local_ids, Integer message_index)
ISerializerserializer () const
 Associated serializer.
Int32 rank () const
 Rank of the source or destination.
Int32ConstArrayView localIds () const
 Local indices of the entities. During serialization, these are the local indices of the entities sent to rank rank(). During deserialization, these are the local indices received by rank rank().
Integer messageIndex () const
 Message index in the list of messages.

Public Attributes

ISerializerm_serializer = nullptr
Int32 m_rank = A_NULL_RANK
Int32ConstArrayView m_local_ids
Integer m_message_index = -1

Detailed Description

Arguments for the serialization callbacks of entity families.

The meaning of the arguments depends on the serialization mode.

In ISerializer::ModeReserve or ISerializer::ModePut mode:

  • rank() is the rank of the destination family
  • localIds() contains the local indices of the entities that will be sent to the destination family.

In ISerializer::ModeGet mode:

  • rank() is the rank of the source family.
  • localIds() contains the local indices of the entities that have just been received.

Definition at line 46 of file ItemFamilySerializeArgs.h.

Constructor & Destructor Documentation

◆ ItemFamilySerializeArgs()

Arcane::ItemFamilySerializeArgs::ItemFamilySerializeArgs ( ISerializer * aserializer,
Int32 arank,
Int32ConstArrayView local_ids,
Integer message_index )
inline

Definition at line 50 of file ItemFamilySerializeArgs.h.

Member Function Documentation

◆ localIds()

Int32ConstArrayView Arcane::ItemFamilySerializeArgs::localIds ( ) const
inline

Local indices of the entities. During serialization, these are the local indices of the entities sent to rank rank(). During deserialization, these are the local indices received by rank rank().

Definition at line 77 of file ItemFamilySerializeArgs.h.

Referenced by Arcane::Materials::MeshMaterialExchangeMng::ExchangeCellStep::serialize(), and Arcane::mesh::ItemFamilyVariableSerializer::serialize().

Here is the caller graph for this function:

◆ messageIndex()

Integer Arcane::ItemFamilySerializeArgs::messageIndex ( ) const
inline

Message index in the list of messages.

Definition at line 80 of file ItemFamilySerializeArgs.h.

◆ rank()

Int32 Arcane::ItemFamilySerializeArgs::rank ( ) const
inline

Rank of the source or destination.

During serialization, it is the rank of the destination, and during deserialization it is the rank of the source.

Definition at line 69 of file ItemFamilySerializeArgs.h.

Referenced by Arcane::Materials::MeshMaterialExchangeMng::ExchangeCellStep::serialize(), Arcane::mesh::ItemFamilyVariableSerializer::serialize(), and Arcane::mesh::TiedInterfaceExchanger::serialize().

Here is the caller graph for this function:

◆ serializer()

ISerializer * Arcane::ItemFamilySerializeArgs::serializer ( ) const
inline

Associated serializer.

Definition at line 61 of file ItemFamilySerializeArgs.h.

Referenced by Arcane::Materials::MeshMaterialExchangeMng::ExchangeCellStep::serialize(), Arcane::mesh::ItemFamilyVariableSerializer::serialize(), and Arcane::mesh::TiedInterfaceExchanger::serialize().

Here is the caller graph for this function:

Member Data Documentation

◆ m_local_ids

Int32ConstArrayView Arcane::ItemFamilySerializeArgs::m_local_ids

Definition at line 86 of file ItemFamilySerializeArgs.h.

◆ m_message_index

Integer Arcane::ItemFamilySerializeArgs::m_message_index = -1

Definition at line 87 of file ItemFamilySerializeArgs.h.

◆ m_rank

Int32 Arcane::ItemFamilySerializeArgs::m_rank = A_NULL_RANK

Definition at line 85 of file ItemFamilySerializeArgs.h.

◆ m_serializer

ISerializer* Arcane::ItemFamilySerializeArgs::m_serializer = nullptr

Definition at line 84 of file ItemFamilySerializeArgs.h.


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