Arcane::ICodeService Class Reference

Interface of a case loader. More...

#include <arcane/core/ICodeService.h>

Inheritance diagram for Arcane::ICodeService:

Collaboration diagram for Arcane::ICodeService:

Public Member Functions
	~ICodeService ()=default
	Frees resources.
virtual ISession *	createSession ()=0
	Creates a session.
virtual bool	parseArgs (StringList &args)=0
	Parses the command line arguments.
virtual ISubDomain *	createAndLoadCase (ISession *session, const SubDomainBuildInfo &sdbi)=0
	Creates and loads the case using the info sdbi for the session session.
virtual void	initCase (ISubDomain *sub_domain, bool is_continue)=0
	Initializes the session session.
virtual bool	allowExecution () const =0
	Returns whether the code allows execution.
virtual StringCollection	validExtensions () const =0
	Returns the list of file extensions processed by the instance. The extension does not include the '.'.
virtual Real ARCANE_DEPRECATED	lengthUnit () const =0
	Length unit used by the code.
Public Member Functions inherited from Arcane::IService
virtual	~IService ()
	Releases resources.
virtual IBase *	serviceParent () const =0
	Parent of this service.
virtual IService *	serviceInterface ()=0
	Interface of this service (normally this).
virtual IServiceInfo *	serviceInfo () const =0
	Service information.

Additional Inherited Members
Protected Member Functions inherited from Arcane::IService
	IService ()
	Constructor.

Detailed Description

Interface of a case loader.

Definition at line 33 of file ICodeService.h.

Member Function Documentation

allowExecution()

virtual bool Arcane::ICodeService::allowExecution ( ) const

pure virtual

Returns whether the code allows execution.

Implemented in Arcane::CodeService.

createAndLoadCase()

virtual ISubDomain * Arcane::ICodeService::createAndLoadCase ( ISession * session, const SubDomainBuildInfo & sdbi )

pure virtual

Creates and loads the case using the info sdbi for the session session.

Implemented in Arcane::CodeService.

createSession()

virtual ISession * Arcane::ICodeService::createSession ( )

pure virtual

Creates a session.

The instance must call IApplication::addSession().

Implemented in Arcane::ArcaneCodeService, and Arcane::ArcaneCodeService.

initCase()

virtual void Arcane::ICodeService::initCase ( ISubDomain * sub_domain, bool is_continue )

pure virtual

Initializes the session session.

Parameters

is_continue

indicates if we are resuming The case must already have been loaded by loadCase()

Implemented in Arcane::ArcaneCodeService, Arcane::ArcaneCodeService, and Arcane::CodeService.

lengthUnit()

virtual Real ARCANE_DEPRECATED Arcane::ICodeService::lengthUnit ( ) const

pure virtual

Length unit used by the code.

This must be 1.0 if the code uses the international system and thus the meter as the length unit. If the unit is the centimeter, for example, the value is 0.01.

This value can be used, for example, when reading the mesh if the mesh format supports the notion of length unit.

Implemented in Arcane::CodeService.

parseArgs()

virtual bool Arcane::ICodeService::parseArgs ( StringList & args )

pure virtual

Parses the command line arguments.

The array args only contains arguments that have not been interpreted by Arcane.

Recognized arguments must be removed from the list.

Return values

true	if the execution must stop,
false	if it continues normally

Implemented in Arcane::ArcaneCodeService, Arcane::ArcaneCodeService, and Arcane::CodeService.

validExtensions()

virtual StringCollection Arcane::ICodeService::validExtensions ( ) const

pure virtual

Returns the list of file extensions processed by the instance. The extension does not include the '.'.

Implemented in Arcane::CodeService.

---

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

• ICodeService.h