Arcane::IModuleMaster Class Reference

Interface of the main module. More...

#include <arcane/core/IModuleMaster.h>

Inheritance diagram for Arcane::IModuleMaster:

Collaboration diagram for Arcane::IModuleMaster:

Public Member Functions
virtual	~IModuleMaster ()
	Destructor.
virtual CaseOptionsMain *	caseoptions ()=0
	Returns the options of this module.
virtual IModule *	toModule ()=0
	Conversion to standard module.
virtual CommonVariables *	commonVariables ()=0
	Access to 'common' variables shared between all services and modules.
virtual void	addTimeLoopService (ITimeLoopService *tls)=0
	Adds the time loop service.
virtual void	dumpStandardCurves ()=0
	Outputs the standard curves.

Static Public Member Functions
static IModuleMaster *	createDefault (const ModuleBuildInfo &)
	Creation of an instance of IModuleMaster.

Detailed Description

Interface of the main module.

The main module is the module framing the different actions of the entry points. See the ModuleMaster implementation for more details.

Definition at line 35 of file IModuleMaster.h.

Constructor & Destructor Documentation

~IModuleMaster()

virtual Arcane::IModuleMaster::~IModuleMaster ( )

inlinevirtual

Destructor.

Frees the resources

Definition at line 41 of file IModuleMaster.h.

Member Function Documentation

addTimeLoopService()

virtual void Arcane::IModuleMaster::addTimeLoopService ( ITimeLoopService * tls )

pure virtual

Adds the time loop service.

Implemented in Arcane::ModuleMaster.

Referenced by Arcane::MasterModule::masterBuild().

Here is the caller graph for this function:

caseoptions()

virtual CaseOptionsMain * Arcane::IModuleMaster::caseoptions ( )

pure virtual

Returns the options of this module.

Implemented in Arcane::ModuleMaster.

commonVariables()

virtual CommonVariables * Arcane::IModuleMaster::commonVariables ( )

pure virtual

Access to 'common' variables shared between all services and modules.

Implemented in Arcane::ModuleMaster.

createDefault()

IModuleMaster * Arcane::IModuleMaster::createDefault ( const ModuleBuildInfo & )

static

Creation of an instance of IModuleMaster.

Currently implemented in ModuleMaster

dumpStandardCurves()

virtual void Arcane::IModuleMaster::dumpStandardCurves ( )

pure virtual

Outputs the standard curves.

This call adds the standard curves to the ITimeHistoryMng (such as CPUTime, ElapsedTime, TotalMemory, ...) for the current iteration. By default, if this function is not called, the outputs occur at the end of the iteration.

Implemented in Arcane::ModuleMaster.

toModule()

virtual IModule * Arcane::IModuleMaster::toModule ( )

pure virtual

Conversion to standard module.

The success of the conversion is linked to the implementation of IModuleMaster as IModule

Implemented in Arcane::ModuleMaster.

---

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

• IModuleMaster.h