Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::VariableFactory Class Reference

Registerer of a variable factory. More...

#include <arcane/core/VariableFactory.h>

Inheritance diagram for Arcane::VariableFactory:
Collaboration diagram for Arcane::VariableFactory:

Public Member Functions

 VariableFactory (VariableFactoryFunc func, eDataType data_type, eItemKind item_kind, Integer dimension, Integer multi_tag, bool is_partial)
 Creates a variable factory.
 VariableFactory (VariableFactoryFunc func, const VariableTypeInfo &var_type_info)
VariableRefcreateVariable (const VariableBuildInfo &name) override
 Creates a variable with the build_info and returns its reference.
eItemKind itemKind () const override
 Kind of the data variables created by this factory.
eDataType dataType () const override
 Data type of the variable created by this factory.
Integer dimension () const override
 Dimension of the variable created by this factory.
Integer multiTag () const override
 Multi tag.
bool isPartial () const
const StringfullTypeName () const override
 Full name of the variable type.
VariableTypeInfo variableTypeInfo () const override
 Information about the variable type.

Private Attributes

VariableFactoryFunc m_function
 Creation function for IVariableFactoryFactory.
VariableTypeInfo m_variable_type_info
 Information about the variable type.
String m_full_type_name
 Full name of the variable type.

Additional Inherited Members

Public Types inherited from Arcane::IVariableFactory
using VariableFactoryFunc = VariableFactoryVariableRefCreateFunc
 Type of the function that creates the variable.

Detailed Description

Registerer of a variable factory.

Definition at line 35 of file VariableFactory.h.

Constructor & Destructor Documentation

◆ VariableFactory() [1/2]

Arcane::VariableFactory::VariableFactory ( VariableFactoryFunc func,
eDataType data_type,
eItemKind item_kind,
Integer dimension,
Integer multi_tag,
bool is_partial )

Creates a variable factory.

Parameters
funcfunction creating the variable
item_kindkind of the variable entity
data_typedata type of the variable
dimensiondimension of the variable
multi_tagtag indicating if it is a multi-sized array.
is_partialindicates if it is a partial variable.

Definition at line 33 of file VariableFactory.cc.

References dimension(), and VariableFactory().

Referenced by VariableFactory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ VariableFactory() [2/2]

Arcane::VariableFactory::VariableFactory ( VariableFactoryFunc func,
const VariableTypeInfo & var_type_info )

Definition at line 44 of file VariableFactory.cc.

Member Function Documentation

◆ createVariable()

VariableRef * Arcane::VariableFactory::createVariable ( const VariableBuildInfo & build_info)
overridevirtual

Creates a variable with the build_info and returns its reference.

Implements Arcane::IVariableFactory.

Definition at line 55 of file VariableFactory.cc.

◆ dataType()

eDataType Arcane::VariableFactory::dataType ( ) const
inlineoverridevirtual

Data type of the variable created by this factory.

Implements Arcane::IVariableFactory.

Definition at line 59 of file VariableFactory.h.

References m_variable_type_info.

◆ dimension()

Integer Arcane::VariableFactory::dimension ( ) const
inlineoverridevirtual

Dimension of the variable created by this factory.

Implements Arcane::IVariableFactory.

Definition at line 60 of file VariableFactory.h.

References m_variable_type_info.

Referenced by VariableFactory().

Here is the caller graph for this function:

◆ fullTypeName()

const String & Arcane::VariableFactory::fullTypeName ( ) const
inlineoverridevirtual

Full name of the variable type.

Implements Arcane::IVariableFactory.

Definition at line 63 of file VariableFactory.h.

References m_full_type_name.

◆ isPartial()

bool Arcane::VariableFactory::isPartial ( ) const
inline

Definition at line 62 of file VariableFactory.h.

◆ itemKind()

eItemKind Arcane::VariableFactory::itemKind ( ) const
inlineoverridevirtual

Kind of the data variables created by this factory.

Implements Arcane::IVariableFactory.

Definition at line 58 of file VariableFactory.h.

References m_variable_type_info.

◆ multiTag()

Integer Arcane::VariableFactory::multiTag ( ) const
inlineoverridevirtual

Multi tag.

Implements Arcane::IVariableFactory.

Definition at line 61 of file VariableFactory.h.

References m_variable_type_info.

◆ variableTypeInfo()

VariableTypeInfo Arcane::VariableFactory::variableTypeInfo ( ) const
inlineoverridevirtual

Information about the variable type.

Implements Arcane::IVariableFactory.

Definition at line 64 of file VariableFactory.h.

References m_variable_type_info.

Member Data Documentation

◆ m_full_type_name

String Arcane::VariableFactory::m_full_type_name
private

Full name of the variable type.

Definition at line 75 of file VariableFactory.h.

Referenced by fullTypeName().

◆ m_function

VariableFactoryFunc Arcane::VariableFactory::m_function
private

Creation function for IVariableFactoryFactory.

Definition at line 69 of file VariableFactory.h.

◆ m_variable_type_info

VariableTypeInfo Arcane::VariableFactory::m_variable_type_info
private

Information about the variable type.

Definition at line 72 of file VariableFactory.h.

Referenced by dataType(), dimension(), itemKind(), multiTag(), and variableTypeInfo().


The documentation for this class was generated from the following files: