#include <arcane/impl/Session.h>

Inheritance diagram for Arcane::Session:

Collaboration diagram for Arcane::Session:

Classes
class	Impl
	Session. More...

Public Member Functions
	Session (IApplication *)
virtual void	build ()
	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 ()
	Initializes the instance. The instance is not usable until this method has been called.
virtual IBase *	objectParent () const
	Parent of this object.
virtual String	objectNamespaceURI () const
	Namespace of the object.
virtual String	objectLocalName () const
	Local name of the object.
virtual VersionInfo	objectVersion () const
	Service version number.
virtual IServiceMng *	serviceMng () const
	Service manager.
virtual IRessourceMng *	ressourceMng () const
	Resource manager.
virtual IApplication *	application () const
	Application.
virtual ITraceMng *	traceMng () const
	Trace manager.
virtual const String &	fileName () const
virtual ISubDomain *	createSubDomain (const SubDomainBuildInfo &sdbi)
	Creates a sub-domain with the parameters contained in sdbi.
virtual SubDomainCollection	subDomains ()
	List of sub-domains of the session.
virtual void	doAbort ()
	Performs an abort.
virtual void	endSession (int ret_val)
	Ends the session with the return code ret_val.
virtual void	writeExecInfoFile ()
	Writes the execution information file.
virtual bool	checkIsValidCaseVersion (const String &version)
const char *	msgClassName () const
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::ISession
virtual	~ISession ()=default
	Frees resources.
Public Member Functions inherited from Arcane::IBase
virtual	~IBase ()=default
	Frees resources.

Protected Member Functions
IApplication *	_application () const
virtual void	_initSubDomain (ISubDomain *sd)
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const

Private Member Functions
void	_readCaseDocument ()

Private Attributes
Impl *	m_p
	Implementation.

Detailed Description

Session.

Definition at line 37 of file Session.h.

Constructor & Destructor Documentation

◆ Session()

Arcane::Session::Session ( IApplication * app )

Definition at line 90 of file Session.cc.

◆ ~Session()

Arcane::Session::~Session ( )

virtual

Definition at line 102 of file Session.cc.

Member Function Documentation

◆ _application()

IApplication * Arcane::Session::_application ( ) const

protected

Definition at line 214 of file Session.cc.

◆ _initSubDomain()

virtual void Arcane::Session::_initSubDomain ( ISubDomain * sd )

inlineprotectedvirtual

Definition at line 82 of file Session.h.

◆ application()

IApplication * Arcane::Session::application ( ) const

virtual

Application.

Implements Arcane::ISession.

Definition at line 198 of file Session.cc.

References m_p.

Referenced by Arcane::ArcaneSession::build(), and createSubDomain().

Here is the caller graph for this function:

◆ build()

void Arcane::Session::build ( )

virtual

Constructs the instance 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.

Implements Arcane::IBase.

Reimplemented in Arcane::ArcaneSession.

Definition at line 114 of file Session.cc.

References Arcane::IMainFactory::createServiceMng(), and m_p.

Referenced by Arcane::ArcaneSession::build().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkIsValidCaseVersion()

bool Arcane::Session::checkIsValidCaseVersion ( const String & version )

virtual

The derived class can re-implement this method to specify its own dataset versioning mechanism. Without specific implementation, this method always returns false

Return values

true	if the version is correct
false	otherwise

Implements Arcane::ISession.

Definition at line 131 of file Session.cc.

◆ createSubDomain()

ISubDomain * Arcane::Session::createSubDomain ( const SubDomainBuildInfo & sdbi )

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.

Implements Arcane::ISession.

Definition at line 141 of file Session.cc.

References application(), Arcane::IBase::initialize(), m_p, Arcane::IApplication::parallelSuperMng(), and Arcane::IParallelSuperMng::threadMng().

Here is the call graph for this function:

◆ doAbort()

void Arcane::Session::doAbort ( )

virtual

Performs an abort.

Implements Arcane::ISession.

Definition at line 161 of file Session.cc.

References m_p, and Arcane::IParallelSuperMng::tryAbort().

Here is the call graph for this function:

◆ endSession()

virtual void Arcane::Session::endSession ( int ret_val )

inlinevirtual

Ends the session with the return code ret_val.

Implements Arcane::ISession.

Reimplemented in Arcane::ArcaneSession.

Definition at line 68 of file Session.h.

◆ fileName()

const String & Arcane::Session::fileName ( ) const

virtual

Definition at line 206 of file Session.cc.

◆ initialize()

virtual void Arcane::Session::initialize ( )

inlinevirtual

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

Warning: This method must only be called once.

Implements Arcane::IBase.

Definition at line 53 of file Session.h.

◆ msgClassName()

const char * Arcane::Session::msgClassName ( ) const

inline

Definition at line 77 of file Session.h.

◆ objectLocalName()

String Arcane::Session::objectLocalName ( ) const

virtual

Local name of the object.

Implements Arcane::IBase.

Definition at line 182 of file Session.cc.

References m_p.

◆ objectNamespaceURI()

String Arcane::Session::objectNamespaceURI ( ) const

virtual

Namespace of the object.

Implements Arcane::IBase.

Definition at line 178 of file Session.cc.

References m_p.

◆ objectParent()

IBase * Arcane::Session::objectParent ( ) const

virtual

Parent of this object.

Implements Arcane::IBase.

Definition at line 172 of file Session.cc.

References m_p.

◆ objectVersion()

VersionInfo Arcane::Session::objectVersion ( ) const

virtual

Service version number.

Implements Arcane::IBase.

Definition at line 186 of file Session.cc.

◆ ressourceMng()

IRessourceMng * Arcane::Session::ressourceMng ( ) const

virtual

Resource manager.

Implements Arcane::IBase.

Definition at line 194 of file Session.cc.

◆ serviceMng()

IServiceMng * Arcane::Session::serviceMng ( ) const

virtual

Service manager.

Implements Arcane::IBase.

Definition at line 190 of file Session.cc.

References m_p.

◆ subDomains()

SubDomainCollection Arcane::Session::subDomains ( )

virtual

List of sub-domains of the session.

Implements Arcane::ISession.

Definition at line 210 of file Session.cc.

References m_p.

◆ traceMng()

ITraceMng * Arcane::Session::traceMng ( ) const

virtual

Trace manager.

Implements Arcane::IBase.

Definition at line 202 of file Session.cc.

References Arcane::TraceAccessor::traceMng().

Here is the call graph for this function:

◆ writeExecInfoFile()

virtual void Arcane::Session::writeExecInfoFile ( )

inlinevirtual

Writes the execution information file.

Implements Arcane::ISession.

Reimplemented in Arcane::ArcaneSession.

Definition at line 72 of file Session.h.

Member Data Documentation

◆ m_p

Impl* Arcane::Session::m_p

private

Implementation.

Definition at line 89 of file Session.h.

Referenced by application(), build(), createSubDomain(), doAbort(), objectLocalName(), objectNamespaceURI(), objectParent(), serviceMng(), and subDomains().

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

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Session()

◆ ~Session()

Member Function Documentation

◆ _application()

◆ _initSubDomain()

◆ application()

◆ build()

◆ checkIsValidCaseVersion()

◆ createSubDomain()

◆ doAbort()

◆ endSession()

◆ fileName()

◆ initialize()

◆ msgClassName()

◆ objectLocalName()

◆ objectNamespaceURI()

◆ objectParent()

◆ objectVersion()

◆ ressourceMng()

◆ serviceMng()

◆ subDomains()

◆ traceMng()

◆ writeExecInfoFile()

Member Data Documentation

◆ m_p