Information characterizing a variable. More...

#include <arcane/core/VariableInfo.h>

Collaboration diagram for Arcane::VariableInfo:

Public Member Functions
	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 String &	localName () const
	Name of the variable.
const String &	itemFamilyName () const
	Name of the entity family to which the variable is associated.
const String &	itemGroupName () const
	Name of the entity group to which the variable is associated.
const String &	meshName () const
	Name of the mesh to which the variable is associated.
const String &	fullName () const
	Full name of the variable (associated with the family).
eItemKind	itemKind () const
	Mesh entity type.
Integer	dimension () const
	Dimension.
Integer	multiTag () const
	Multi-tag.
eDataType	dataType () const
	Element type.
bool	isPartial () const
	Indicates if the variable is partial.
void	setDefaultItemGroupName ()
	If null, changes itemGroupName() to the name of the group of all entities in the family.
VariableTypeInfo	variableTypeInfo () const
	Information about the variable type.
DataStorageTypeInfo	storageTypeInfo () const
	Information about the variable container type.

Static Public Member Functions
static DataStorageTypeInfo	_internalGetStorageTypeInfo (eDataType data_type, Integer dimension, Integer multi_tag)

Private Member Functions
String	_defaultFamilyName ()
void	_computeFullName () const
	Calculates the full name of the variable.

Private Attributes
String	m_local_name
	Name of the variable.
String	m_item_family_name
	Name of the entity family to which the variable is associated.
String	m_item_group_name
	Name of the entity group to which the variable is associated.
String	m_mesh_name
	Name of the mesh to which the variable is associated.
String	m_full_name
	Full name of the variable (associated with the family).
VariableTypeInfo	m_variable_type_info
	Information about the variable type.
DataStorageTypeInfo	m_storage_type_info
	Information about the variable data container.

Detailed Description

Information characterizing a variable.

Definition at line 37 of file VariableInfo.h.

Constructor & Destructor Documentation

◆ 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 )

Definition at line 103 of file 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 )

Definition at line 117 of file VariableInfo.cc.

Member Function Documentation

◆ _computeFullName()

void Arcane::VariableInfo::_computeFullName ( ) const

private

Calculates the full name of the variable.

This name requires concatenating strings and therefore making allocations which can be costly. The name is only calculated if fullName() is explicitly requested.

Definition at line 180 of file VariableInfo.cc.

References m_full_name, m_item_family_name, m_local_name, m_mesh_name, and Arcane::StringBuilder::toString().

Referenced by fullName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _defaultFamilyName()

String Arcane::VariableInfo::_defaultFamilyName ( )

private

Definition at line 143 of file VariableInfo.cc.

◆ _internalGetStorageTypeInfo()

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

static

Definition at line 27 of file VariableInfo.cc.

◆ dataType()

eDataType Arcane::VariableInfo::dataType ( ) const

inline

Element type.

Definition at line 77 of file VariableInfo.h.

References m_variable_type_info.

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

Here is the caller graph for this function:

◆ dimension()

Integer Arcane::VariableInfo::dimension ( ) const

inline

Dimension.

Definition at line 73 of file VariableInfo.h.

References m_variable_type_info.

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

Here is the caller graph for this function:

◆ fullName()

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

inline

Full name of the variable (associated with the family).

Definition at line 64 of file VariableInfo.h.

References _computeFullName(), and m_full_name.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPartial()

bool Arcane::VariableInfo::isPartial ( ) const

inline

Indicates if the variable is partial.

Definition at line 79 of file VariableInfo.h.

References m_variable_type_info.

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

Here is the caller graph for this function:

◆ itemFamilyName()

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

inline

Name of the entity family to which the variable is associated.

Definition at line 58 of file VariableInfo.h.

References m_item_family_name.

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

Here is the caller graph for this function:

◆ itemGroupName()

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

inline

Name of the entity group to which the variable is associated.

Definition at line 60 of file VariableInfo.h.

References m_item_group_name.

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

Here is the caller graph for this function:

◆ itemKind()

eItemKind Arcane::VariableInfo::itemKind ( ) const

inline

Mesh entity type.

Definition at line 71 of file VariableInfo.h.

References m_variable_type_info.

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

Here is the caller graph for this function:

◆ localName()

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

inline

Name of the variable.

Definition at line 56 of file VariableInfo.h.

References m_local_name.

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

Here is the caller graph for this function:

◆ meshName()

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

inline

Name of the mesh to which the variable is associated.

Definition at line 62 of file VariableInfo.h.

References m_mesh_name.

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

Here is the caller graph for this function:

◆ multiTag()

Integer Arcane::VariableInfo::multiTag ( ) const

inline

Multi-tag.

Definition at line 75 of file VariableInfo.h.

References m_variable_type_info.

◆ setDefaultItemGroupName()

void Arcane::VariableInfo::setDefaultItemGroupName ( )

If null, changes itemGroupName() to the name of the group of all entities in the family.

Definition at line 206 of file VariableInfo.cc.

References m_item_family_name, and m_item_group_name.

◆ storageTypeInfo()

DataStorageTypeInfo Arcane::VariableInfo::storageTypeInfo ( ) const

inline

Information about the variable container type.

Definition at line 90 of file VariableInfo.h.

References m_storage_type_info.

◆ variableTypeInfo()

VariableTypeInfo Arcane::VariableInfo::variableTypeInfo ( ) const

inline

Information about the variable type.

Definition at line 88 of file VariableInfo.h.

References m_variable_type_info.

Member Data Documentation

◆ m_full_name

String Arcane::VariableInfo::m_full_name

mutableprivate

Full name of the variable (associated with the family).

Definition at line 108 of file VariableInfo.h.

Referenced by _computeFullName(), and fullName().

◆ m_item_family_name

String Arcane::VariableInfo::m_item_family_name

private

Name of the entity family to which the variable is associated.

Definition at line 102 of file VariableInfo.h.

Referenced by _computeFullName(), itemFamilyName(), and setDefaultItemGroupName().

◆ m_item_group_name

String Arcane::VariableInfo::m_item_group_name

private

Name of the entity group to which the variable is associated.

Definition at line 104 of file VariableInfo.h.

Referenced by itemGroupName(), and setDefaultItemGroupName().

◆ m_local_name

String Arcane::VariableInfo::m_local_name

private

Name of the variable.

Definition at line 100 of file VariableInfo.h.

Referenced by _computeFullName(), and localName().

◆ m_mesh_name

String Arcane::VariableInfo::m_mesh_name

private

Name of the mesh to which the variable is associated.

Definition at line 106 of file VariableInfo.h.

Referenced by _computeFullName(), and meshName().

◆ m_storage_type_info

DataStorageTypeInfo Arcane::VariableInfo::m_storage_type_info

private

Information about the variable data container.

Definition at line 112 of file VariableInfo.h.

Referenced by storageTypeInfo().

◆ m_variable_type_info

VariableTypeInfo Arcane::VariableInfo::m_variable_type_info

private

Information about the variable type.

Definition at line 110 of file VariableInfo.h.

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VariableInfo() [1/2]

◆ VariableInfo() [2/2]

Member Function Documentation

◆ _computeFullName()

◆ _defaultFamilyName()

◆ _internalGetStorageTypeInfo()

◆ dataType()

◆ dimension()

◆ fullName()

◆ isPartial()

◆ itemFamilyName()

◆ itemGroupName()

◆ itemKind()

◆ localName()

◆ meshName()

◆ multiTag()

◆ setDefaultItemGroupName()

◆ storageTypeInfo()

◆ variableTypeInfo()

Member Data Documentation

◆ m_full_name

◆ m_item_family_name

◆ m_item_group_name

◆ m_local_name

◆ m_mesh_name

◆ m_storage_type_info

◆ m_variable_type_info