Metadata on a variable. More...

#include <arcane/core/VariableMetaData.h>

Collaboration diagram for Arcane::VariableMetaData:

Public Member Functions
	VariableMetaData (const String &base_name, const String &mesh_name, const String &item_family_name, const String &item_group_name, bool is_partial)
	Constructor.
String	fullName () const
	Full name of the variable.
String	baseName () const
	Base name of the variable.
String	meshName () const
String	itemFamilyName () const
String	itemGroupName () const
bool	isPartial () const
String	fullType () const
void	setFullType (const String &v)
String	hash () const
	Hash of the variable in hexadecimal format.
void	setHash (const String &v)
String	hash2 () const
	Hash of the variable in hexadecimal format.
void	setHash2 (const String &v)
Int32	hashVersion () const
	Hash version (associated with hash2()).
void	setHashVersion (Int32 v)
Integer	property () const
void	setProperty (Integer v)
String	multiTag () const
void	setMultiTag (const String &v)

Private Member Functions
void	_buildFullName ()

Private Attributes
String	m_base_name
String	m_mesh_name
String	m_item_family_name
String	m_item_group_name
String	m_full_type
String	m_hash_str
Integer	m_property
String	m_multi_tag
String	m_full_name
bool	m_is_partial
String	m_hash2_str
Int32	m_hash_version = 0

Detailed Description

Metadata on a variable.

The information in this class allows for the reconstruction of a variable.

If hash2() is not null, it is used. Otherwise, hash() is used.

Definition at line 36 of file VariableMetaData.h.

Constructor & Destructor Documentation

◆ VariableMetaData()

Arcane::VariableMetaData::VariableMetaData	(	const String &	base_name,
		const String &	mesh_name,
		const String &	item_family_name,
		const String &	item_group_name,
		bool	is_partial )

Constructor.

Constructs the instance for a variable with name base_name, from family item_family_name and group item_group_name. If the variable is not on a mesh, then mesh_name, item_family_name and item_group_name are null.

Definition at line 27 of file VariableMetaData.cc.

Member Function Documentation

◆ _buildFullName()

void Arcane::VariableMetaData::_buildFullName ( )

private

Definition at line 44 of file VariableMetaData.cc.

◆ baseName()

String Arcane::VariableMetaData::baseName ( ) const

inline

Base name of the variable.

Definition at line 57 of file VariableMetaData.h.

◆ fullName()

String Arcane::VariableMetaData::fullName ( ) const

inline

Full name of the variable.

Definition at line 55 of file VariableMetaData.h.

Referenced by Arcane::impl::BasicReader::read().

Here is the caller graph for this function:

◆ fullType()

String Arcane::VariableMetaData::fullType ( ) const

inline

Definition at line 63 of file VariableMetaData.h.

◆ hash()

String Arcane::VariableMetaData::hash ( ) const

inline

Hash of the variable in hexadecimal format.

Definition at line 67 of file VariableMetaData.h.

Referenced by Arcane::VariableIOReaderMng::_checkHashFunction().

Here is the caller graph for this function:

◆ hash2()

String Arcane::VariableMetaData::hash2 ( ) const

inline

Hash of the variable in hexadecimal format.

Definition at line 71 of file VariableMetaData.h.

Referenced by Arcane::VariableIOReaderMng::_checkHashFunction().

Here is the caller graph for this function:

◆ hashVersion()

Int32 Arcane::VariableMetaData::hashVersion ( ) const

inline

Hash version (associated with hash2()).

Definition at line 75 of file VariableMetaData.h.

Referenced by Arcane::VariableIOReaderMng::_checkHashFunction().

Here is the caller graph for this function:

◆ isPartial()

bool Arcane::VariableMetaData::isPartial ( ) const

inline

Definition at line 61 of file VariableMetaData.h.

◆ itemFamilyName()

String Arcane::VariableMetaData::itemFamilyName ( ) const

inline

Definition at line 59 of file VariableMetaData.h.

◆ itemGroupName()

String Arcane::VariableMetaData::itemGroupName ( ) const

inline

Definition at line 60 of file VariableMetaData.h.

◆ meshName()

String Arcane::VariableMetaData::meshName ( ) const

inline

Definition at line 58 of file VariableMetaData.h.

◆ multiTag()

String Arcane::VariableMetaData::multiTag ( ) const

inline

Definition at line 81 of file VariableMetaData.h.

◆ property()

Integer Arcane::VariableMetaData::property ( ) const

inline

Definition at line 78 of file VariableMetaData.h.

◆ setFullType()

void Arcane::VariableMetaData::setFullType ( const String & v )

inline

Definition at line 64 of file VariableMetaData.h.

◆ setHash()

void Arcane::VariableMetaData::setHash ( const String & v )

inline

Definition at line 68 of file VariableMetaData.h.

◆ setHash2()

void Arcane::VariableMetaData::setHash2 ( const String & v )

inline

Definition at line 72 of file VariableMetaData.h.

◆ setHashVersion()

void Arcane::VariableMetaData::setHashVersion ( Int32 v )

inline

Definition at line 76 of file VariableMetaData.h.

◆ setMultiTag()

void Arcane::VariableMetaData::setMultiTag ( const String & v )

inline

Definition at line 82 of file VariableMetaData.h.

◆ setProperty()

void Arcane::VariableMetaData::setProperty ( Integer v )

inline

Definition at line 79 of file VariableMetaData.h.

Member Data Documentation

◆ m_base_name

String Arcane::VariableMetaData::m_base_name

private

Definition at line 86 of file VariableMetaData.h.

◆ m_full_name

String Arcane::VariableMetaData::m_full_name

private

Definition at line 94 of file VariableMetaData.h.

◆ m_full_type

String Arcane::VariableMetaData::m_full_type

private

Definition at line 90 of file VariableMetaData.h.

◆ m_hash2_str

String Arcane::VariableMetaData::m_hash2_str

private

Definition at line 96 of file VariableMetaData.h.

◆ m_hash_str

String Arcane::VariableMetaData::m_hash_str

private

Definition at line 91 of file VariableMetaData.h.

◆ m_hash_version

Int32 Arcane::VariableMetaData::m_hash_version = 0

private

Definition at line 97 of file VariableMetaData.h.

◆ m_is_partial

bool Arcane::VariableMetaData::m_is_partial

private

Definition at line 95 of file VariableMetaData.h.

◆ m_item_family_name

String Arcane::VariableMetaData::m_item_family_name

private

Definition at line 88 of file VariableMetaData.h.

◆ m_item_group_name

String Arcane::VariableMetaData::m_item_group_name

private

Definition at line 89 of file VariableMetaData.h.

◆ m_mesh_name

String Arcane::VariableMetaData::m_mesh_name

private

Definition at line 87 of file VariableMetaData.h.

◆ m_multi_tag

String Arcane::VariableMetaData::m_multi_tag

private

Definition at line 93 of file VariableMetaData.h.

◆ m_property

Integer Arcane::VariableMetaData::m_property

private

Definition at line 92 of file VariableMetaData.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VariableMetaData()

Member Function Documentation

◆ _buildFullName()

◆ baseName()

◆ fullName()

◆ fullType()

◆ hash()

◆ hash2()

◆ hashVersion()

◆ isPartial()

◆ itemFamilyName()

◆ itemGroupName()

◆ meshName()

◆ multiTag()

◆ property()

◆ setFullType()

◆ setHash()

◆ setHash2()

◆ setHashVersion()

◆ setMultiTag()

◆ setProperty()

Member Data Documentation

◆ m_base_name

◆ m_full_name

◆ m_full_type

◆ m_hash2_str

◆ m_hash_str

◆ m_hash_version

◆ m_is_partial

◆ m_item_family_name

◆ m_item_group_name

◆ m_mesh_name

◆ m_multi_tag

◆ m_property