Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IVariableFactory Class Referenceabstract

Interface for a variable factory. More...

#include <arcane/core/IVariableFactory.h>

Inheritance diagram for Arcane::IVariableFactory:
Collaboration diagram for Arcane::IVariableFactory:

Public Types

using VariableFactoryFunc = VariableFactoryVariableRefCreateFunc
 Type of the function that creates the variable.

Public Member Functions

virtual VariableRefcreateVariable (const VariableBuildInfo &build_info)=0
 Creates a variable with the build_info and returns its reference.
virtual eItemKind itemKind () const =0
 Kind of the data variables created by this factory.
virtual eDataType dataType () const =0
 Data type of the variable created by this factory.
virtual Integer dimension () const =0
 Dimension of the variable created by this factory.
virtual Integer multiTag () const =0
 Multi tag.
virtual const StringfullTypeName () const =0
 Full name of the variable type.
virtual VariableTypeInfo variableTypeInfo () const =0
 Information about the variable type.

Detailed Description

Interface for a variable factory.

The instance allows creating a variable based on its data type (dataType()), its entity kind (itemKind()), its dimension (dimension()), and its tag if it is a multi-array (multiTag()).

The fullTypeName() operation contains the complete type name, obtained in the following way: dataType().itemKind().dimension().multiTag. For example, for a real scalar variable on the cells, the complete type is: "Real.Cell.0.0".

Definition at line 40 of file IVariableFactory.h.

Member Typedef Documentation

◆ VariableFactoryFunc

using Arcane::IVariableFactory::VariableFactoryFunc = VariableFactoryVariableRefCreateFunc

Type of the function that creates the variable.

Definition at line 45 of file IVariableFactory.h.

Member Function Documentation

◆ createVariable()

virtual VariableRef * Arcane::IVariableFactory::createVariable ( const VariableBuildInfo & build_info)
pure virtual

Creates a variable with the build_info and returns its reference.

Implemented in Arcane::VariableFactory.

◆ dataType()

virtual eDataType Arcane::IVariableFactory::dataType ( ) const
pure virtual

Data type of the variable created by this factory.

Implemented in Arcane::VariableFactory.

◆ dimension()

virtual Integer Arcane::IVariableFactory::dimension ( ) const
pure virtual

Dimension of the variable created by this factory.

Implemented in Arcane::VariableFactory.

◆ fullTypeName()

virtual const String & Arcane::IVariableFactory::fullTypeName ( ) const
pure virtual

Full name of the variable type.

Implemented in Arcane::VariableFactory.

Referenced by Arcane::VariableMng::initialize().

Here is the caller graph for this function:

◆ itemKind()

virtual eItemKind Arcane::IVariableFactory::itemKind ( ) const
pure virtual

Kind of the data variables created by this factory.

Implemented in Arcane::VariableFactory.

◆ multiTag()

virtual Integer Arcane::IVariableFactory::multiTag ( ) const
pure virtual

Multi tag.

Implemented in Arcane::VariableFactory.

◆ variableTypeInfo()

virtual VariableTypeInfo Arcane::IVariableFactory::variableTypeInfo ( ) const
pure virtual

Information about the variable type.

Implemented in Arcane::VariableFactory.


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