Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::IArcaneMain Class Referenceabstract

Public Member Functions

virtual ~IArcaneMain ()
 Releases resources.
virtual void build ()=0
 Constructs the class members. The instance is not usable until this method has been called. This method must be called before initialize().
virtual void initialize ()=0
 Initializes the instance. The instance is not usable until this method has been called.
virtual bool parseArgs (StringList args)=0
 Parses arguments.
virtual int execute ()=0
 Starts execution. This method only returns when the program exits.
virtual void finalize ()=0
 Performs the last operations before instance destruction.
virtual int errorCode () const =0
 Execution error code.
virtual void setErrorCode (int errcode)=0
 Sets the return code.
virtual void doAbort ()=0
 Performs an abort.
virtual const ApplicationInfoapplicationInfo () const =0
 Executable information.
virtual const ApplicationBuildInfoapplicationBuildInfo () const =0
 Information to build the IApplication instance.
virtual const DotNetRuntimeInitialisationInfodotnetRuntimeInitialisationInfo () const =0
 .Net runtime initialization information.
virtual const AcceleratorRuntimeInitialisationInfoacceleratorRuntimeInitialisationInfo () const =0
 Runtime initialization information for accelerators.
virtual IMainFactorymainFactory () const =0
 Main factory.
virtual IApplicationapplication () const =0
 Application.
virtual bool hasGarbageCollector () const =0
 Indicates that certain objects are managed via a garbage collector.
virtual ServiceFactoryInfoCollection registeredServiceFactoryInfos ()=0
 List of registered service factories.
virtual ModuleFactoryInfoCollection registeredModuleFactoryInfos ()=0
 List of registered module factories.
virtual void setDirectExecuteFunctor (IDirectSubDomainExecuteFunctor *f)=0

Static Public Member Functions

static IArcaneMainarcaneMain ()
static void setArcaneMain (IArcaneMain *arcane_main)

Detailed Description

Definition at line 54 of file IArcaneMain.h.

Constructor & Destructor Documentation

◆ ~IArcaneMain()

virtual Arcane::IArcaneMain::~IArcaneMain ( )
inlinevirtual

Releases resources.

Definition at line 59 of file IArcaneMain.h.

Member Function Documentation

◆ arcaneMain()

IArcaneMain * Arcane::IArcaneMain::arcaneMain ( )
static

Retrieves the global instance.

Warning
The global instance is only available during the call to ArcaneMain::arcaneMain().

Definition at line 165 of file InterfaceImpl.cc.

◆ build()

virtual void Arcane::IArcaneMain::build ( )
pure virtual

Constructs the class members. The instance is not usable until this method has been called. This method must be called before initialize().

Warning
This method must only be called once.

◆ execute()

virtual int Arcane::IArcaneMain::execute ( )
pure virtual

Starts execution. This method only returns when the program exits.

Returns
the Arcane return code, 0 if everything is okay.

◆ initialize()

virtual void Arcane::IArcaneMain::initialize ( )
pure virtual

Initializes the instance. The instance is not usable until this method has been called.

Warning
This method must only be called once.

◆ parseArgs()

virtual bool Arcane::IArcaneMain::parseArgs ( StringList args)
pure virtual

Parses arguments.

Recognized arguments must be removed from the list.

Return values
trueif execution must stop,
falseif it continues normally

◆ setArcaneMain()

void Arcane::IArcaneMain::setArcaneMain ( IArcaneMain * arcane_main)
static

Definition at line 174 of file InterfaceImpl.cc.


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