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

Metadata on a variable. More...

#include <arcane/core/VariableMetaData.h>

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)

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

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

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

◆ hash2()

String Arcane::VariableMetaData::hash2 ( ) const
inline

Hash of the variable in hexadecimal format.

Definition at line 71 of file VariableMetaData.h.

◆ hashVersion()

Int32 Arcane::VariableMetaData::hashVersion ( ) const
inline

Hash version (associated with hash2()).

Definition at line 75 of file VariableMetaData.h.

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

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