Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
CaseOptionBuildInfo.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/* CaseOptionBuildInfo.h (C) 2000-2025 */
9/* */
10/* Information for building a dataset option */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_CASEOPTIONBUILDINFO_H
13#define ARCANE_CORE_CASEOPTIONBUILDINFO_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/String.h"
18#include "arcane/core/XmlNode.h"
19
20/*---------------------------------------------------------------------------*/
21/*---------------------------------------------------------------------------*/
22
23namespace Arcane
24{
25
26/*---------------------------------------------------------------------------*/
27/*---------------------------------------------------------------------------*/
28
29class ICaseMng;
30class ICaseOptionList;
31
32/*---------------------------------------------------------------------------*/
33/*---------------------------------------------------------------------------*/
34
40class ARCANE_CORE_EXPORT CaseOptionBuildInfo
41{
42 public:
43
44 CaseOptionBuildInfo(ICaseOptionList* icl, const String& s,
45 const XmlNode& element, const String& def_val,
46 Integer min_occurs, Integer max_occurs);
47 CaseOptionBuildInfo(ICaseOptionList* icl, const String& s,
48 const XmlNode& element, const String& def_val,
49 Integer min_occurs, Integer max_occurs, bool is_optional);
50
51 public:
52
53 ICaseMng* caseMng() const { return m_case_mng; }
54 ICaseOptionList* caseOptionList() const { return m_case_option_list; }
55 String name() const { return m_name; }
56 String defaultValue() const { return m_default_value; }
57 XmlNode element() const { return m_element; }
58 Integer minOccurs() const { return m_min_occurs; }
59 Integer maxOccurs() const { return m_max_occurs; }
60 bool isOptional() const { return m_is_optional; }
61
62 private:
63
64 ICaseMng* m_case_mng;
65 ICaseOptionList* m_case_option_list;
71 bool m_is_optional;
72};
73
74/*---------------------------------------------------------------------------*/
75/*---------------------------------------------------------------------------*/
76
77} // End namespace Arcane
78
79/*---------------------------------------------------------------------------*/
80/*---------------------------------------------------------------------------*/
81
82#endif
String m_name
Name of the option.
XmlNode m_element
Element of the option.
Integer m_min_occurs
Minimum number of occurrences.
String m_default_value
Default value (null if none).
Integer m_max_occurs
Maximum number of occurrences (-1 == unbounded).
Case manager interface.
Definition ICaseMng.h:57
Interface for a data set options list.
Node of a DOM tree.
Definition XmlNode.h:51
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Int32 Integer
Type representing an integer.