Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
ITimeHistoryCurveWriter.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/* ITimeHistoryCurveWriter.h (C) 2000-2025 */
9/* */
10/* Interface of a historical curve writer. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ITIMEHISTORYCURVEWRITER_H
13#define ARCANE_CORE_ITIMEHISTORYCURVEWRITER_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28/*!
29 * \ingroup StandardService
30 * \brief Interface of a curve writer.
31 *
32 * \deprecated Use the ITimeHistoryCurveWriter2 interface instead.
33 */
35{
36 public:
37
38 virtual ~ITimeHistoryCurveWriter() = default; //!< Frees resources
39
40 public:
41
42 virtual void build() = 0;
43
44 /*!
45 * \brief Writes the curve named \a name.
46 *
47 * The values are in the \a values array. \a times and \a iterations
48 * contain respectively the time and the iteration number for
49 * each value.
50 * \a path contains the directory where the curves will be written
51 */
52 virtual void writeCurve(const IDirectory& path,
53 const String& name,
54 Int32ConstArrayView iterations,
56 RealConstArrayView values,
57 Integer sub_size) = 0;
58
59 //! Writer name
60 virtual String name() const = 0;
61};
62
63/*---------------------------------------------------------------------------*/
64/*---------------------------------------------------------------------------*/
65
66} // namespace Arcane
67
68/*---------------------------------------------------------------------------*/
69/*---------------------------------------------------------------------------*/
70
71#endif
Declarations of types used in Arcane.
Interface of a class managing a directory.
Definition IDirectory.h:32
virtual String name() const =0
Writer name.
virtual ~ITimeHistoryCurveWriter()=default
Frees resources.
virtual void writeCurve(const IDirectory &path, const String &name, Int32ConstArrayView iterations, RealConstArrayView times, RealConstArrayView values, Integer sub_size)=0
Writes the curve named name.
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Int32 Integer
Type representing an integer.
ConstArrayView< Int32 > Int32ConstArrayView
C equivalent of a 1D array of 32-bit integers.
Definition UtilsTypes.h:482
ConstArrayView< Real > RealConstArrayView
C equivalent of a 1D array of reals.
Definition UtilsTypes.h:488