Arcane  v3.14.10.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::VariableInfo

Infos caractérisant une variable. Plus de détails...

#include <arcane/core/VariableInfo.h>

+ Graphe de collaboration de Arcane::VariableInfo:

Fonctions membres publiques

 VariableInfo (const String &local_name, const String &item_family_name, const String &item_group_name, const String &mesh_name, eItemKind item_kind, Integer dimension, Integer multi_tag, eDataType type)
 
 VariableInfo (const String &local_name, const String &item_family_name, const String &item_group_name, const String &mesh_name, const VariableTypeInfo &var_type_info, const DataStorageTypeInfo &storage_info)
 
const StringlocalName () const
 Nom de la variable.
 
const StringitemFamilyName () const
 Nom de la famille d'entité à laquelle la variable est associée.
 
const StringitemGroupName () const
 Nom du groupe d'entité à laquelle la variable est associée.
 
const StringmeshName () const
 Nom du maillage auquel la variable est associée.
 
const StringfullName () const
 Nom complet de la variable (associé à la famille)
 
eItemKind itemKind () const
 Type d'entité de maillage.
 
Integer dimension () const
 Dimension.
 
Integer multiTag () const
 Multi-tag.
 
eDataType dataType () const
 Type des éléments.
 
bool isPartial () const
 Indique si la variable est partielle.
 
void setDefaultItemGroupName ()
 Si null, change itemGroupName() en le nom du groupe de toutes les entités de la famille.
 
VariableTypeInfo variableTypeInfo () const
 Informations sur le type de la variable.
 
DataStorageTypeInfo storageTypeInfo () const
 Informations sur le type de conteneur de la variable.
 

Fonctions membres publiques statiques

static DataStorageTypeInfo _internalGetStorageTypeInfo (eDataType data_type, Integer dimension, Integer multi_tag)
 

Fonctions membres privées

String _defaultFamilyName ()
 
void _computeFullName () const
 Calcul le nom complet de la variable.
 

Attributs privés

String m_local_name
 Nom de la variable.
 
String m_item_family_name
 Nom de la famille d'entité à laquelle la variable est associée.
 
String m_item_group_name
 Nom du groupe d'entité à laquelle la variable est associée.
 
String m_mesh_name
 Nom du maillage auquel la variable est associée.
 
String m_full_name
 Nom complet de la variable (associé à la famille)
 
VariableTypeInfo m_variable_type_info
 Informations sur le type de la variable.
 
DataStorageTypeInfo m_storage_type_info
 Informations sur le conteneur de donnée de la variable.
 

Description détaillée

Infos caractérisant une variable.

Définition à la ligne 36 du fichier VariableInfo.h.

Documentation des constructeurs et destructeur

◆ VariableInfo() [1/2]

Arcane::VariableInfo::VariableInfo ( const String local_name,
const String item_family_name,
const String item_group_name,
const String mesh_name,
eItemKind  item_kind,
Integer  dimension,
Integer  multi_tag,
eDataType  type 
)

Définition à la ligne 87 du fichier VariableInfo.cc.

◆ VariableInfo() [2/2]

Arcane::VariableInfo::VariableInfo ( const String local_name,
const String item_family_name,
const String item_group_name,
const String mesh_name,
const VariableTypeInfo var_type_info,
const DataStorageTypeInfo storage_info 
)

Définition à la ligne 101 du fichier VariableInfo.cc.

Documentation des fonctions membres

◆ _computeFullName()

void Arcane::VariableInfo::_computeFullName ( ) const
private

Calcul le nom complet de la variable.

Ce nom nécessite de concaténer des chaînes de caractère et donc de faire des allocations qui peuvent être couteuses. On ne calcule le nom que si fullName() est explicitement demandé.

Définition à la ligne 163 du fichier VariableInfo.cc.

◆ _defaultFamilyName()

String Arcane::VariableInfo::_defaultFamilyName ( )
private

Définition à la ligne 127 du fichier VariableInfo.cc.

◆ _internalGetStorageTypeInfo()

DataStorageTypeInfo Arcane::VariableInfo::_internalGetStorageTypeInfo ( eDataType  data_type,
Integer  dimension,
Integer  multi_tag 
)
static

Définition à la ligne 27 du fichier VariableInfo.cc.

◆ dataType()

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

Type des éléments.

Définition à la ligne 76 du fichier VariableInfo.h.

Référencé par Arcane::Variable::_setData(), Arcane::VariableMng::checkVariable(), et Arcane::Variable::dataType().

◆ dimension()

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

Dimension.

Définition à la ligne 72 du fichier VariableInfo.h.

Référencé par Arcane::Variable::_setData(), Arcane::VariableMng::checkVariable(), et Arcane::Variable::dimension().

◆ fullName()

const String & Arcane::VariableInfo::fullName ( ) const
inline

Nom complet de la variable (associé à la famille)

Définition à la ligne 63 du fichier VariableInfo.h.

Référencé par Arcane::Variable::_setData(), Arcane::VariableMng::checkVariable(), Arcane::Variable::fullName(), et Arcane::VariablePrivate::serializeHashId().

◆ isPartial()

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

Indique si la variable est partielle.

Définition à la ligne 78 du fichier VariableInfo.h.

Référencé par Arcane::VariableMng::checkVariable().

◆ itemFamilyName()

const String & Arcane::VariableInfo::itemFamilyName ( ) const
inline

Nom de la famille d'entité à laquelle la variable est associée.

Définition à la ligne 57 du fichier VariableInfo.h.

Référencé par Arcane::VariableMng::checkVariable(), et Arcane::Variable::itemFamilyName().

◆ itemGroupName()

const String & Arcane::VariableInfo::itemGroupName ( ) const
inline

Nom du groupe d'entité à laquelle la variable est associée.

Définition à la ligne 59 du fichier VariableInfo.h.

Référencé par Arcane::VariableMng::checkVariable(), et Arcane::Variable::itemGroupName().

◆ itemKind()

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

Type d'entité de maillage.

Définition à la ligne 70 du fichier VariableInfo.h.

Référencé par Arcane::VariableMng::checkVariable(), et Arcane::Variable::itemKind().

◆ localName()

const String & Arcane::VariableInfo::localName ( ) const
inline

Nom de la variable.

Définition à la ligne 55 du fichier VariableInfo.h.

Référencé par Arcane::VariableMng::checkVariable(), et Arcane::Variable::name().

◆ meshName()

const String & Arcane::VariableInfo::meshName ( ) const
inline

Nom du maillage auquel la variable est associée.

Définition à la ligne 61 du fichier VariableInfo.h.

Référencé par Arcane::VariableMng::checkVariable(), et Arcane::Variable::meshName().

◆ multiTag()

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

Multi-tag.

Définition à la ligne 74 du fichier VariableInfo.h.

Référencé par Arcane::Variable::_setData(), et Arcane::Variable::multiTag().

◆ setDefaultItemGroupName()

void Arcane::VariableInfo::setDefaultItemGroupName ( )

Si null, change itemGroupName() en le nom du groupe de toutes les entités de la famille.

Définition à la ligne 189 du fichier VariableInfo.cc.

◆ storageTypeInfo()

DataStorageTypeInfo Arcane::VariableInfo::storageTypeInfo ( ) const
inline

Informations sur le type de conteneur de la variable.

Définition à la ligne 89 du fichier VariableInfo.h.

◆ variableTypeInfo()

VariableTypeInfo Arcane::VariableInfo::variableTypeInfo ( ) const
inline

Informations sur le type de la variable.

Définition à la ligne 87 du fichier VariableInfo.h.

Documentation des données membres

◆ m_full_name

String Arcane::VariableInfo::m_full_name
mutableprivate

Nom complet de la variable (associé à la famille)

Définition à la ligne 107 du fichier VariableInfo.h.

◆ m_item_family_name

String Arcane::VariableInfo::m_item_family_name
private

Nom de la famille d'entité à laquelle la variable est associée.

Définition à la ligne 101 du fichier VariableInfo.h.

◆ m_item_group_name

String Arcane::VariableInfo::m_item_group_name
private

Nom du groupe d'entité à laquelle la variable est associée.

Définition à la ligne 103 du fichier VariableInfo.h.

◆ m_local_name

String Arcane::VariableInfo::m_local_name
private

Nom de la variable.

Définition à la ligne 99 du fichier VariableInfo.h.

◆ m_mesh_name

String Arcane::VariableInfo::m_mesh_name
private

Nom du maillage auquel la variable est associée.

Définition à la ligne 105 du fichier VariableInfo.h.

◆ m_storage_type_info

DataStorageTypeInfo Arcane::VariableInfo::m_storage_type_info
private

Informations sur le conteneur de donnée de la variable.

Définition à la ligne 111 du fichier VariableInfo.h.

◆ m_variable_type_info

VariableTypeInfo Arcane::VariableInfo::m_variable_type_info
private

Informations sur le type de la variable.

Définition à la ligne 109 du fichier VariableInfo.h.


La documentation de cette classe a été générée à partir des fichiers suivants :