Référence de la classe Arcane::VariableSynchronizerEventArgs

Arguments de l'évènement notifiant une synchronisation de variables. Plus de détails...

#include <arcane/core/VariableSynchronizerEventArgs.h>

Graphe de collaboration de Arcane::VariableSynchronizerEventArgs:

Types publics
enum class	State { BeginSynchronize , EndSynchronize }
	Enum pour savoir si on est au début ou à la fin de la synchronisation. Plus de détails...
enum class	CompareStatus { Unknown , Same , Different }
	Comparaison des valeurs des entités fantômes avant/après une synchronisation. Plus de détails...

Fonctions membres publiques
	VariableSynchronizerEventArgs (VariableCollection vars, IVariableSynchronizer *vs, Real elapsed_time, State state=State::EndSynchronize)
	VariableSynchronizerEventArgs (IVariable *var, IVariableSynchronizer *vs, Real elapsed_time, State state=State::EndSynchronize)
	VariableSynchronizerEventArgs (VariableCollection vars, IVariableSynchronizer *vs)
	VariableSynchronizerEventArgs (IVariable *var, IVariableSynchronizer *vs)
	VariableSynchronizerEventArgs (IVariableSynchronizer *vs)
void	initialize (const VariableCollection &vars)
void	initialize (IVariable *var)
IVariableSynchronizer *	synchronizer () const
	Synchroniseur associé.
ConstArrayView< IVariable * >	variables () const
	Liste des variables synchronisées.
ConstArrayView< CompareStatus >	compareStatusList () const
	Liste de l'état de comparaison.
void	setCompareStatus (Int32 i, CompareStatus v)
	Positionne l'état de comparaison de la i-ème variable.
Real	elapsedTime () const
	Temps passé dans la synchronisation.
void	setElapsedTime (Real v)
State	state () const
	Indicateur du moment de l'évènement.
void	setState (State v)

Description détaillée

Arguments de l'évènement notifiant une synchronisation de variables.

Les instances de cette classe peuvent être utilisées plusieurs fois. Il faut appeler initialize() pour initialiser ou réinitialiser l'instance avec les valeurs par défaut.

Définition à la ligne 39 du fichier VariableSynchronizerEventArgs.h.

Documentation des énumérations membres

CompareStatus

enum class Arcane::VariableSynchronizerEventArgs::CompareStatus

strong

Comparaison des valeurs des entités fantômes avant/après une synchronisation.

Valeurs énumérées
Unknown	Pas de comparaison ou résultat inconnue.
Same	Même valeurs avant et après la synchronisation.
Different	Valeurs différentes avant et après la synchronisation.

Définition à la ligne 51 du fichier VariableSynchronizerEventArgs.h.

State

enum class Arcane::VariableSynchronizerEventArgs::State

strong

Enum pour savoir si on est au début ou à la fin de la synchronisation.

Définition à la ligne 44 du fichier VariableSynchronizerEventArgs.h.

Documentation des constructeurs et destructeur

VariableSynchronizerEventArgs() [1/5]

Arcane::VariableSynchronizerEventArgs::VariableSynchronizerEventArgs	(	VariableCollection	vars,
		IVariableSynchronizer *	vs,
		Real	elapsed_time,
		State	state = State::EndSynchronize
	)

Définition à la ligne 39 du fichier VariableSynchronizerEventArgs.cc.

VariableSynchronizerEventArgs() [2/5]

Arcane::VariableSynchronizerEventArgs::VariableSynchronizerEventArgs	(	IVariable *	var,
		IVariableSynchronizer *	vs,
		Real	elapsed_time,
		State	state = State::EndSynchronize
	)

Définition à la ligne 26 du fichier VariableSynchronizerEventArgs.cc.

VariableSynchronizerEventArgs() [3/5]

Arcane::VariableSynchronizerEventArgs::VariableSynchronizerEventArgs	(	VariableCollection	vars,
		IVariableSynchronizer *	vs
	)

Définition à la ligne 62 du fichier VariableSynchronizerEventArgs.cc.

VariableSynchronizerEventArgs() [4/5]

Arcane::VariableSynchronizerEventArgs::VariableSynchronizerEventArgs	(	IVariable *	var,
		IVariableSynchronizer *	vs
	)

Définition à la ligne 52 du fichier VariableSynchronizerEventArgs.cc.

VariableSynchronizerEventArgs() [5/5]

Arcane::VariableSynchronizerEventArgs::VariableSynchronizerEventArgs ( IVariableSynchronizer *  vs )

inline

Définition à la ligne 76 du fichier VariableSynchronizerEventArgs.h.

Documentation des fonctions membres

compareStatusList()

ConstArrayView< CompareStatus > Arcane::VariableSynchronizerEventArgs::compareStatusList ( ) const

inline

Liste de l'état de comparaison.

La valeur du i-ème élément de compareStatus() indique l'état de comparaison pour la i-ème variable de variables().

Cette liste n'est valide que pour les évènements de fin de synchronisation (state()==State::EndSynchronize).

Définition à la ligne 100 du fichier VariableSynchronizerEventArgs.h.

elapsedTime()

Real Arcane::VariableSynchronizerEventArgs::elapsedTime ( ) const

inline

Temps passé dans la synchronisation.

Définition à la ligne 106 du fichier VariableSynchronizerEventArgs.h.

initialize() [1/2]

void Arcane::VariableSynchronizerEventArgs::initialize

(

const VariableCollection &

vars

)

Définition à la ligne 82 du fichier VariableSynchronizerEventArgs.cc.

initialize() [2/2]

void Arcane::VariableSynchronizerEventArgs::initialize

(

IVariable *

var

)

Définition à la ligne 97 du fichier VariableSynchronizerEventArgs.cc.

setCompareStatus()

void Arcane::VariableSynchronizerEventArgs::setCompareStatus ( Int32  i, CompareStatus  v  )

inline

Positionne l'état de comparaison de la i-ème variable.

Définition à la ligne 103 du fichier VariableSynchronizerEventArgs.h.

setElapsedTime()

void Arcane::VariableSynchronizerEventArgs::setElapsedTime ( Real  v )

inline

Définition à la ligne 107 du fichier VariableSynchronizerEventArgs.h.

setState()

void Arcane::VariableSynchronizerEventArgs::setState ( State  v )

inline

Définition à la ligne 111 du fichier VariableSynchronizerEventArgs.h.

state()

State Arcane::VariableSynchronizerEventArgs::state ( ) const

inline

Indicateur du moment de l'évènement.

Définition à la ligne 110 du fichier VariableSynchronizerEventArgs.h.

synchronizer()

IVariableSynchronizer * Arcane::VariableSynchronizerEventArgs::synchronizer ( ) const

inline

Synchroniseur associé.

Définition à la ligne 86 du fichier VariableSynchronizerEventArgs.h.

variables()

ConstArrayView< IVariable * > Arcane::VariableSynchronizerEventArgs::variables

(

)

const

Liste des variables synchronisées.

Définition à la ligne 73 du fichier VariableSynchronizerEventArgs.cc.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• VariableSynchronizerEventArgs.h
• VariableSynchronizerEventArgs.cc