Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
CaseTableParams.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/* CaseTableParams.h (C) 2000-2025 */
9/* */
10/* Parameters for a data set walk table. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_CASETABLEPARAMS_H
13#define ARCANE_CORE_CASETABLEPARAMS_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/CaseTable.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
28/*!
29 * \internal
30 * \brief Parameter of a function.
31 */
32class CaseTableParams
33{
34 public:
35
36 class Impl;
37
38 public:
39
40 CaseTableParams(CaseTable::eParamType v);
41 virtual ~CaseTableParams();
42
43 public:
44
45 bool null() const;
46 Integer nbElement() const;
47 void value(Integer id, Real& v) const;
48 void value(Integer id, Integer& v) const;
49 CaseTable::eError appendValue(const String& value);
50 CaseTable::eError setValue(Integer id, const String& value);
51 CaseTable::eError setValue(Integer id, Real v);
52 CaseTable::eError setValue(Integer id, Integer v);
53 void removeValue(Integer id);
54 void toString(Integer id, String& str) const;
55 void setType(ICaseFunction::eParamType new_type);
56
57 void getRange(Real v, Int32& begin, Int32& end) const;
58 void getRange(Integer v, Int32& begin, Int32& end) const;
59
60 private:
61
62 Impl* m_p;
63
64 private:
65
66 template <typename T> inline void _getRange(T v, Int32& begin, Int32& end) const;
67};
68
69/*---------------------------------------------------------------------------*/
70/*---------------------------------------------------------------------------*/
71
72} // namespace Arcane
73
74/*---------------------------------------------------------------------------*/
75/*---------------------------------------------------------------------------*/
76
77#endif
Arcane::CaseTable::eError
eError
Types of errors returned by the class.
Definition CaseTable.h:48
Arcane::ICaseFunction::eParamType
eParamType
Type of a function parameter.
Definition ICaseFunction.h:55
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition AbstractCaseDocumentVisitor.cc:21
Arcane::Integer
Int32 Integer
Type representing an integer.
Definition ArccoreGlobal.h:293
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