Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
IVariableFactory.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/* IVariableFactory.h C) 2000-2025 */
9/* */
10/* Interface for a factory of a variable of a given type. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_IVARIABLEFACTORY_H
13#define ARCANE_CORE_IVARIABLEFACTORY_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
41{
42 public:
43
45 using VariableFactoryFunc = VariableFactoryVariableRefCreateFunc;
46
47 public:
48
49 virtual ~IVariableFactory() = default;
50
51 public:
52
54 virtual VariableRef* createVariable(const VariableBuildInfo& build_info) = 0;
55
56 public:
57
59 virtual eItemKind itemKind() const = 0;
60
62 virtual eDataType dataType() const = 0;
63
65 virtual Integer dimension() const = 0;
66
68 virtual Integer multiTag() const = 0;
69
71 virtual const String& fullTypeName() const = 0;
72
73 public:
74
77};
78
79/*---------------------------------------------------------------------------*/
80/*---------------------------------------------------------------------------*/
81
82} // End namespace Arcane
83
84/*---------------------------------------------------------------------------*/
85/*---------------------------------------------------------------------------*/
86
87#endif
Declarations of Arcane's general types.
Interface for a variable factory.
virtual eItemKind itemKind() const =0
Kind of the data variables created by this factory.
VariableFactoryVariableRefCreateFunc VariableFactoryFunc
Type of the function that creates the variable.
virtual Integer multiTag() const =0
Multi tag.
virtual VariableRef * createVariable(const VariableBuildInfo &build_info)=0
Creates a variable with the build_info and returns its reference.
virtual VariableTypeInfo variableTypeInfo() const =0
Information about the variable type.
virtual eDataType dataType() const =0
Data type of the variable created by this factory.
virtual const String & fullTypeName() const =0
Full name of the variable type.
virtual Integer dimension() const =0
Dimension of the variable created by this factory.
Parameters necessary for building a variable.
Reference to a variable.
Definition VariableRef.h:56
Information characterizing the type of a variable.
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Int32 Integer
Type representing an integer.
eItemKind
Mesh entity type.
eDataType
Data type.
Definition DataTypes.h:41