Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
IUserDataList.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 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 of a list that manages user data. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_UTILS_IUSERDATALIST_H
13#define ARCANE_UTILS_IUSERDATALIST_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/ArcaneGlobal.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28class IUserData;
29
30/*---------------------------------------------------------------------------*/
31/*---------------------------------------------------------------------------*/
32
37class ARCANE_UTILS_EXPORT IUserDataList
38{
39 public:
40
42 virtual ~IUserDataList() {}
43
44 public:
45
52 virtual void setData(const String& name, IUserData* ud) = 0;
53
61 virtual IUserData* data(const String& name, bool allow_null = false) const = 0;
62
69 virtual void removeData(const String& name, bool allow_null = false) = 0;
70
76 virtual void clear() = 0;
77};
78
79/*---------------------------------------------------------------------------*/
80/*---------------------------------------------------------------------------*/
81
82} // namespace Arcane
83
84/*---------------------------------------------------------------------------*/
85/*---------------------------------------------------------------------------*/
86
87#endif
ArcaneGlobal.h
Arcane configuration file.
Arcane::IUserDataList
Interface of a list that manages user data.
Definition IUserDataList.h:38
Arcane::IUserDataList::setData
virtual void setData(const String &name, IUserData *ud)=0
Sets the user data associated with the name name.
Arcane::IUserDataList::~IUserDataList
virtual ~IUserDataList()
Frees resources.
Definition IUserDataList.h:42
Arcane::IUserDataList::removeData
virtual void removeData(const String &name, bool allow_null=false)=0
Removes the data associated with the name name.
Arcane::IUserDataList::data
virtual IUserData * data(const String &name, bool allow_null=false) const =0
Data associated with name.
Arcane::IUserDataList::clear
virtual void clear()=0
Removes all user data.
Arcane::IUserData
Interface for user data attached to another object.
Definition IUserData.h:33
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition arcane/src/arcane/accelerator/AcceleratorGlobal.h:37