Arcane::VariableInfo Class Reference

Information characterizing a variable. More...

#include <arcane/core/VariableInfo.h>

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)

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

_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.

dimension()

Integer Arcane::VariableInfo::dimension ( ) const

inline

Dimension.

Definition at line 73 of file VariableInfo.h.

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.

isPartial()

bool Arcane::VariableInfo::isPartial ( ) const

inline

Indicates if the variable is partial.

Definition at line 79 of file VariableInfo.h.

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.

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.

itemKind()

eItemKind Arcane::VariableInfo::itemKind ( ) const

inline

Mesh entity type.

Definition at line 71 of file VariableInfo.h.

localName()

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

inline

Name of the variable.

Definition at line 56 of file VariableInfo.h.

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.

multiTag()

Integer Arcane::VariableInfo::multiTag ( ) const

inline

Multi-tag.

Definition at line 75 of file VariableInfo.h.

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.

storageTypeInfo()

DataStorageTypeInfo Arcane::VariableInfo::storageTypeInfo ( ) const

inline

Information about the variable container type.

Definition at line 90 of file VariableInfo.h.

variableTypeInfo()

VariableTypeInfo Arcane::VariableInfo::variableTypeInfo ( ) const

inline

Information about the variable type.

Definition at line 88 of file VariableInfo.h.

---

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

• VariableInfo.h
• VariableInfo.cc