Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::VariableComparerArgs Class Reference

Arguments for VariableComparer methods. More...

#include <arcane/core/VariableComparer.h>

Collaboration diagram for Arcane::VariableComparerArgs:

Public Member Functions

void setMaxPrint (Int32 v)
 Sets the number of errors to display in the listing.
Int32 maxPrint () const
void setCompareGhost (bool v)
 Indicates on which entities the comparison is performed.
bool isCompareGhost () const
void setDataReader (IDataReader *v)
IDataReaderdataReader () const
void setCompareMode (eVariableComparerCompareMode v)
eVariableComparerCompareMode compareMode () const
void setComputeDifferenceMethod (eVariableComparerComputeDifferenceMethod v)
eVariableComparerComputeDifferenceMethod computeDifferenceMethod () const

Private Attributes

Int32 m_max_print = 0
bool m_is_compare_ghost = false
IDataReaderm_data_reader = nullptr
eVariableComparerCompareMode m_compare_mode = eVariableComparerCompareMode::Same
eVariableComparerComputeDifferenceMethod m_compute_difference_method = eVariableComparerComputeDifferenceMethod::Relative

Detailed Description

Arguments for VariableComparer methods.

Definition at line 60 of file VariableComparer.h.

Member Function Documentation

◆ compareMode()

eVariableComparerCompareMode Arcane::VariableComparerArgs::compareMode ( ) const
inline

Definition at line 89 of file VariableComparer.h.

◆ computeDifferenceMethod()

eVariableComparerComputeDifferenceMethod Arcane::VariableComparerArgs::computeDifferenceMethod ( ) const
inline

Definition at line 92 of file VariableComparer.h.

◆ dataReader()

IDataReader * Arcane::VariableComparerArgs::dataReader ( ) const
inline

Definition at line 86 of file VariableComparer.h.

◆ isCompareGhost()

bool Arcane::VariableComparerArgs::isCompareGhost ( ) const
inline

Definition at line 83 of file VariableComparer.h.

◆ maxPrint()

Int32 Arcane::VariableComparerArgs::maxPrint ( ) const
inline

Definition at line 71 of file VariableComparer.h.

◆ setCompareGhost()

void Arcane::VariableComparerArgs::setCompareGhost ( bool v)
inline

Indicates on which entities the comparison is performed.

If v is true, compares the values both on the proper entities and the ghost entities. Otherwise, it only performs the comparison on the proper entities.

This parameter is only used if compareMode() equals eCompareMode::Same.

Definition at line 82 of file VariableComparer.h.

Referenced by Arcane::Variable::checkIfSame(), and Arcane::Variable::checkIfSync().

Here is the caller graph for this function:

◆ setCompareMode()

void Arcane::VariableComparerArgs::setCompareMode ( eVariableComparerCompareMode v)
inline

Definition at line 88 of file VariableComparer.h.

◆ setComputeDifferenceMethod()

void Arcane::VariableComparerArgs::setComputeDifferenceMethod ( eVariableComparerComputeDifferenceMethod v)
inline

Definition at line 91 of file VariableComparer.h.

◆ setDataReader()

void Arcane::VariableComparerArgs::setDataReader ( IDataReader * v)
inline

Definition at line 85 of file VariableComparer.h.

◆ setMaxPrint()

void Arcane::VariableComparerArgs::setMaxPrint ( Int32 v)
inline

Sets the number of errors to display in the listing.

If 0, no elements are displayed. If positive, displays at most v elements. If negative, all elements are displayed.

Definition at line 70 of file VariableComparer.h.

Referenced by Arcane::Variable::checkIfSame(), Arcane::Variable::checkIfSameOnAllReplica(), and Arcane::Variable::checkIfSync().

Here is the caller graph for this function:

Member Data Documentation

◆ m_compare_mode

eVariableComparerCompareMode Arcane::VariableComparerArgs::m_compare_mode = eVariableComparerCompareMode::Same
private

Definition at line 99 of file VariableComparer.h.

◆ m_compute_difference_method

eVariableComparerComputeDifferenceMethod Arcane::VariableComparerArgs::m_compute_difference_method = eVariableComparerComputeDifferenceMethod::Relative
private

Definition at line 100 of file VariableComparer.h.

◆ m_data_reader

IDataReader* Arcane::VariableComparerArgs::m_data_reader = nullptr
private

Definition at line 98 of file VariableComparer.h.

◆ m_is_compare_ghost

bool Arcane::VariableComparerArgs::m_is_compare_ghost = false
private

Definition at line 97 of file VariableComparer.h.

◆ m_max_print

Int32 Arcane::VariableComparerArgs::m_max_print = 0
private

Definition at line 96 of file VariableComparer.h.


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