Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::VariableFactoryRegisterer Class Reference

Public Types

using VariableFactoryFunc = VariableFactoryVariableRefCreateFunc

Public Member Functions

 VariableFactoryRegisterer (VariableFactoryFunc func, const VariableTypeInfo &var_type_info)
IVariableFactory * createFactory ()
 Creates a factory for this variable type.
VariableFactoryRegisterer * previousVariableFactory () const
 Previous VariableFactory (0 if the first).
VariableFactoryRegisterer * nextVariableFactory () const
 Next VariableFactory (0 if the last).
eItemKind itemKind () const
 Kind of data variables of the variable created by this factory.
eDataType dataType () const
 Data type of the variable created by this factory.
Integer dimension () const
 Dimension of the variable created by this factory.
Integer multiTag () const
 Tag indicating the multiple type (0 if not multiple, 1 if multiple, 2 if multiple deprecated).
bool isPartial () const
 Indicates if the factory is for a partial variable.
const VariableTypeInfo & variableTypeInfo () const
 Information about the variable type.
void setPreviousVariableFactory (VariableFactoryRegisterer *s)
 Positions the previous VariableFactory.
void setNextVariableFactory (VariableFactoryRegisterer *s)
 Positions the next VariableFactory.

Static Public Member Functions

static VariableFactoryRegisterer * firstVariableFactory ()

Detailed Description

Definition at line 41 of file VariableFactoryRegisterer.h.

Member Typedef Documentation

◆ VariableFactoryFunc

using Arcane::VariableFactoryRegisterer::VariableFactoryFunc = VariableFactoryVariableRefCreateFunc

Definition at line 45 of file VariableFactoryRegisterer.h.

Constructor & Destructor Documentation

◆ VariableFactoryRegisterer()

Arcane::VariableFactoryRegisterer::VariableFactoryRegisterer ( IVariableFactory::VariableFactoryFunc func,
const VariableTypeInfo & var_type_info )

Creates a registrar for a VariableFactory for the type var_type_info and for the creation function func

Definition at line 33 of file VariableFactoryRegisterer.cc.

References setNextVariableFactory(), setPreviousVariableFactory(), and VariableFactoryRegisterer().

Referenced by nextVariableFactory(), previousVariableFactory(), setNextVariableFactory(), setPreviousVariableFactory(), and VariableFactoryRegisterer().

Member Function Documentation

◆ createFactory()

IVariableFactory * Arcane::VariableFactoryRegisterer::createFactory ( )

Creates a factory for this variable type.

The factory must be destroyed by the delete operator when it is no longer used.

Definition at line 56 of file VariableFactoryRegisterer.cc.

◆ dataType()

eDataType Arcane::VariableFactoryRegisterer::dataType ( ) const
inline

Data type of the variable created by this factory.

Definition at line 73 of file VariableFactoryRegisterer.h.

◆ dimension()

Integer Arcane::VariableFactoryRegisterer::dimension ( ) const
inline

Dimension of the variable created by this factory.

Definition at line 76 of file VariableFactoryRegisterer.h.

◆ firstVariableFactory()

VariableFactoryRegisterer * Arcane::VariableFactoryRegisterer::firstVariableFactory ( )
static

Definition at line 65 of file VariableFactoryRegisterer.cc.

◆ isPartial()

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

Indicates if the factory is for a partial variable.

Definition at line 82 of file VariableFactoryRegisterer.h.

◆ itemKind()

eItemKind Arcane::VariableFactoryRegisterer::itemKind ( ) const
inline

Kind of data variables of the variable created by this factory.

Definition at line 70 of file VariableFactoryRegisterer.h.

◆ multiTag()

Integer Arcane::VariableFactoryRegisterer::multiTag ( ) const
inline

Tag indicating the multiple type (0 if not multiple, 1 if multiple, 2 if multiple deprecated).

Definition at line 79 of file VariableFactoryRegisterer.h.

◆ nextVariableFactory()

VariableFactoryRegisterer * Arcane::VariableFactoryRegisterer::nextVariableFactory ( ) const
inline

Next VariableFactory (0 if the last).

Definition at line 67 of file VariableFactoryRegisterer.h.

References VariableFactoryRegisterer().

◆ previousVariableFactory()

VariableFactoryRegisterer * Arcane::VariableFactoryRegisterer::previousVariableFactory ( ) const
inline

Previous VariableFactory (0 if the first).

Definition at line 64 of file VariableFactoryRegisterer.h.

References VariableFactoryRegisterer().

◆ setNextVariableFactory()

void Arcane::VariableFactoryRegisterer::setNextVariableFactory ( VariableFactoryRegisterer * s)
inline

Positions the next VariableFactory.

This method is automatically called by IVariableFactoryRegistry.

Definition at line 99 of file VariableFactoryRegisterer.h.

References VariableFactoryRegisterer().

Referenced by VariableFactoryRegisterer().

◆ setPreviousVariableFactory()

void Arcane::VariableFactoryRegisterer::setPreviousVariableFactory ( VariableFactoryRegisterer * s)
inline

Positions the previous VariableFactory.

This method is automatically called by IVariableFactoryRegistry.

Definition at line 92 of file VariableFactoryRegisterer.h.

References VariableFactoryRegisterer().

Referenced by VariableFactoryRegisterer().

◆ variableTypeInfo()

const VariableTypeInfo & Arcane::VariableFactoryRegisterer::variableTypeInfo ( ) const
inline

Information about the variable type.

Definition at line 85 of file VariableFactoryRegisterer.h.

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