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

Application interface. More...

#include <arcane/core/IApplication.h>

Inheritance diagram for Arcane::IApplication:
Collaboration diagram for Arcane::IApplication:

Public Member Functions

virtual IParallelSuperMng * parallelSuperMng ()=0
 Supervisory parallelism manager.
virtual IParallelSuperMng * sequentialParallelSuperMng ()=0
 Sequential parallelism supervisor manager.
virtual IIOMng * ioMng ()=0
 Input/output manager.
virtual IConfigurationMng * configurationMng () const =0
 Execution configuration manager.
virtual IDataFactory * dataFactory ()=0
 Data factory.
virtual IDataFactoryMng * dataFactoryMng () const =0
 Data factory.
virtual const ApplicationInfo & applicationInfo () const =0
 Executable information.
virtual const ApplicationBuildInfo & applicationBuildInfo () const =0
 Instance build parameter information.
virtual const DotNetRuntimeInitialisationInfo & dotnetRuntimeInitialisationInfo () const =0
 '.Net' runtime initialization information.
virtual const AcceleratorRuntimeInitialisationInfo & acceleratorRuntimeInitialisationInfo () const =0
 Runtime initialization information for accelerators.
virtual String versionStr () const =0
 Application version number.
virtual String mainVersionStr () const =0
 Main application version number (without beta).
virtual String majorAndMinorVersionStr () const =0
 Major and minor version number in M.m format.
virtual String targetinfoStr () const =0
 Application compilation options information.
virtual String codeName () const =0
 Code name.
virtual String applicationName () const =0
 Application name.
virtual String userName () const =0
 User name.
virtual ByteConstSpan configBuffer () const =0
virtual ByteConstSpan userConfigBuffer () const =0
virtual String userConfigPath () const =0
 User configuration directory path.
virtual void addSession (ISession *session)=0
 Adds the session session.
virtual void removeSession (ISession *session)=0
 Removes the session session.
virtual SessionCollection sessions ()=0
 List of sessions.
virtual IMainFactory * mainFactory () const =0
 Main factory.
virtual ModuleFactoryInfoCollection moduleFactoryInfos ()=0
 List of module factory information.
virtual ServiceFactory2Collection serviceFactories2 ()=0
 List of service factories.
virtual Ref< ICodeService > getCodeService (const String &file_name)=0
 Returns the case loader corresponding to the file given by file_name.
virtual bool hasGarbageCollector () const =0
 Indicates that certain objects are managed via a garbage collector.
virtual IPhysicalUnitSystemService * getPhysicalUnitSystemService ()=0
 Service managing physical unit systems.
virtual ITraceMngPolicy * getTraceMngPolicy ()=0
 Trace manager configuration policy.
virtual ITraceMng * createAndInitializeTraceMng (ITraceMng *parent_trace, const String &file_suffix)=0
 Creates and initializes an instance of ITraceMng.
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 IBase * objectParent () 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 ITraceMng * traceMng () const =0
 Trace manager.
virtual IRessourceMng * ressourceMng () const =0
 Resource manager.
virtual IServiceMng * serviceMng () const =0
 Service manager.

Detailed Description

Application interface.

This class contains information about the executable configuration.

There is only one instance of this class per process (singleton).

Definition at line 56 of file IApplication.h.

Member Function Documentation

◆ acceleratorRuntimeInitialisationInfo()

virtual const AcceleratorRuntimeInitialisationInfo & Arcane::IApplication::acceleratorRuntimeInitialisationInfo ( ) const
pure virtual

Runtime initialization information for accelerators.

Implemented in Arcane::Application.

References acceleratorRuntimeInitialisationInfo().

Referenced by acceleratorRuntimeInitialisationInfo(), and Arcane::SubDomain::initialize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addSession()

virtual void Arcane::IApplication::addSession ( ISession * session)
pure virtual

Adds the session session.

Implemented in Arcane::Application.

References addSession().

Referenced by addSession().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ applicationBuildInfo()

virtual const ApplicationBuildInfo & Arcane::IApplication::applicationBuildInfo ( ) const
pure virtual

Instance build parameter information.

Implemented in Arcane::Application.

References applicationBuildInfo().

Referenced by applicationBuildInfo(), and Arcane::MessagePassing::HybridParallelSuperMng::build().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ applicationInfo()

virtual const ApplicationInfo & Arcane::IApplication::applicationInfo ( ) const
pure virtual

Executable information.

Implemented in Arcane::Application.

References applicationInfo().

Referenced by applicationInfo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ applicationName()

virtual String Arcane::IApplication::applicationName ( ) const
pure virtual

Application name.

Implemented in Arcane::Application.

References applicationName().

Referenced by applicationName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ codeName()

virtual String Arcane::IApplication::codeName ( ) const
pure virtual

Code name.

Implemented in Arcane::Application.

References codeName().

Referenced by codeName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ configurationMng()

virtual IConfigurationMng * Arcane::IApplication::configurationMng ( ) const
pure virtual

Execution configuration manager.

Implemented in Arcane::Application.

◆ createAndInitializeTraceMng()

virtual ITraceMng * Arcane::IApplication::createAndInitializeTraceMng ( ITraceMng * parent_trace,
const String & file_suffix )
pure virtual

Creates and initializes an instance of ITraceMng.

The created instance is initialized according to the policy specified by getTraceMngPolicy(). If file outputs are enabled, the created instance will output its information into a file suffixed by file_suffix.

The verbosity properties of the created instance are inherited from parent_trace if it is not null.

Implemented in Arcane::Application.

References createAndInitializeTraceMng().

Referenced by createAndInitializeTraceMng().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dataFactory()

virtual IDataFactory * Arcane::IApplication::dataFactory ( )
pure virtual

Data factory.

Implemented in Arcane::Application.

References dataFactory().

Referenced by dataFactory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dataFactoryMng()

virtual IDataFactoryMng * Arcane::IApplication::dataFactoryMng ( ) const
pure virtual

Data factory.

Implemented in Arcane::Application.

References dataFactoryMng().

Referenced by dataFactoryMng().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dotnetRuntimeInitialisationInfo()

virtual const DotNetRuntimeInitialisationInfo & Arcane::IApplication::dotnetRuntimeInitialisationInfo ( ) const
pure virtual

'.Net' runtime initialization information.

Implemented in Arcane::Application.

References dotnetRuntimeInitialisationInfo().

Referenced by dotnetRuntimeInitialisationInfo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCodeService()

virtual Ref< ICodeService > Arcane::IApplication::getCodeService ( const String & file_name)
pure virtual

Returns the case loader corresponding to the file given by file_name.

Implemented in Arcane::Application.

References getCodeService().

Referenced by getCodeService().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getPhysicalUnitSystemService()

virtual IPhysicalUnitSystemService * Arcane::IApplication::getPhysicalUnitSystemService ( )
pure virtual

Service managing physical unit systems.

Implemented in Arcane::Application.

References getPhysicalUnitSystemService().

Referenced by getPhysicalUnitSystemService().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getTraceMngPolicy()

virtual ITraceMngPolicy * Arcane::IApplication::getTraceMngPolicy ( )
pure virtual

Trace manager configuration policy.

Implemented in Arcane::Application.

References getTraceMngPolicy().

Referenced by getTraceMngPolicy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ hasGarbageCollector()

virtual bool Arcane::IApplication::hasGarbageCollector ( ) const
pure virtual

Indicates that certain objects are managed via a garbage collector.

Implemented in Arcane::Application.

References hasGarbageCollector().

Referenced by hasGarbageCollector().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ioMng()

virtual IIOMng * Arcane::IApplication::ioMng ( )
pure virtual

Input/output manager.

Implemented in Arcane::Application.

Referenced by Arcane::InternalInfosDumper::dumpArcaneDatabase(), and Arcane::ManualHdf5VariableWriter::notifyEndWrite().

Here is the caller graph for this function:

◆ mainFactory()

virtual IMainFactory * Arcane::IApplication::mainFactory ( ) const
pure virtual

Main factory.

Implemented in Arcane::Application.

References mainFactory().

Referenced by Arcane::TimeLoopMng::createTimeLoop(), and mainFactory().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ mainVersionStr()

virtual String Arcane::IApplication::mainVersionStr ( ) const
pure virtual

Main application version number (without beta).

Implemented in Arcane::Application.

References mainVersionStr().

Referenced by mainVersionStr().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ majorAndMinorVersionStr()

virtual String Arcane::IApplication::majorAndMinorVersionStr ( ) const
pure virtual

Major and minor version number in M.m format.

Implemented in Arcane::Application.

References majorAndMinorVersionStr().

Referenced by majorAndMinorVersionStr().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ moduleFactoryInfos()

virtual ModuleFactoryInfoCollection Arcane::IApplication::moduleFactoryInfos ( )
pure virtual

List of module factory information.

Implemented in Arcane::Application.

References moduleFactoryInfos().

Referenced by Arcane::ServiceLoader::initializeModuleFactories(), Arcane::ServiceLoader::loadModules(), and moduleFactoryInfos().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parallelSuperMng()

virtual IParallelSuperMng * Arcane::IApplication::parallelSuperMng ( )
pure virtual

Supervisory parallelism manager.

Implemented in Arcane::Application.

Referenced by Arcane::ArcaneMain::callFunctorWithCatchedException(), Arcane::MainFactory::createIOMng(), Arcane::Session::createSubDomain(), Arcane::ArcaneMainBatch::doAbort(), Arcane::InternalInfosDumper::dumpArcaneDatabase(), Arcane::ArcaneMainExecInfo::initialize(), and Arcane::CaseMng::readCaseDocument().

Here is the caller graph for this function:

◆ removeSession()

virtual void Arcane::IApplication::removeSession ( ISession * session)
pure virtual

Removes the session session.

Implemented in Arcane::Application.

References removeSession().

Referenced by removeSession().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ sequentialParallelSuperMng()

virtual IParallelSuperMng * Arcane::IApplication::sequentialParallelSuperMng ( )
pure virtual

Sequential parallelism supervisor manager.

Implemented in Arcane::Application.

◆ serviceFactories2()

virtual ServiceFactory2Collection Arcane::IApplication::serviceFactories2 ( )
pure virtual

List of service factories.

Implemented in Arcane::Application.

References serviceFactories2().

Referenced by Arcane::ServiceLoader::_loadServices(), Arcane::ServiceLoader::loadSingletonService(), and serviceFactories2().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ sessions()

virtual SessionCollection Arcane::IApplication::sessions ( )
pure virtual

List of sessions.

Implemented in Arcane::Application.

References sessions().

Referenced by sessions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ targetinfoStr()

virtual String Arcane::IApplication::targetinfoStr ( ) const
pure virtual

Application compilation options information.

Implemented in Arcane::Application.

References targetinfoStr().

Referenced by targetinfoStr().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ userConfigPath()

virtual String Arcane::IApplication::userConfigPath ( ) const
pure virtual

User configuration directory path.

Implemented in Arcane::Application.

References userConfigPath().

Referenced by userConfigPath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ userName()

virtual String Arcane::IApplication::userName ( ) const
pure virtual

User name.

Implemented in Arcane::Application.

References userName().

Referenced by userName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ versionStr()

virtual String Arcane::IApplication::versionStr ( ) const
pure virtual

Application version number.

Implemented in Arcane::Application.

References versionStr().

Referenced by versionStr().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following file: