Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
IUserDataList.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/* IUserDataList.h (C) 2000-2018 */
9/* */
10/* Interface d'une liste qui gère des données utilisateurs. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_UTILS_IUSERDATALIST_H
13#define ARCANE_UTILS_IUSERDATALIST_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22ARCANE_BEGIN_NAMESPACE
23
24/*---------------------------------------------------------------------------*/
25/*---------------------------------------------------------------------------*/
26
27class IUserData;
28
29/*---------------------------------------------------------------------------*/
30/*---------------------------------------------------------------------------*/
31/*!
32 * \brief Interface d'une liste qui gère des données utilisateurs.
33 * \ingroup Core
34 */
35class ARCANE_UTILS_EXPORT IUserDataList
36{
37 public:
38
39 //! Libère les ressources
40 virtual ~IUserDataList(){}
41
42 public:
43
44 /*!
45 * \brief Positionne le user-data associé au nom \a name.
46 *
47 * Aucune donnée ne doit déjà être associée à \a name, sinon une
48 * exception est levée.
49 */
50 virtual void setData(const String& name,IUserData* ud) =0;
51 /*!
52 * \brief Donnée associée à \a name.
53 *
54 * Une exception est levée si \a allow_null vaut \a false et qu'aucune
55 * donnée n'est associée à \a name. Si \a allow_null est \a vrai et
56 * qu'aucune donnée n'est associée, retourne un pointeur nul.
57 */
58 virtual IUserData* data(const String& name,bool allow_null=false) const =0;
59 /*!
60 * \brief Supprime la donnée associèe au nom \a name.
61 *
62 * Une exception est levée si \a allow_null vaut \a false et qu'aucune
63 * donnée n'est associée à \a name.
64 */
65 virtual void removeData(const String& name,bool allow_null=false) =0;
66
67 /*!
68 * \brief Supprime toutes les données utilisateurs.
69 *
70 * Cela revient à appeler removeData() pour toutes les données utilisateurs.
71 */
72 virtual void clear() =0;
73};
74
75/*---------------------------------------------------------------------------*/
76/*---------------------------------------------------------------------------*/
77
78ARCANE_END_NAMESPACE
79
80/*---------------------------------------------------------------------------*/
81/*---------------------------------------------------------------------------*/
82
83#endif
84
Fichier de configuration d'Arcane.
Interface d'une liste qui gère des données utilisateurs.
virtual void setData(const String &name, IUserData *ud)=0
Positionne le user-data associé au nom name.
virtual ~IUserDataList()
Libère les ressources.
virtual void removeData(const String &name, bool allow_null=false)=0
Supprime la donnée associèe au nom name.
virtual IUserData * data(const String &name, bool allow_null=false) const =0
Donnée associée à name.
virtual void clear()=0
Supprime toutes les données utilisateurs.
Interface pour une donnée utilisateur attachée à un autre objet.
Definition IUserData.h:31
Chaîne de caractères unicode.