Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
ITimeHistoryAdder.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/* ITimeHistoryAdder.h (C) 2000-2024 */
9/* */
10/* Class interface allowing the addition of a value history linked to */
11/* a mesh. */
12/*---------------------------------------------------------------------------*/
13/*---------------------------------------------------------------------------*/
14
15#ifndef ARCANE_ITIMEHISTORYMNGADDER_H
16#define ARCANE_ITIMEHISTORYMNGADDER_H
17
18/*---------------------------------------------------------------------------*/
19/*---------------------------------------------------------------------------*/
20
21#include "arcane/utils/UtilsTypes.h"
22#include "arcane/utils/FatalErrorException.h"
23#include "arcane/core/ITimeHistoryMng.h"
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28namespace Arcane
29{
30
31/*---------------------------------------------------------------------------*/
32/*---------------------------------------------------------------------------*/
33
34/*!
35 * \brief Class interface allowing the addition of one or more values
36 * to a value history.
37 */
38class ITimeHistoryAdder
39{
40 public:
41
42 virtual ~ITimeHistoryAdder() = default; //!< Frees resources
43
44 public:
45
46 /*!
47 * \brief Method allowing the addition of a value to a history.
48 *
49 * \param thpi The parameters of the value.
50 * \param value The value to add.
51 */
52 virtual void addValue(const TimeHistoryAddValueArg& thp, Real value) = 0;
53
54 /*!
55 * \brief Method allowing the addition of a value to a history.
56 *
57 * \param thpi The parameters of the value.
58 * \param value The value to add.
59 */
60 virtual void addValue(const TimeHistoryAddValueArg& thp, Int32 value) = 0;
61
62 /*!
63 * \brief Method allowing the addition of a value to a history.
64 *
65 * \param thpi The parameters of the value.
66 * \param value The value to add.
67 */
68 virtual void addValue(const TimeHistoryAddValueArg& thp, Int64 value) = 0;
69
70 /*!
71 * \brief Method allowing the addition of values to a history.
72 *
73 * \param thpi The parameters of the values.
74 * \param value The values to add.
75 */
76 virtual void addValue(const TimeHistoryAddValueArg& thp, RealConstArrayView values) = 0;
77
78 /*!
79 * \brief Method allowing the addition of values to a history.
80 *
81 * \param thpi The parameters of the values.
82 * \param value The values to add.
83 */
84 virtual void addValue(const TimeHistoryAddValueArg& thp, Int32ConstArrayView values) = 0;
85
86 /*!
87 * \brief Method allowing the addition of values to a history.
88 *
89 * \param thpi The parameters of the values.
90 * \param value The values to add.
91 */
92 virtual void addValue(const TimeHistoryAddValueArg& thp, Int64ConstArrayView values) = 0;
93};
94
95/*---------------------------------------------------------------------------*/
96/*---------------------------------------------------------------------------*/
97
98} // namespace Arcane
99
100/*---------------------------------------------------------------------------*/
101/*---------------------------------------------------------------------------*/
102
103#endif
UtilsTypes.h
Declarations of types used in Arcane.
Arcane::ITimeHistoryAdder
Class interface allowing the addition of one or more values to a value history.
Definition ITimeHistoryAdder.h:39
Arcane::ITimeHistoryAdder::~ITimeHistoryAdder
virtual ~ITimeHistoryAdder()=default
Frees resources.
Arcane::ITimeHistoryAdder::addValue
virtual void addValue(const TimeHistoryAddValueArg &thp, Int64 value)=0
Method allowing the addition of a value to a history.
Arcane::ITimeHistoryAdder::addValue
virtual void addValue(const TimeHistoryAddValueArg &thp, Int32ConstArrayView values)=0
Method allowing the addition of values to a history.
Arcane::ITimeHistoryAdder::addValue
virtual void addValue(const TimeHistoryAddValueArg &thp, RealConstArrayView values)=0
Method allowing the addition of values to a history.
Arcane::ITimeHistoryAdder::addValue
virtual void addValue(const TimeHistoryAddValueArg &thp, Int32 value)=0
Method allowing the addition of a value to a history.
Arcane::ITimeHistoryAdder::addValue
virtual void addValue(const TimeHistoryAddValueArg &thp, Real value)=0
Method allowing the addition of a value to a history.
Arcane::ITimeHistoryAdder::addValue
virtual void addValue(const TimeHistoryAddValueArg &thp, Int64ConstArrayView values)=0
Method allowing the addition of values to a history.
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition AbstractCaseDocumentVisitor.cc:21
Arcane::Int64
std::int64_t Int64
Signed integer type of 64 bits.
Definition ArccoreGlobal.h:235
Arcane::Int32ConstArrayView
ConstArrayView< Int32 > Int32ConstArrayView
C equivalent of a 1D array of 32-bit integers.
Definition UtilsTypes.h:482
Arcane::Int64ConstArrayView
ConstArrayView< Int64 > Int64ConstArrayView
C equivalent of a 1D array of 64-bit integers.
Definition UtilsTypes.h:480
Arcane::Real
double Real
Type representing a real number.
Definition ArccoreGlobal.h:275
Arcane::Int32
std::int32_t Int32
Signed integer type of 32 bits.
Definition ArccoreGlobal.h:233
Arcane::RealConstArrayView
ConstArrayView< Real > RealConstArrayView
C equivalent of a 1D array of reals.
Definition UtilsTypes.h:488