Interface d'une boucle en temps. Plus de détails...

#include <arcane/core/ITimeLoop.h>

Graphe d'héritage de Arcane::ITimeLoop:

Graphe de collaboration de Arcane::ITimeLoop:

Point d'appel
Endroit ou est utilisé le point d'entrée.
static const char *	WComputeLoop = "compute-loop"
	appelé pendant la boucle de calcul

static const char *	WBuild = "build"
	appelé lors de la lecture du jeu de données

static const char *	WInit = "init"
	appelé pendant l'initialisation, l'initialisation d'une reprise ou d'un nouveau cas

static const char *	WRestore = "restore"
	appelé pour restaurer les variables lors d'un retour arrière

static const char *	WOnMeshChanged = "on-mesh-changed"
	appelé après un changement de maillage

static const char *	WOnMeshRefinement = "on-mesh-refinement"
	appelé après un raffinement de maillage

static const char *	WExit = "exit"
	appelé lors de la terminaison du code.

virtual	~ITimeLoop ()
	Libère les ressources.

virtual void	build ()=0
	Construit la boucle en temps.

virtual IApplication *	application () const =0
	Application.

virtual String	name () const =0
	Nom de la boucle en temps.

virtual String	title () const =0
	Titre de la boucle en temps.

virtual void	setTitle (const String &)=0
	Positionne le titre de la boucle en temps.

virtual String	description () const =0
	Description de la boucle en temps.

virtual void	setDescription (const String &)=0
	Positionne la description de la boucle en temps.

virtual StringCollection	requiredModulesName () const =0
	Liste des noms des modules obligatoires.

virtual void	setRequiredModulesName (const StringCollection &)=0
	Positionne la liste des des modules obligatoires.

virtual StringCollection	optionalModulesName () const =0
	Liste des noms des modules facultatifs.

virtual void	setOptionalModulesName (const StringCollection &)=0
	Positionne la liste des des modules facultatifs.

virtual TimeLoopEntryPointInfoCollection	entryPoints (const String &where) const =0
	Liste des noms des points d'entrée pour le point d'appel where.

virtual void	setEntryPoints (const String &where, const TimeLoopEntryPointInfoCollection &)=0
	Positionne la liste des noms des points d'entrée pour le point d'appel where.

virtual StringCollection	userClasses () const =0
	Liste des classes utilisateurs associées à la boucle en temps.

virtual void	setUserClasses (const StringCollection &)=0
	Retourne la liste des classes associées à la boucle en temps.

virtual TimeLoopSingletonServiceInfoCollection	singletonServices () const =0
	Liste services singletons.

virtual void	setSingletonServices (const TimeLoopSingletonServiceInfoCollection &c)=0
	Positionne la liste des services singletons.

virtual IConfiguration *	configuration ()=0
	Options de configuration.

Description détaillée

Interface d'une boucle en temps.

Définition à la ligne 40 du fichier ITimeLoop.h.

Documentation des constructeurs et destructeur

◆ ~ITimeLoop()

virtual Arcane::ITimeLoop::~ITimeLoop ( )

inlinevirtual

Libère les ressources.

Définition à la ligne 65 du fichier ITimeLoop.h.

Documentation des fonctions membres

◆ application()

virtual IApplication * Arcane::ITimeLoop::application ( ) const

pure virtual

Application.

Implémenté dans Arcane::TimeLoop.

◆ build()

virtual void Arcane::ITimeLoop::build ( )

pure virtual

Construit la boucle en temps.

Implémenté dans Arcane::TimeLoop.

◆ configuration()

virtual IConfiguration * Arcane::ITimeLoop::configuration ( )

pure virtual

Options de configuration.

Implémenté dans Arcane::TimeLoop.

Référencé par Arcane::TimeLoopMng::setUsedTimeLoop().

◆ description()

virtual String Arcane::ITimeLoop::description ( ) const

pure virtual

Description de la boucle en temps.

Implémenté dans Arcane::TimeLoop.

◆ entryPoints()

virtual TimeLoopEntryPointInfoCollection Arcane::ITimeLoop::entryPoints ( const String & where ) const

pure virtual

Liste des noms des points d'entrée pour le point d'appel where.

Implémenté dans Arcane::TimeLoop.

Référencé par Arcane::TimeLoopMng::setUsedTimeLoop().

◆ name()

virtual String Arcane::ITimeLoop::name ( ) const

pure virtual

Nom de la boucle en temps.

Implémenté dans Arcane::TimeLoop.

Référencé par Arcane::InternalInfosDumper::dumpArcaneDatabase(), Arcane::InternalInfosDumper::dumpInternalAllInfos(), et Arcane::TimeLoopMng::registerTimeLoop().

◆ optionalModulesName()

virtual StringCollection Arcane::ITimeLoop::optionalModulesName ( ) const

pure virtual

Liste des noms des modules facultatifs.

Implémenté dans Arcane::TimeLoop.

◆ requiredModulesName()

virtual StringCollection Arcane::ITimeLoop::requiredModulesName ( ) const

pure virtual

Liste des noms des modules obligatoires.

Implémenté dans Arcane::TimeLoop.

◆ setDescription()

virtual void Arcane::ITimeLoop::setDescription ( const String & )

pure virtual

Positionne la description de la boucle en temps.

Implémenté dans Arcane::TimeLoop.

◆ setEntryPoints()

virtual void Arcane::ITimeLoop::setEntryPoints	(	const String &	where,
		const TimeLoopEntryPointInfoCollection &
	)

pure virtual

Positionne la liste des noms des points d'entrée pour le point d'appel where.

Implémenté dans Arcane::TimeLoop.

◆ setOptionalModulesName()

virtual void Arcane::ITimeLoop::setOptionalModulesName ( const StringCollection & )

pure virtual

Positionne la liste des des modules facultatifs.

Implémenté dans Arcane::TimeLoop.

◆ setRequiredModulesName()

virtual void Arcane::ITimeLoop::setRequiredModulesName ( const StringCollection & )

pure virtual

Positionne la liste des des modules obligatoires.

Implémenté dans Arcane::TimeLoop.

◆ setSingletonServices()

virtual void Arcane::ITimeLoop::setSingletonServices ( const TimeLoopSingletonServiceInfoCollection & c )

pure virtual

Positionne la liste des services singletons.

Implémenté dans Arcane::TimeLoop.

◆ setTitle()

virtual void Arcane::ITimeLoop::setTitle ( const String & )

pure virtual

Positionne le titre de la boucle en temps.

Implémenté dans Arcane::TimeLoop.

◆ setUserClasses()

virtual void Arcane::ITimeLoop::setUserClasses ( const StringCollection & )

pure virtual

Retourne la liste des classes associées à la boucle en temps.

Implémenté dans Arcane::TimeLoop.

◆ singletonServices()

virtual TimeLoopSingletonServiceInfoCollection Arcane::ITimeLoop::singletonServices ( ) const

pure virtual

Liste services singletons.

Implémenté dans Arcane::TimeLoop.

◆ title()

virtual String Arcane::ITimeLoop::title ( ) const

pure virtual

Titre de la boucle en temps.

Implémenté dans Arcane::TimeLoop.

◆ userClasses()

virtual StringCollection Arcane::ITimeLoop::userClasses ( ) const

pure virtual

Liste des classes utilisateurs associées à la boucle en temps.

Implémenté dans Arcane::TimeLoop.

Documentation des données membres

◆ WBuild

const char * Arcane::ITimeLoop::WBuild = "build"

static

appelé lors de la lecture du jeu de données

Définition à la ligne 50 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WComputeLoop

const char * Arcane::ITimeLoop::WComputeLoop = "compute-loop"

static

appelé pendant la boucle de calcul

Définition à la ligne 48 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WExit

const char * Arcane::ITimeLoop::WExit = "exit"

static

appelé lors de la terminaison du code.

Définition à la ligne 60 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WInit

const char * Arcane::ITimeLoop::WInit = "init"

static

appelé pendant l'initialisation, l'initialisation d'une reprise ou d'un nouveau cas

Définition à la ligne 52 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WOnMeshChanged

const char * Arcane::ITimeLoop::WOnMeshChanged = "on-mesh-changed"

static

appelé après un changement de maillage

Définition à la ligne 56 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WOnMeshRefinement

const char * Arcane::ITimeLoop::WOnMeshRefinement = "on-mesh-refinement"

static

appelé après un raffinement de maillage

Définition à la ligne 58 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

◆ WRestore

const char * Arcane::ITimeLoop::WRestore = "restore"

static

appelé pour restaurer les variables lors d'un retour arrière

Définition à la ligne 54 du fichier ITimeLoop.h.

Référencé par Arcane::TimeLoopMng::_processEntryPoints(), Arcane::TimeLoopReader::readTimeLoops(), et Arcane::TimeLoopMng::setUsedTimeLoop().

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

Point d'appel

Description détaillée

Documentation des constructeurs et destructeur

◆ ~ITimeLoop()

Documentation des fonctions membres

◆ application()

◆ build()

◆ configuration()

◆ description()

◆ entryPoints()

◆ name()

◆ optionalModulesName()

◆ requiredModulesName()

◆ setDescription()

◆ setEntryPoints()

◆ setOptionalModulesName()

◆ setRequiredModulesName()

◆ setSingletonServices()

◆ setTitle()

◆ setUserClasses()

◆ singletonServices()

◆ title()

◆ userClasses()

Documentation des données membres

◆ WBuild

◆ WComputeLoop

◆ WExit

◆ WInit

◆ WOnMeshChanged

◆ WOnMeshRefinement

◆ WRestore