Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
ISimpleTableComparator.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2022 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ISimpleTableComparator.h (C) 2000-2022 */
9/* */
10/* Interface pour les services permettant de comparer un ISimpleTableOutput */
11/* et un fichier de référence. */
12/*---------------------------------------------------------------------------*/
13/*---------------------------------------------------------------------------*/
14
15#ifndef ARCANE_ISIMPLETABLECOMPARATOR_H
16#define ARCANE_ISIMPLETABLECOMPARATOR_H
17
18/*---------------------------------------------------------------------------*/
19/*---------------------------------------------------------------------------*/
20
21#include "arcane/ISimpleTableOutput.h"
22
23#include "arcane/ItemTypes.h"
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28namespace Arcane
29{
30
31/*---------------------------------------------------------------------------*/
32/*---------------------------------------------------------------------------*/
33
50class ARCANE_CORE_EXPORT ISimpleTableComparator
51{
52 public:
53 virtual ~ISimpleTableComparator() = default;
54
55 public:
67 virtual void init(ISimpleTableOutput* simple_table_output_ptr) = 0;
68
74 virtual void clear() = 0;
75
81 virtual void print(Integer rank = 0) = 0;
82
93 virtual void editRootDirectory(const Directory& root_directory) = 0;
94
109 virtual bool writeReferenceFile(Integer rank = -1) = 0;
120 virtual bool readReferenceFile(Integer rank = -1) = 0;
121
129 virtual bool isReferenceExist(Integer rank = -1) = 0;
130
140 virtual bool compareWithReference(Integer rank = -1, bool compare_dimension_too = false) = 0;
141
157 virtual bool compareElemWithReference(const String& column_name, const String& row_name, Integer rank = -1) = 0;
158
172 virtual bool compareElemWithReference(Real elem, const String& column_name, const String& row_name, Integer rank = -1) = 0;
173
182 virtual bool addColumnForComparing(const String& column_name) = 0;
191 virtual bool addRowForComparing(const String& row_name) = 0;
192
202 virtual void isAnArrayExclusiveColumns(bool is_exclusive) = 0;
203
213 virtual void isAnArrayExclusiveRows(bool is_exclusive) = 0;
214
221 virtual void editRegexColumns(const String& regex_column) = 0;
228 virtual void editRegexRows(const String& regex_row) = 0;
229
236 virtual void isARegexExclusiveColumns(bool is_exclusive) = 0;
243 virtual void isARegexExclusiveRows(bool is_exclusive) = 0;
244
258 virtual bool addEpsilonColumn(const String& column_name, Real epsilon) = 0;
259
273 virtual bool addEpsilonRow(const String& row_name, Real epsilon) = 0;
274};
275
276/*---------------------------------------------------------------------------*/
277/*---------------------------------------------------------------------------*/
278
279} // End namespace Arcane
280
281/*---------------------------------------------------------------------------*/
282/*---------------------------------------------------------------------------*/
283
284#endif
285
286/*---------------------------------------------------------------------------*/
287/*---------------------------------------------------------------------------*/
Classe gérant un répertoire.
Definition Directory.h:33
Interface de classe représentant un comparateur de tableaux. À utiliser avec un service implémentant ...
virtual bool readReferenceFile(Integer rank=-1)=0
Méthode permettant de lire les fichiers de références.
virtual void editRegexRows(const String &regex_row)=0
Méthode permettant d'ajouter une expression régulière permettant de déterminer les lignes à comparer.
virtual void isAnArrayExclusiveRows(bool is_exclusive)=0
Méthode permettant de définir si le tableau de lignes représente les lignes à inclure dans la compara...
virtual void editRootDirectory(const Directory &root_directory)=0
Méthode permettant de modifier le répertoire racine. Cela permet d'écrire ou de rechercher des fichie...
virtual bool compareWithReference(Integer rank=-1, bool compare_dimension_too=false)=0
Méthode permettant de comparer l'objet de type ISimpleTableOutput aux fichiers de réferences.
virtual bool addEpsilonColumn(const String &column_name, Real epsilon)=0
Méthode permettant de définir un epsilon pour une colonne donnée. Cet epsilon doit être positif pour ...
virtual void isARegexExclusiveColumns(bool is_exclusive)=0
Méthode permettant de demander à ce que l'expression régulière exclut des colonnes au lieu d'en inclu...
virtual void clear()=0
Méthode permettant d'effacer les données lues par readReferenceFile().
virtual bool addColumnForComparing(const String &column_name)=0
Méthode permettant d'ajouter une colonne dans la liste des colonnes à comparer.
virtual void editRegexColumns(const String &regex_column)=0
Méthode permettant d'ajouter une expression régulière permettant de déterminer les colonnes à compare...
virtual bool isReferenceExist(Integer rank=-1)=0
Méthode permettant de savoir si les fichiers de réferences existent.
virtual bool writeReferenceFile(Integer rank=-1)=0
Méthode permettant d'écrire les fichiers de référence.
virtual void isAnArrayExclusiveColumns(bool is_exclusive)=0
Méthode permettant de définir si le tableau de colonnes représente les colonnes à inclure dans la com...
virtual bool compareElemWithReference(Real elem, const String &column_name, const String &row_name, Integer rank=-1)=0
Méthode permettant de comparer une valeur avec une valeur du tableau de référence....
virtual bool addRowForComparing(const String &row_name)=0
Méthode permettant d'ajouter une ligne dans la liste des lignes à comparer.
virtual void isARegexExclusiveRows(bool is_exclusive)=0
Méthode permettant de demander à ce que l'expression régulière exclut des lignes au lieu d'en inclure...
virtual void print(Integer rank=0)=0
Méthode permettant d'afficher le tableau lu.
virtual void init(ISimpleTableOutput *simple_table_output_ptr)=0
Méthode permettant d'initialiser le service.
virtual bool compareElemWithReference(const String &column_name, const String &row_name, Integer rank=-1)=0
Méthode permettant de comparer uniquement un élement. Les deux SimpleTableInternal sont représentés p...
virtual bool addEpsilonRow(const String &row_name, Real epsilon)=0
Méthode permettant de définir un epsilon pour une ligne donnée. Cet epsilon doit être positif pour êt...
Interface représentant une sortie de tableau simple.
Chaîne de caractères unicode.
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
Int32 Integer
Type représentant un entier.
double Real
Type représentant un réel.