Parameters necessary for building a variable. More...

#include <arcane/core/VariableBuildInfo.h>

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

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/16]

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.

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

◆ VariableBuildInfo() [2/16]

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.

◆ VariableBuildInfo() [3/16]

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.

◆ VariableBuildInfo() [4/16]

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().

◆ VariableBuildInfo() [5/16]

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.

◆ VariableBuildInfo() [6/16]

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.

◆ VariableBuildInfo() [7/16]

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().

◆ VariableBuildInfo() [8/16]

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.

◆ VariableBuildInfo() [9/16]

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.

◆ VariableBuildInfo() [10/16]

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.

◆ VariableBuildInfo() [11/16]

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.

◆ VariableBuildInfo() [12/16]

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.

◆ VariableBuildInfo() [13/16]

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().

◆ VariableBuildInfo() [14/16]

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.

◆ VariableBuildInfo() [15/16]

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.

◆ VariableBuildInfo() [16/16]

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.

Member Function Documentation

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

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

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ VariableBuildInfo() [1/16]

◆ VariableBuildInfo() [2/16]

◆ VariableBuildInfo() [3/16]

◆ VariableBuildInfo() [4/16]

◆ VariableBuildInfo() [5/16]

◆ VariableBuildInfo() [6/16]

◆ VariableBuildInfo() [7/16]

◆ VariableBuildInfo() [8/16]

◆ VariableBuildInfo() [9/16]

◆ VariableBuildInfo() [10/16]

◆ VariableBuildInfo() [11/16]

◆ VariableBuildInfo() [12/16]

◆ VariableBuildInfo() [13/16]

◆ VariableBuildInfo() [14/16]

◆ VariableBuildInfo() [15/16]

◆ VariableBuildInfo() [16/16]

Member Function Documentation

◆ dataFactoryMng()

◆ isNull()

◆ itemFamilyName()

◆ itemGroupName()

◆ mesh()

◆ meshHandle()

◆ meshName()

◆ module()

◆ name()

◆ property()

◆ subDomain()

◆ traceMng()

◆ variableMng()

Friends And Related Symbol Documentation

◆ NullVariableBuildInfo

◆ VariablePrivate