Statistic on a message. More...

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

Collaboration diagram for Arcane::MessagePassing::OneStat:

Public Member Functions
	OneStat (const String &name)
	OneStat (const String &name, Int64 msg_size, double elapsed_time)
const String &	name () const
	Name of the statistic.
Int64	nbMessage () const
	Number of messages sent.
void	setNbMessage (Int64 v)
Int64	cumulativeNbMessage () const
	Number of messages sent throughout the execution time.
void	setCumulativeNbMessage (Int64 v)
Int64	totalSize () const
	Total size of messages sent.
void	setTotalSize (Int64 v)
Int64	cumulativeTotalSize () const
	Total size of messages sent throughout the execution time.
void	setCumulativeTotalSize (Int64 v)
double	totalTime () const
	Total elapsed time.
void	setTotalTime (double v)
double	cumulativeTotalTime () const
	Total elapsed time throughout the program execution.
void	setCumulativeTotalTime (double v)
void	print (std::ostream &o)
	Prints the instance information to o.
void	addMessage (Int64 msg_size, double elapsed_time)
	Adds a message.
void	resetCurrentStat ()
	Resets current statistics (non-cumulative).

Private Attributes
String	m_name
Int64	m_nb_msg = 0
Int64	m_total_size = 0
double	m_total_time = 0.0
Int64	m_cumulative_nb_msg = 0
Int64	m_cumulative_total_size = 0
double	m_cumulative_total_time = 0.0

Detailed Description

Statistic on a message.

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

Constructor & Destructor Documentation

◆ OneStat() [1/2]

Arcane::MessagePassing::OneStat::OneStat ( const String & name )

inlineexplicit

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

◆ OneStat() [2/2]

Arcane::MessagePassing::OneStat::OneStat	(	const String &	name,
		Int64	msg_size,
		double	elapsed_time )

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

Member Function Documentation

◆ addMessage()

void Arcane::MessagePassing::OneStat::addMessage	(	Int64	msg_size,
		double	elapsed_time )

Adds a message.

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

Referenced by Arcane::MessagePassing::Stat::add().

Here is the caller graph for this function:

◆ cumulativeNbMessage()

Int64 Arcane::MessagePassing::OneStat::cumulativeNbMessage ( ) const

inline

Number of messages sent throughout the execution time.

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

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

Here is the caller graph for this function:

◆ cumulativeTotalSize()

Int64 Arcane::MessagePassing::OneStat::cumulativeTotalSize ( ) const

inline

Total size of messages sent throughout the execution time.

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

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

Here is the caller graph for this function:

◆ cumulativeTotalTime()

double Arcane::MessagePassing::OneStat::cumulativeTotalTime ( ) const

inline

Total elapsed time throughout the program execution.

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

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

Here is the caller graph for this function:

◆ name()

const String & Arcane::MessagePassing::OneStat::name ( ) const

inline

Name of the statistic.

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

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

Here is the caller graph for this function:

◆ nbMessage()

Int64 Arcane::MessagePassing::OneStat::nbMessage ( ) const

inline

Number of messages sent.

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

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

Here is the caller graph for this function:

◆ print()

void Arcane::MessagePassing::OneStat::print ( std::ostream & o )

Prints the instance information to o.

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

◆ resetCurrentStat()

void Arcane::MessagePassing::OneStat::resetCurrentStat ( )

Resets current statistics (non-cumulative).

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

◆ setCumulativeNbMessage()

void Arcane::MessagePassing::OneStat::setCumulativeNbMessage ( Int64 v )

inline

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

◆ setCumulativeTotalSize()

void Arcane::MessagePassing::OneStat::setCumulativeTotalSize ( Int64 v )

inline

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

◆ setCumulativeTotalTime()

void Arcane::MessagePassing::OneStat::setCumulativeTotalTime ( double v )

inline

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

◆ setNbMessage()

void Arcane::MessagePassing::OneStat::setNbMessage ( Int64 v )

inline

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

◆ setTotalSize()

void Arcane::MessagePassing::OneStat::setTotalSize ( Int64 v )

inline

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

◆ setTotalTime()

void Arcane::MessagePassing::OneStat::setTotalTime ( double v )

inline

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

◆ totalSize()

Int64 Arcane::MessagePassing::OneStat::totalSize ( ) const

inline

Total size of messages sent.

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

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

Here is the caller graph for this function:

◆ totalTime()

double Arcane::MessagePassing::OneStat::totalTime ( ) const

inline

Total elapsed time.

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

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_cumulative_nb_msg

Int64 Arcane::MessagePassing::OneStat::m_cumulative_nb_msg = 0

private

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

◆ m_cumulative_total_size

Int64 Arcane::MessagePassing::OneStat::m_cumulative_total_size = 0

private

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

◆ m_cumulative_total_time

double Arcane::MessagePassing::OneStat::m_cumulative_total_time = 0.0

private

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

◆ m_name

String Arcane::MessagePassing::OneStat::m_name

private

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

◆ m_nb_msg

Int64 Arcane::MessagePassing::OneStat::m_nb_msg = 0

private

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

◆ m_total_size

Int64 Arcane::MessagePassing::OneStat::m_total_size = 0

private

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

◆ m_total_time

double Arcane::MessagePassing::OneStat::m_total_time = 0.0

private

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OneStat() [1/2]

◆ OneStat() [2/2]

Member Function Documentation

◆ addMessage()

◆ cumulativeNbMessage()

◆ cumulativeTotalSize()

◆ cumulativeTotalTime()

◆ name()

◆ nbMessage()

◆ print()

◆ resetCurrentStat()

◆ setCumulativeNbMessage()

◆ setCumulativeTotalSize()

◆ setCumulativeTotalTime()

◆ setNbMessage()

◆ setTotalSize()

◆ setTotalTime()

◆ totalSize()

◆ totalTime()

Member Data Documentation

◆ m_cumulative_nb_msg

◆ m_cumulative_total_size

◆ m_cumulative_total_time

◆ m_name

◆ m_nb_msg

◆ m_total_size

◆ m_total_time