Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ISession Class Referenceabstract

Interface for a case execution session. More...

#include <arcane/core/ISession.h>

Inheritance diagram for Arcane::ISession:
Collaboration diagram for Arcane::ISession:

Public Member Functions

virtual ~ISession ()=default
 Frees resources.
virtual IApplicationapplication () const =0
 Application.
virtual ISubDomaincreateSubDomain (const SubDomainBuildInfo &sdbi)=0
 Creates a sub-domain with the parameters contained in sdbi.
virtual void endSession (int ret_val)=0
 Ends the session with the return code ret_val.
virtual SubDomainCollection subDomains ()=0
 List of sub-domains of the session.
virtual void doAbort ()=0
 Performs an abort.
virtual bool checkIsValidCaseVersion (const String &version)=0
 Checks if the dataset version version is valid.
virtual void writeExecInfoFile ()=0
 Writes the execution information file.
Public Member Functions inherited from Arcane::IBase
virtual ~IBase ()=default
 Frees resources.
virtual void build ()=0
 Constructs the instance 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 IBaseobjectParent () const =0
 Parent of this object.
virtual String objectNamespaceURI () const =0
 Namespace of the object.
virtual String objectLocalName () const =0
 Local name of the object.
virtual VersionInfo objectVersion () const =0
 Service version number.
virtual ITraceMngtraceMng () const =0
 Trace manager.
virtual IRessourceMngressourceMng () const =0
 Resource manager.
virtual IServiceMngserviceMng () const =0
 Service manager.

Detailed Description

Interface for a case execution session.

A session manages the execution of a case in a process.

This execution can be distributed across multiple sub-domains using multi-threading.

Definition at line 36 of file ISession.h.

Member Function Documentation

◆ application()

virtual IApplication * Arcane::ISession::application ( ) const
pure virtual

Application.

Implemented in Arcane::Session.

Referenced by Arcane::ServiceLoader::loadSessionServices().

Here is the caller graph for this function:

◆ checkIsValidCaseVersion()

virtual bool Arcane::ISession::checkIsValidCaseVersion ( const String & version)
pure virtual

Checks if the dataset version version is valid.

Return values
trueif the version is valid
falseotherwise

Implemented in Arcane::Session.

◆ createSubDomain()

virtual ISubDomain * Arcane::ISession::createSubDomain ( const SubDomainBuildInfo & sdbi)
pure virtual

Creates a sub-domain with the parameters contained in sdbi.

The created sub-domain is added to the list of sub-domains of the session. The document containing the dataset is opened and its XML validity is checked, but the options of the services and modules are not read.

Implemented in Arcane::Session.

Referenced by Arcane::CodeService::createAndLoadCase(), Arcane::InternalInfosDumper::dumpArcaneDatabase(), and Arcane::InternalInfosDumper::dumpInternalAllInfos().

Here is the caller graph for this function:

◆ doAbort()

virtual void Arcane::ISession::doAbort ( )
pure virtual

Performs an abort.

Implemented in Arcane::Session.

◆ endSession()

virtual void Arcane::ISession::endSession ( int ret_val)
pure virtual

Ends the session with the return code ret_val.

Implemented in Arcane::ArcaneSession, and Arcane::Session.

◆ subDomains()

virtual SubDomainCollection Arcane::ISession::subDomains ( )
pure virtual

List of sub-domains of the session.

Implemented in Arcane::Session.

◆ writeExecInfoFile()

virtual void Arcane::ISession::writeExecInfoFile ( )
pure virtual

Writes the execution information file.

Implemented in Arcane::ArcaneSession, and Arcane::Session.

Referenced by Arcane::ArcaneCodeService::initCase().

Here is the caller graph for this function:

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