Arcane::Parallel::Stat Class Reference

Statistics on parallelism. More...

Classes
class	CumulativeStat
class	SerializedStats
	Serialization info. More...

Public Types
using	Base = MP::Stat
using	CumulativeStatMap = std::map<String, CumulativeStat>
Public Types inherited from Arcane::MessagePassing::Stat
using	OneStatMap = std::map<String, OneStat*>
	DEPRECATED.
typedef std::pair< String, OneStat * >	OneStatValue
Public Types inherited from Arcane::MessagePassing::IStat
using	OneStatMap = std::map<String, OneStat*>

Public Member Functions
MP::IStat *	toArccoreStat () override
void	add (const String &name, double elapsed_time, Int64 msg_size) override
	Adds a statistic.
void	print (ITraceMng *msg) override
	Prints the statistics to trace.
void	enable (bool is_enabled) override
	Enables or disables statistics.
void	dumpJSON (JSONWriter &writer) override
	Outputs the statistics in JSON format.
void	saveValues (ITraceMng *tm, Properties *p) override
	Saves the current values into p.
void	mergeValues (ITraceMng *tm, Properties *p) override
	Merges the current values with those saved in p.
void	printCollective (IParallelMng *pm) override
	Displays the statistics collectively.
Public Member Functions inherited from Arcane::MessagePassing::Stat
	~Stat () override
	Releases resources.
void	print (std::ostream &o)
const OneStatMap &	stats () const override
	Retrieval of statistics.
const StatData &	getData () const
const StatCollection &	statList () const override
	Retrieval of statistics.
void	resetCurrentStat () override
	Resets current statistics.
Public Member Functions inherited from Arcane::MessagePassing::IStat
virtual	~IStat ()=default
	Frees resources.
Public Member Functions inherited from Arcane::Parallel::IStat
virtual	~IStat ()
	Frees resources.

Detailed Description

Statistics on parallelism.

Definition at line 46 of file arcane/src/arcane/core/parallel/Stat.cc.

Member Typedef Documentation

Base

using Arcane::Parallel::Stat::Base = MP::Stat

Definition at line 52 of file arcane/src/arcane/core/parallel/Stat.cc.

CumulativeStatMap

using Arcane::Parallel::Stat::CumulativeStatMap = std::map<String, CumulativeStat>

Definition at line 64 of file arcane/src/arcane/core/parallel/Stat.cc.

Member Function Documentation

add()

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

overridevirtual

Adds a statistic.

Parameters

name	name of the statistic
elapsed_time	time used for the message
msg_size	size of the message sent.

Reimplemented from Arcane::MessagePassing::Stat.

Definition at line 149 of file arcane/src/arcane/core/parallel/Stat.cc.

References Arccore::MessagePassing::Stat::add().

dumpJSON()

void Arcane::Parallel::Stat::dumpJSON ( JSONWriter & writer )

overridevirtual

Outputs the statistics in JSON format.

Implements Arcane::Parallel::IStat.

Definition at line 184 of file arcane/src/arcane/core/parallel/Stat.cc.

References Arcane::Parallel::dumpJSON(), and Arcane::MessagePassing::Stat::statList().

enable()

void Arcane::Parallel::Stat::enable ( bool is_enabled )

inlineoverridevirtual

Enables or disables statistics.

If statistics are disabled, the call to add() has no effect.

Reimplemented from Arcane::MessagePassing::Stat.

Definition at line 109 of file arcane/src/arcane/core/parallel/Stat.cc.

mergeValues()

void Arcane::Parallel::Stat::mergeValues ( ITraceMng * tm, Properties * p )

overridevirtual

Merges the current values with those saved in p.

Implements Arcane::Parallel::IStat.

Definition at line 218 of file arcane/src/arcane/core/parallel/Stat.cc.

References Arcane::Properties::get(), Arcane::Properties::getInt32WithDefault(), and Arcane::ITraceMng::info().

print()

void Arcane::Parallel::Stat::print ( ITraceMng * trace )

overridevirtual

Prints the statistics to trace.

Implements Arcane::Parallel::IStat.

Definition at line 158 of file arcane/src/arcane/core/parallel/Stat.cc.

References Arcane::ITraceMng::info(), Arcane::MessagePassing::Stat::statList(), and Arcane::Convert::toInt64().

printCollective()

void Arcane::Parallel::Stat::printCollective ( IParallelMng * pm )

overridevirtual

Displays the statistics collectively.

Displays statistics common to all ranks associated with pm.

This operation is collective.

Implements Arcane::Parallel::IStat.

Definition at line 282 of file arcane/src/arcane/core/parallel/Stat.cc.

References Arcane::ITraceMng::info(), and Arcane::IParallelMng::traceMng().

saveValues()

void Arcane::Parallel::Stat::saveValues ( ITraceMng * tm, Properties * p )

overridevirtual

Saves the current values into p.

Implements Arcane::Parallel::IStat.

Definition at line 197 of file arcane/src/arcane/core/parallel/Stat.cc.

References Arcane::ITraceMng::info(), and Arcane::Properties::set().

toArccoreStat()

MP::IStat * Arcane::Parallel::Stat::toArccoreStat ( )

inlineoverridevirtual

Implements Arcane::Parallel::IStat.

Definition at line 105 of file arcane/src/arcane/core/parallel/Stat.cc.

---

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

• arcane/src/arcane/core/parallel/Stat.cc