Arcane::MessagePassing::IStat Class Reference

Statistics on parallelism. More...

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

Inheritance diagram for Arcane::MessagePassing::IStat:

Collaboration diagram for Arcane::MessagePassing::IStat:

Public Types
using	OneStatMap = std::map<String, OneStat*>

Public Member Functions
virtual	~IStat ()=default
	Frees resources.
virtual void	add (const String &name, double elapsed_time, Int64 msg_size)=0
	Adds a statistic.
virtual void	enable (bool is_enabled)=0
	Enables or disables statistics.
virtual const StatCollection &	statList () const =0
	Retrieval of statistics.
virtual void	resetCurrentStat ()=0
	Resets current statistics.
virtual const OneStatMap &	stats () const =0
	Retrieval of statistics.

Detailed Description

Statistics on parallelism.

Todo

make thread-safe

Definition at line 136 of file arccore/src/message_passing/arccore/message_passing/IStat.h.

Member Typedef Documentation

OneStatMap

using Arcane::MessagePassing::IStat::OneStatMap = std::map<String, OneStat*>

Definition at line 141 of file arccore/src/message_passing/arccore/message_passing/IStat.h.

Member Function Documentation

add()

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

pure virtual

Adds a statistic.

Parameters

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

Implemented in Arcane::MessagePassing::Stat, Arcane::Parallel::Stat, and Arccore::MessagePassing::Stat.

enable()

virtual void Arcane::MessagePassing::IStat::enable ( bool is_enabled )

pure virtual

Enables or disables statistics.

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

Implemented in Arcane::MessagePassing::Stat, Arcane::Parallel::Stat, and Arccore::MessagePassing::Stat.

resetCurrentStat()

virtual void Arcane::MessagePassing::IStat::resetCurrentStat ( )

pure virtual

Resets current statistics.

Implemented in Arcane::MessagePassing::Stat, and Arccore::MessagePassing::Stat.

statList()

virtual const StatCollection & Arcane::MessagePassing::IStat::statList ( ) const

pure virtual

Retrieval of statistics.

Implemented in Arcane::MessagePassing::Stat, and Arccore::MessagePassing::Stat.

stats()

virtual const OneStatMap & Arcane::MessagePassing::IStat::stats ( ) const

pure virtual

Retrieval of statistics.

Implemented in Arcane::MessagePassing::Stat, and Arccore::MessagePassing::Stat.

References stats().

Referenced by stats().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• arccore/src/message_passing/arccore/message_passing/IStat.h