Arcane::MessagePassing::Stat Class Reference

Statistics manager for parallelism. More...

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

Inheritance diagram for Arcane::MessagePassing::Stat:

Collaboration diagram for Arcane::MessagePassing::Stat:

Public Types
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
	~Stat () override
	Releases resources.
void	add (const String &name, double elapsed_time, Int64 msg_size) override
	Adds a statistic.
void	enable (bool is_enabled) override
	Enables or disables statistics.
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.

Private Member Functions
OneStat *	_find (const String &name)

Private Attributes
bool	m_is_enabled = true
OneStatMap	m_list
StatData	m_data

Detailed Description

Statistics manager for parallelism.

This class is internal to Arccore.

Definition at line 72 of file Stat.h.

Member Typedef Documentation

OneStatMap

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

DEPRECATED.

Definition at line 78 of file Stat.h.

OneStatValue

typedef std::pair<String, OneStat*> Arcane::MessagePassing::Stat::OneStatValue

Definition at line 82 of file Stat.h.

Constructor & Destructor Documentation

~Stat()

Arcane::MessagePassing::Stat::~Stat ( )

override

Releases resources.

Definition at line 86 of file arccore/src/message_passing/arccore/message_passing/Stat.cc.

Member Function Documentation

_find()

OneStat * Arcane::MessagePassing::Stat::_find ( const String & name )

private

Definition at line 141 of file arccore/src/message_passing/arccore/message_passing/Stat.cc.

add()

void Arcane::MessagePassing::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.

Implements Arcane::MessagePassing::IStat.

Reimplemented in Arcane::Parallel::Stat.

Definition at line 100 of file arccore/src/message_passing/arccore/message_passing/Stat.cc.

References Arcane::MessagePassing::OneStat::addMessage().

Here is the call graph for this function:

enable()

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

inlineoverridevirtual

Enables or disables statistics.

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

Implements Arcane::MessagePassing::IStat.

Reimplemented in Arcane::Parallel::Stat.

Definition at line 92 of file Stat.h.

getData()

const StatData & Arcane::MessagePassing::Stat::getData ( ) const

inline

Definition at line 100 of file Stat.h.

print()

void Arcane::MessagePassing::Stat::print

(

std::ostream &

o

)

Definition at line 115 of file arccore/src/message_passing/arccore/message_passing/Stat.cc.

resetCurrentStat()

void Arcane::MessagePassing::Stat::resetCurrentStat ( )

overridevirtual

Resets current statistics.

Implements Arcane::MessagePassing::IStat.

Definition at line 128 of file arccore/src/message_passing/arccore/message_passing/Stat.cc.

statList()

const StatCollection & Arcane::MessagePassing::Stat::statList ( ) const

overridevirtual

Retrieval of statistics.

Implements Arcane::MessagePassing::IStat.

Definition at line 216 of file arccore/src/message_passing/arccore/message_passing/Stat.cc.

Referenced by Arcane::Parallel::Stat::_mergeStats(), Arcane::Parallel::Stat::dumpJSON(), and Arcane::Parallel::Stat::print().

Here is the caller graph for this function:

stats()

const OneStatMap & Arcane::MessagePassing::Stat::stats ( ) const

inlineoverridevirtual

Retrieval of statistics.

Implements Arcane::MessagePassing::IStat.

Definition at line 97 of file Stat.h.

References stats().

Referenced by stats().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_data

StatData Arcane::MessagePassing::Stat::m_data

private

Definition at line 110 of file Stat.h.

m_is_enabled

bool Arcane::MessagePassing::Stat::m_is_enabled = true

private

Definition at line 108 of file Stat.h.

m_list

OneStatMap Arcane::MessagePassing::Stat::m_list

private

Definition at line 109 of file Stat.h.

---

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

• Stat.h
• arccore/src/message_passing/arccore/message_passing/Stat.cc