Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::Parallel::IStat Class Referenceabstract

Statistics on parallelism. More...

#include <arcane/core/parallel/IStat.h>

Public Member Functions

virtual ~IStat ()
 Frees resources.
virtual void add (const String &name, double elapsed_time, Int64 msg_size)=0
 Adds a statistic.
virtual void print (ITraceMng *trace)=0
 Prints the statistics to trace.
virtual void printCollective (IParallelMng *pm)=0
 Displays the statistics collectively.
virtual void enable (bool is_enabled)=0
 Enables or disables the statistics.
virtual void dumpJSON (JSONWriter &writer)=0
 Outputs the statistics in JSON format.
virtual void saveValues (ITraceMng *tm, Properties *p)=0
 Saves the current values into p.
virtual void mergeValues (ITraceMng *tm, Properties *p)=0
 Merges the current values with those saved in p.
virtual Arccore::MessagePassing::IStattoArccoreStat ()=0

Detailed Description

Statistics on parallelism.

Definition at line 42 of file arcane/src/arcane/core/parallel/IStat.h.

Constructor & Destructor Documentation

◆ ~IStat()

virtual Arcane::Parallel::IStat::~IStat ( )
inlinevirtual

Frees resources.

Definition at line 47 of file arcane/src/arcane/core/parallel/IStat.h.

Member Function Documentation

◆ add()

virtual void Arcane::Parallel::IStat::add ( const String & name,
double elapsed_time,
Int64 msg_size )
pure virtual

Adds a statistic.

Parameters
namename of the statistic.
elapsed_timetime used for the message.
msg_sizesize of the sent message.

Implemented in Arcane::Parallel::Stat.

Referenced by Arcane::Materials::ItemMaterialVariableScalar< DataType >::synchronize().

◆ dumpJSON()

virtual void Arcane::Parallel::IStat::dumpJSON ( JSONWriter & writer)
pure virtual

Outputs the statistics in JSON format.

Implemented in Arcane::Parallel::Stat.

◆ enable()

virtual void Arcane::Parallel::IStat::enable ( bool is_enabled)
pure virtual

Enables or disables the statistics.

Implemented in Arcane::Parallel::Stat.

◆ mergeValues()

virtual void Arcane::Parallel::IStat::mergeValues ( ITraceMng * tm,
Properties * p )
pure virtual

Merges the current values with those saved in p.

Implemented in Arcane::Parallel::Stat.

◆ print()

virtual void Arcane::Parallel::IStat::print ( ITraceMng * trace)
pure virtual

Prints the statistics to trace.

Implemented in Arcane::Parallel::Stat.

◆ printCollective()

virtual void Arcane::Parallel::IStat::printCollective ( IParallelMng * pm)
pure virtual

Displays the statistics collectively.

Displays statistics common to all ranks associated with pm.

This operation is collective.

Implemented in Arcane::Parallel::Stat.

Referenced by Arcane::Parallel::printStatsCollective().

◆ saveValues()

virtual void Arcane::Parallel::IStat::saveValues ( ITraceMng * tm,
Properties * p )
pure virtual

Saves the current values into p.

Implemented in Arcane::Parallel::Stat.


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