Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
VariableDataInfo.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/* VariableDataInfo.h (C) 2000-2024 */
9/* */
10/* Variable data information. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_STD_INTERNAL_VARIABLEDATAINFO_H
13#define ARCANE_STD_INTERNAL_VARIABLEDATAINFO_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/String.h"
18#include "arcane/utils/ArrayShape.h"
19
20#include "arcane/core/ArcaneTypes.h"
21#include "arcane/core/XmlNode.h"
22
23#include <map>
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28namespace Arcane::impl
29{
30
31/*---------------------------------------------------------------------------*/
32/*---------------------------------------------------------------------------*/
33
37class VariableDataInfo
38{
39 friend class VariableDataInfoMap;
40
41 private:
42
43 static constexpr const char* V_NB_DIMENSION = "nb-dimension";
44 static constexpr const char* V_DIM1_SIZE = "dim1-size";
45 static constexpr const char* V_DIM2_SIZE = "dim2-size";
46 static constexpr const char* V_NB_ELEMENT = "nb-element";
47 static constexpr const char* V_NB_BASE_ELEMENT = "nb-base-element";
48 static constexpr const char* V_DIMENSION_ARRAY_SIZE = "dimension-array-size";
49 static constexpr const char* V_IS_MULTI_SIZE = "is-multi-size";
50 static constexpr const char* V_BASE_DATA_TYPE = "base-data-type";
51 static constexpr const char* V_MEMORY_SIZE = "memory-size";
52 static constexpr const char* V_FILE_OFFSET = "file-offset";
53 static constexpr const char* V_SHAPE_SIZE = "shape-size";
54 static constexpr const char* V_SHAPE = "shape";
55 static constexpr const char* V_COMPARISON_HASH = "comparison-hash";
56
57 private:
58
59 VariableDataInfo(const String& full_name, const ISerializedData* sdata);
60 VariableDataInfo(const String& full_name, const XmlNode& element);
61 VariableDataInfo(const String& full_name, const JSONValue& jvalue);
62
63 public:
64
65 const String& fullName() const { return m_full_name; }
66 Integer nbDimension() const { return m_nb_dimension; }
67 Int64 dim1Size() const { return m_dim1_size; }
68 Int64 dim2Size() const { return m_dim2_size; }
69 Int64 nbElement() const { return m_nb_element; }
70 Int64 nbBaseElement() const { return m_nb_base_element; }
71 Integer dimensionArraySize() const { return m_dimension_array_size; }
72 bool isMultiSize() const { return m_is_multi_size; }
73 eDataType baseDataType() const { return m_base_data_type; }
74 Int64 memorySize() const { return m_memory_size; }
75 const ArrayShape& shape() const { return m_shape; }
76 void setFileOffset(Int64 v) { m_file_offset = v; }
77 Int64 fileOffset() const { return m_file_offset; }
78 void setComparisonHashValue(const String& v) { m_comparison_hash_value = v; }
79 const String& comparisonHashValue() const { return m_comparison_hash_value; }
80
81 public:
82
83 void write(XmlNode element, JSONWriter& writer) const;
84
85 private:
86
87 String m_full_name;
88 Integer m_nb_dimension = 0;
89 Int64 m_dim1_size = 0;
90 Int64 m_dim2_size = 0;
91 Int64 m_nb_element = 0;
92 Int64 m_nb_base_element = 0;
93 Integer m_dimension_array_size = 0;
94 bool m_is_multi_size = false;
95 eDataType m_base_data_type = DT_Unknown;
96 Int64 m_memory_size = 0;
97 Int64 m_file_offset = 0;
98 ArrayShape m_shape;
99 String m_comparison_hash_value;
100
101 private:
102
103 void _write(XmlNode element) const;
104 void _write(JSONWriter& writer) const;
105};
106
107/*---------------------------------------------------------------------------*/
108/*---------------------------------------------------------------------------*/
109
113class VariableDataInfoMap
114{
115 using MapType = std::map<String, Ref<VariableDataInfo>>;
116
117 public:
118
119 using const_iterator = MapType::const_iterator;
120
121 public:
122
124 Ref<VariableDataInfo> add(const String& full_name, const ISerializedData* sdata);
126 Ref<VariableDataInfo> add(const String& full_name, const XmlNode& node);
128 Ref<VariableDataInfo> add(const String& full_name, const JSONValue& jvalue);
129
131 Ref<VariableDataInfo> find(const String& full_name) const;
132
134 const_iterator begin() const { return m_data_info_map.begin(); }
135 const_iterator end() const { return m_data_info_map.end(); }
137
138 private:
139
140 MapType m_data_info_map;
141
142 private:
143
144 Ref<VariableDataInfo> _add(VariableDataInfo* v);
145};
146
147/*---------------------------------------------------------------------------*/
148/*---------------------------------------------------------------------------*/
149
150} // namespace Arcane::impl
151
152/*---------------------------------------------------------------------------*/
153/*---------------------------------------------------------------------------*/
154
155#endif
ArcaneTypes.h
Declarations of Arcane's general types.
Arcane::ArrayShape
Array shape.
Definition ArrayShape.h:42
Arcane::ISerializedData
Interface of a serialized data.
Definition ISerializedData.h:63
Arcane::Ref
Reference to an instance.
Definition arccore/src/base/arccore/base/Ref.h:325
Arcane::XmlNode
Node of a DOM tree.
Definition XmlNode.h:51
Arcane::impl::VariableDataInfoMap
Associative map of variable data.
Definition VariableDataInfo.h:114
Arcane::impl::VariableDataInfoMap::add
Ref< VariableDataInfo > add(const String &full_name, const ISerializedData *sdata)
Adds a variable.
Definition VariableDataInfo.cc:269
Arcane::impl::VariableDataInfoMap::find
Ref< VariableDataInfo > find(const String &full_name) const
Returns the variable named full_name. Returns null if not found.
Definition VariableDataInfo.cc:296
Arcane::impl::VariableDataInfo
Variable data information.
Definition VariableDataInfo.h:38
Arcane::Int64
std::int64_t Int64
Signed integer type of 64 bits.
Definition ArccoreGlobal.h:235
Arcane::Integer
Int32 Integer
Type representing an integer.
Definition ArccoreGlobal.h:293
Arcane::eDataType
eDataType
Data type.
Definition DataTypes.h:41
Arcane::DT_Unknown
@ DT_Unknown
Unknown or uninitialized data type.
Definition DataTypes.h:58