Parameters necessary for building a variable. More...

#include <arcane/core/VariableBuildInfo.h>

Inheritance diagram for Arcane::VariableBuildInfo:

Collaboration diagram for Arcane::VariableBuildInfo:

Classes
struct	NullTag
	Tag for a null VariableBuildInfo. More...

Public Member Functions
	VariableBuildInfo (IModule *m, const String &name, int property=0)
	Constructs an initializer for a variable.
	VariableBuildInfo (ISubDomain *sub_domain, const String &name, int property=0)
	Constructs an initializer for a variable without associating it with a module.
	VariableBuildInfo (IVariableMng *variable_mng, const String &name, int property=0)
	Constructs an initializer for a variable without associating it with a module.
	VariableBuildInfo (IMesh *mesh, const String &name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (const MeshHandle &mesh_handle, const String &name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (IModule *m, const String &name, const String &item_family_name, int property=0)
	Constructs an initializer for a variable.
	VariableBuildInfo (IMesh *mesh, const String &name, const String &item_family_name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (const MeshHandle &mesh_handle, const String &name, const String &item_family_name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (ISubDomain *sd, const String &name, const String &mesh_name, const String &item_family_name, int property=0)
	Constructs an initializer for a variable not associated with a mesh.
	VariableBuildInfo (IVariableMng *variable_mng, const String &name, const String &mesh_name, const String &item_family_name, int property=0)
	Constructs an initializer for a variable not associated with a mesh.
	VariableBuildInfo (IItemFamily *family, const String &name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (IModule *m, const String &name, const String &item_family_name, const String &item_group_name, int property=0)
	Constructs an initializer for a variable.
	VariableBuildInfo (IMesh *mesh, const String &name, const String &item_family_name, const String &item_group_name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (const MeshHandle &mesh_handle, const String &name, const String &item_family_name, const String &item_group_name, int property=0)
	Constructs an initializer for a variable associated with a mesh other than the default mesh.
	VariableBuildInfo (ISubDomain *sd, const String &name, const String &mesh_name, const String &item_family_name, const String &item_group_name, int property=0)
	Constructs an initializer for a variable not associated with a mesh.
	VariableBuildInfo (IVariableMng *variable_mng, const String &name, const String &mesh_name, const String &item_family_name, const String &item_group_name, int property=0)
	Constructs an initializer for a variable not associated with a mesh.
ISubDomain *	subDomain () const
IVariableMng *	variableMng () const
IDataFactoryMng *	dataFactoryMng () const
ITraceMng *	traceMng () const
IModule *	module () const
IMesh *	mesh () const
const MeshHandle &	meshHandle () const
const String &	name () const
const String &	itemFamilyName () const
const String &	itemGroupName () const
const String &	meshName () const
int	property () const
bool	isNull () const

Private Member Functions
	VariableBuildInfo (const NullTag &)
void	_init ()
ISubDomain *	_subDomain () const

Private Attributes
ISubDomain *	m_sub_domain = nullptr
	Subdomain manager.
IModule *	m_module = nullptr
	Module associated with the variable.
MeshHandle	m_mesh_handle
	Handle on the mesh.
String	m_name
	Variable name.
String	m_item_family_name
	Entity family name.
String	m_item_group_name
	Supported entity group name.
String	m_mesh_name
	Name of the mesh associated with the variable.
int	m_property = 0
	Variable properties.
bool	m_is_null = false

Friends
class	NullVariableBuildInfo
class	VariablePrivate

Detailed Description

Parameters necessary for building a variable.

Definition at line 43 of file VariableBuildInfo.h.

Constructor & Destructor Documentation

◆ VariableBuildInfo() [1/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IModule *	m,
		const String &	name,
		int	property = 0 )

Constructs an initializer for a variable.

Parameters

name	variable name
m	associated module
property	variable properties

Definition at line 45 of file VariableBuildInfo.cc.

References m_mesh_handle, m_module, m_name, m_property, and m_sub_domain.

Referenced by Arcane::TemporaryVariableBuildInfo::TemporaryVariableBuildInfo(), Arcane::TemporaryVariableBuildInfo::TemporaryVariableBuildInfo(), Arcane::TemporaryVariableBuildInfo::TemporaryVariableBuildInfo(), Arcane::TemporaryVariableBuildInfo::TemporaryVariableBuildInfo(), Arcane::TemporaryVariableBuildInfo::TemporaryVariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

Here is the caller graph for this function:

◆ VariableBuildInfo() [2/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	ISubDomain *	sub_domain,
		const String &	name,
		int	property = 0 )

Constructs an initializer for a variable without associating it with a module.

Parameters

sub_domain	subdomain manager
name	variable name
property	variable properties

Definition at line 59 of file VariableBuildInfo.cc.

References m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [3/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IVariableMng *	variable_mng,
		const String &	name,
		int	property = 0 )

Constructs an initializer for a variable without associating it with a module.

Parameters

variable_mng	variable manager
name	variable name
property	variable properties

Definition at line 71 of file VariableBuildInfo.cc.

References m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [4/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IMesh *	mesh,
		const String &	name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

mesh	mesh
name	variable name
property	variable properties

Definition at line 96 of file VariableBuildInfo.cc.

References VariableBuildInfo().

Here is the call graph for this function:

◆ VariableBuildInfo() [5/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	const MeshHandle &	mesh_handle,
		const String &	name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

mesh	mesh
name	variable name
property	variable properties

Definition at line 83 of file VariableBuildInfo.cc.

References m_mesh_handle, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [6/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IModule *	m,
		const String &	name,
		const String &	item_family_name,
		int	property = 0 )

Constructs an initializer for a variable.

Parameters

m	associated module
name	variable name
item_family_name	entity family name
property	variable properties

Definition at line 105 of file VariableBuildInfo.cc.

References m_item_family_name, m_mesh_handle, m_module, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [7/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IMesh *	mesh,
		const String &	name,
		const String &	item_family_name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

mesh	mesh
name	variable name
item_family_name	entity family name
property	variable properties

Definition at line 136 of file VariableBuildInfo.cc.

References VariableBuildInfo().

Here is the call graph for this function:

◆ VariableBuildInfo() [8/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	const MeshHandle &	mesh_handle,
		const String &	name,
		const String &	item_family_name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

mesh	mesh
name	variable name
item_family_name	entity family name
property	variable properties

Definition at line 121 of file VariableBuildInfo.cc.

References m_item_family_name, m_mesh_handle, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [9/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	ISubDomain *	sd,
		const String &	name,
		const String &	mesh_name,
		const String &	item_family_name,
		int	property = 0 )

Constructs an initializer for a variable not associated with a mesh.

Parameters

sd	subdomain
name	variable name
mesh_name	mesh name
item_family_name	entity family name
property	variable properties

Definition at line 146 of file VariableBuildInfo.cc.

References m_item_family_name, m_mesh_name, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [10/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IVariableMng *	variable_mng,
		const String &	name,
		const String &	mesh_name,
		const String &	item_family_name,
		int	property = 0 )

Constructs an initializer for a variable not associated with a mesh.

Parameters

variable_mng	variable manager
name	variable name
mesh_name	mesh name
item_family_name	entity family name
property	variable properties

Definition at line 161 of file VariableBuildInfo.cc.

References m_item_family_name, m_mesh_name, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [11/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IItemFamily *	family,
		const String &	name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

family	entity family
name	variable name
property	variable properties

Definition at line 176 of file VariableBuildInfo.cc.

References m_item_family_name, m_mesh_handle, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [12/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IModule *	m,
		const String &	name,
		const String &	item_family_name,
		const String &	item_group_name,
		int	property = 0 )

Constructs an initializer for a variable.

Parameters

m	associated module
name	variable name
item_family_name	entity family name
item_group_name	associated group name (for partial variables)
property	variable properties

Definition at line 190 of file VariableBuildInfo.cc.

References m_item_family_name, m_item_group_name, m_mesh_handle, m_module, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [13/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IMesh *	mesh,
		const String &	name,
		const String &	item_family_name,
		const String &	item_group_name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

mesh	mesh
name	variable name
item_family_name	entity family name
group_name	associated group name (for partial variables)
property	variable properties

Definition at line 225 of file VariableBuildInfo.cc.

References VariableBuildInfo().

Here is the call graph for this function:

◆ VariableBuildInfo() [14/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	const MeshHandle &	mesh_handle,
		const String &	name,
		const String &	item_family_name,
		const String &	item_group_name,
		int	property = 0 )

Constructs an initializer for a variable associated with a mesh other than the default mesh.

Parameters

mesh	mesh
name	variable name
item_family_name	entity family name
group_name	associated group name (for partial variables)
property	variable properties

Definition at line 208 of file VariableBuildInfo.cc.

References m_item_family_name, m_item_group_name, m_mesh_handle, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [15/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	ISubDomain *	sd,
		const String &	name,
		const String &	mesh_name,
		const String &	item_family_name,
		const String &	item_group_name,
		int	property = 0 )

Constructs an initializer for a variable not associated with a mesh.

Parameters

sd	subdomain
name	variable name
mesh_name	mesh name
item_family_name	entity family name
group_name	associated group name (for partial variables)
property	variable properties

Definition at line 236 of file VariableBuildInfo.cc.

References m_item_family_name, m_item_group_name, m_mesh_name, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [16/17]

Arcane::VariableBuildInfo::VariableBuildInfo	(	IVariableMng *	variable_mng,
		const String &	name,
		const String &	mesh_name,
		const String &	item_family_name,
		const String &	item_group_name,
		int	property = 0 )

Constructs an initializer for a variable not associated with a mesh.

Parameters

variable_mng	variable manager
name	variable name
mesh_name	mesh name
item_family_name	entity family name
group_name	associated group name (for partial variables)
property	variable properties

Definition at line 254 of file VariableBuildInfo.cc.

References m_item_family_name, m_item_group_name, m_mesh_name, m_name, m_property, and m_sub_domain.

◆ VariableBuildInfo() [17/17]

Arcane::VariableBuildInfo::VariableBuildInfo ( const NullTag & )

explicitprivate

Definition at line 272 of file VariableBuildInfo.cc.

Member Function Documentation

◆ _init()

void Arcane::VariableBuildInfo::_init ( )

private

Definition at line 282 of file VariableBuildInfo.cc.

◆ _subDomain()

ISubDomain * Arcane::VariableBuildInfo::_subDomain ( ) const

inlineprivate

Definition at line 288 of file VariableBuildInfo.h.

◆ dataFactoryMng()

IDataFactoryMng * Arcane::VariableBuildInfo::dataFactoryMng ( ) const

Definition at line 303 of file VariableBuildInfo.cc.

◆ isNull()

bool Arcane::VariableBuildInfo::isNull ( ) const

inline

Definition at line 271 of file VariableBuildInfo.h.

◆ itemFamilyName()

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

inline

Definition at line 267 of file VariableBuildInfo.h.

◆ itemGroupName()

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

inline

Definition at line 268 of file VariableBuildInfo.h.

◆ mesh()

IMesh * Arcane::VariableBuildInfo::mesh ( ) const

inline

Definition at line 264 of file VariableBuildInfo.h.

◆ meshHandle()

const MeshHandle & Arcane::VariableBuildInfo::meshHandle ( ) const

inline

Definition at line 265 of file VariableBuildInfo.h.

◆ meshName()

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

inline

Definition at line 269 of file VariableBuildInfo.h.

◆ module()

IModule * Arcane::VariableBuildInfo::module ( ) const

inline

Definition at line 263 of file VariableBuildInfo.h.

◆ name()

const String & Arcane::VariableBuildInfo::name ( ) const

inline

Definition at line 266 of file VariableBuildInfo.h.

◆ property()

int Arcane::VariableBuildInfo::property ( ) const

inline

Definition at line 270 of file VariableBuildInfo.h.

◆ subDomain()

ISubDomain * Arcane::VariableBuildInfo::subDomain ( ) const

inline

Definition at line 256 of file VariableBuildInfo.h.

◆ traceMng()

ITraceMng * Arcane::VariableBuildInfo::traceMng ( ) const

Definition at line 313 of file VariableBuildInfo.cc.

◆ variableMng()

IVariableMng * Arcane::VariableBuildInfo::variableMng ( ) const

Definition at line 293 of file VariableBuildInfo.cc.

◆ NullVariableBuildInfo

friend class NullVariableBuildInfo

friend

Definition at line 48 of file VariableBuildInfo.h.

◆ VariablePrivate

friend class VariablePrivate

friend

Definition at line 50 of file VariableBuildInfo.h.

Member Data Documentation

◆ m_is_null

bool Arcane::VariableBuildInfo::m_is_null = false

private

Definition at line 283 of file VariableBuildInfo.h.

◆ m_item_family_name

String Arcane::VariableBuildInfo::m_item_family_name

private

Entity family name.

Definition at line 279 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_item_group_name

String Arcane::VariableBuildInfo::m_item_group_name

private

Supported entity group name.

Definition at line 280 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_mesh_handle

MeshHandle Arcane::VariableBuildInfo::m_mesh_handle

private

Handle on the mesh.

Definition at line 277 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_mesh_name

String Arcane::VariableBuildInfo::m_mesh_name

private

Name of the mesh associated with the variable.

Definition at line 281 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_module

IModule* Arcane::VariableBuildInfo::m_module = nullptr

private

Module associated with the variable.

Definition at line 276 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_name

String Arcane::VariableBuildInfo::m_name

private

Variable name.

Definition at line 278 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_property

int Arcane::VariableBuildInfo::m_property = 0

private

Variable properties.

Definition at line 282 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

◆ m_sub_domain

ISubDomain* Arcane::VariableBuildInfo::m_sub_domain = nullptr

private

Subdomain manager.

Definition at line 275 of file VariableBuildInfo.h.

Referenced by VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), VariableBuildInfo(), and VariableBuildInfo().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ VariableBuildInfo() [1/17]

◆ VariableBuildInfo() [2/17]

◆ VariableBuildInfo() [3/17]

◆ VariableBuildInfo() [4/17]

◆ VariableBuildInfo() [5/17]

◆ VariableBuildInfo() [6/17]

◆ VariableBuildInfo() [7/17]

◆ VariableBuildInfo() [8/17]

◆ VariableBuildInfo() [9/17]

◆ VariableBuildInfo() [10/17]

◆ VariableBuildInfo() [11/17]

◆ VariableBuildInfo() [12/17]

◆ VariableBuildInfo() [13/17]

◆ VariableBuildInfo() [14/17]

◆ VariableBuildInfo() [15/17]

◆ VariableBuildInfo() [16/17]

◆ VariableBuildInfo() [17/17]

Member Function Documentation

◆ _init()

◆ _subDomain()

◆ dataFactoryMng()

◆ isNull()

◆ itemFamilyName()

◆ itemGroupName()

◆ mesh()

◆ meshHandle()

◆ meshName()

◆ module()

◆ name()

◆ property()

◆ subDomain()

◆ traceMng()

◆ variableMng()

Friends And Related Symbol Documentation

◆ NullVariableBuildInfo

◆ VariablePrivate

Member Data Documentation

◆ m_is_null

◆ m_item_family_name

◆ m_item_group_name

◆ m_mesh_handle

◆ m_mesh_name

◆ m_module

◆ m_name

◆ m_property

◆ m_sub_domain