Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::MessagePassing::OneStat Class Reference

Statistic on a message. More...

#include <arccore/message_passing/IStat.h>

Public Member Functions

 OneStat (const String &name)
 OneStat (const String &name, Int64 msg_size, double elapsed_time)
const Stringname () 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).

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

◆ OneStat() [2/2]

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

Member Function Documentation

◆ addMessage()

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

◆ 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().

◆ 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().

◆ 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().

◆ 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().

◆ 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().

◆ 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

◆ setCumulativeTotalSize()

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

◆ setCumulativeTotalTime()

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

◆ setNbMessage()

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

◆ setTotalSize()

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

◆ setTotalTime()

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

◆ 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().

◆ 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().


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