Arcane::ForLoopRunInfo Class Reference

Loop execution information. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/base/arccore/base/ForLoopRunInfo.h>

Collaboration diagram for Arcane::ForLoopRunInfo:

Public Types
using	ThatClass = ForLoopRunInfo

Public Member Functions
	ForLoopRunInfo (const ParallelLoopOptions &options)
	ForLoopRunInfo (const ParallelLoopOptions &options, const ForLoopTraceInfo &trace_info)
	ForLoopRunInfo (const ForLoopTraceInfo &trace_info)
std::optional< ParallelLoopOptions >	options () const
ThatClass &	addOptions (const ParallelLoopOptions &v)
const ForLoopTraceInfo &	traceInfo () const
ThatClass &	addTraceInfo (const ForLoopTraceInfo &v)
void	setExecStat (ForLoopOneExecStat *v)
	Sets the pointer holding the execution statistics.
ForLoopOneExecStat *	execStat () const
	Pointer containing execution statistics.

Protected Attributes
std::optional< ParallelLoopOptions >	m_options
ForLoopTraceInfo	m_trace_info
ForLoopOneExecStat *	m_exec_stat = nullptr

Detailed Description

Loop execution information.

This class allows managing execution information common to all loops.

Definition at line 37 of file ForLoopRunInfo.h.

Member Typedef Documentation

ThatClass

using Arcane::ForLoopRunInfo::ThatClass = ForLoopRunInfo

Definition at line 41 of file ForLoopRunInfo.h.

Constructor & Destructor Documentation

ForLoopRunInfo() [1/3]

Arcane::ForLoopRunInfo::ForLoopRunInfo ( const ParallelLoopOptions & options )

inlineexplicit

Definition at line 46 of file ForLoopRunInfo.h.

ForLoopRunInfo() [2/3]

Arcane::ForLoopRunInfo::ForLoopRunInfo ( const ParallelLoopOptions & options, const ForLoopTraceInfo & trace_info )

inline

Definition at line 49 of file ForLoopRunInfo.h.

ForLoopRunInfo() [3/3]

Arcane::ForLoopRunInfo::ForLoopRunInfo ( const ForLoopTraceInfo & trace_info )

inlineexplicit

Definition at line 53 of file ForLoopRunInfo.h.

Member Function Documentation

addOptions()

ThatClass & Arcane::ForLoopRunInfo::addOptions ( const ParallelLoopOptions & v )

inline

Definition at line 60 of file ForLoopRunInfo.h.

addTraceInfo()

ThatClass & Arcane::ForLoopRunInfo::addTraceInfo ( const ForLoopTraceInfo & v )

inline

Definition at line 66 of file ForLoopRunInfo.h.

execStat()

ForLoopOneExecStat * Arcane::ForLoopRunInfo::execStat ( ) const

inline

Pointer containing execution statistics.

Definition at line 80 of file ForLoopRunInfo.h.

options()

std::optional< ParallelLoopOptions > Arcane::ForLoopRunInfo::options ( ) const

inline

Definition at line 59 of file ForLoopRunInfo.h.

setExecStat()

void Arcane::ForLoopRunInfo::setExecStat ( ForLoopOneExecStat * v )

inline

Sets the pointer holding the execution statistics.

This pointer v must remain valid throughout the loop execution.

Definition at line 77 of file ForLoopRunInfo.h.

traceInfo()

const ForLoopTraceInfo & Arcane::ForLoopRunInfo::traceInfo ( ) const

inline

Definition at line 65 of file ForLoopRunInfo.h.

Member Data Documentation

m_exec_stat

ForLoopOneExecStat* Arcane::ForLoopRunInfo::m_exec_stat = nullptr

protected

Definition at line 86 of file ForLoopRunInfo.h.

m_options

std::optional<ParallelLoopOptions> Arcane::ForLoopRunInfo::m_options

protected

Definition at line 84 of file ForLoopRunInfo.h.

m_trace_info

ForLoopTraceInfo Arcane::ForLoopRunInfo::m_trace_info

protected

Definition at line 85 of file ForLoopRunInfo.h.

---

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

• ForLoopRunInfo.h