Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
IVariableFilter.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/* IVariableFilter.h (C) 2000-2006 */
9/* */
10/* Fonctor d'un filtre applicable sur des variables. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_IVARIABLEFILTER_H
13#define ARCANE_IVARIABLEFILTER_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/ArcaneGlobal.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22ARCANE_BEGIN_NAMESPACE
23
24/*---------------------------------------------------------------------------*/
25/*---------------------------------------------------------------------------*/
26
27/*---------------------------------------------------------------------------*/
28/*---------------------------------------------------------------------------*/
29/*!
30 * \ingroup Variable
31 * \brief Fonctor d'un filtre applicable sur des variables.
32 *
33 * Ce fonctor s'utilise lorsqu'on itère sur des variables. La méthode
34 * applyFilter() est appelée pour chaque variable et indique si la
35 * variable testée doit ou non être filtrée.
36 */
37class IVariableFilter
38{
39 public:
40
41 virtual ~IVariableFilter() {} //!< Libère les ressources
42
43 /*!
44 * \brief Applique le filtre sur la variable \a var
45 * \retval true si la variable remplit les conditions du filtre
46 * \retval false sinon.
47 */
48 virtual bool applyFilter(IVariable& var) =0;
49};
50
51/*---------------------------------------------------------------------------*/
52/*---------------------------------------------------------------------------*/
53
54ARCANE_END_NAMESPACE
55
56/*---------------------------------------------------------------------------*/
57/*---------------------------------------------------------------------------*/
58
59#endif
60
ArcaneGlobal.h
Fichier de configuration d'Arcane.
Arcane::IVariableFilter
Fonctor d'un filtre applicable sur des variables.
Definition IVariableFilter.h:38
Arcane::IVariableFilter::~IVariableFilter
virtual ~IVariableFilter()
Libère les ressources.
Definition IVariableFilter.h:41
Arcane::IVariableFilter::applyFilter
virtual bool applyFilter(IVariable &var)=0
Applique le filtre sur la variable var.