Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ArcaneSession Class Reference

Session. More...

#include <arcane/impl/ArcaneSession.h>

Inheritance diagram for Arcane::ArcaneSession:
Collaboration diagram for Arcane::ArcaneSession:

Public Member Functions

 ArcaneSession (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 writeExecInfoFile ()
 Writes the execution information file.
virtual void endSession (int ret_val)
 Ends the session with the return code ret_val.
virtual void setCaseName (String casename)
virtual void setLogAndErrorFiles (ISubDomain *sd)
 Positions the file names for logs and errors.
Public Member Functions inherited from Arcane::Session
 Session (IApplication *)
virtual void initialize ()
 Initializes the instance. The instance is not usable until this method has been called.
virtual IBaseobjectParent () 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 IServiceMngserviceMng () const
 Service manager.
virtual IRessourceMngressourceMng () const
 Resource manager.
virtual IApplicationapplication () const
 Application.
virtual ITraceMngtraceMng () const
 Trace manager.
virtual const StringfileName () const
virtual ISubDomaincreateSubDomain (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 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.
TraceAccessoroperator= (const TraceAccessor &rhs)
 Copy assignment operator.
virtual ~TraceAccessor ()
 Frees resources.
ITraceMngtraceMng () 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.

Private Member Functions

void _checkExecInfoFile ()
void _initSubDomain (ISubDomain *sd)
void _writeExecInfoFileInit ()
void _writeExecInfoFile (int ret_val)
void _setLogAndErrorFiles (ISubDomain *sd)

Private Attributes

IXmlDocumentHolderm_result_doc
 Code results.
Directory m_listing_directory
Directory m_output_directory
String m_case_name

Additional Inherited Members

Protected Member Functions inherited from Arcane::Session
IApplication_application () const
Protected Member Functions inherited from Arcane::TraceAccessor
void _setLocalVerboseLevel (Int32 v)
Int32 _localVerboseLevel () const

Detailed Description

Session.

Definition at line 37 of file impl/ArcaneSession.h.

Constructor & Destructor Documentation

◆ ArcaneSession()

Arcane::ArcaneSession::ArcaneSession ( IApplication * application)

Definition at line 44 of file ArcaneSession.cc.

◆ ~ArcaneSession()

Arcane::ArcaneSession::~ArcaneSession ( )
virtual

Definition at line 55 of file ArcaneSession.cc.

Member Function Documentation

◆ _checkExecInfoFile()

void Arcane::ArcaneSession::_checkExecInfoFile ( )
private

Definition at line 248 of file ArcaneSession.cc.

◆ _initSubDomain()

void Arcane::ArcaneSession::_initSubDomain ( ISubDomain * sd)
privatevirtual

Reimplemented from Arcane::Session.

Definition at line 95 of file ArcaneSession.cc.

◆ _setLogAndErrorFiles()

void Arcane::ArcaneSession::_setLogAndErrorFiles ( ISubDomain * sd)
inlineprivate

Definition at line 66 of file impl/ArcaneSession.h.

◆ _writeExecInfoFile()

void Arcane::ArcaneSession::_writeExecInfoFile ( int ret_val)
private

Definition at line 192 of file ArcaneSession.cc.

◆ build()

void Arcane::ArcaneSession::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.

Reimplemented from Arcane::Session.

Definition at line 64 of file ArcaneSession.cc.

References Arcane::Session::application(), Arcane::IParallelSuperMng::barrier(), Arcane::Session::build(), Arcane::String::empty(), Arcane::Directory::file(), Arcane::platform::getCurrentDirectory(), Arcane::TraceAccessor::info(), and Arcane::IParallelSuperMng::isMasterIO().

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

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

◆ endSession()

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

Ends the session with the return code ret_val.

Reimplemented from Arcane::Session.

Definition at line 270 of file ArcaneSession.cc.

◆ setCaseName()

void Arcane::ArcaneSession::setCaseName ( String casename)
virtual

Definition at line 279 of file ArcaneSession.cc.

◆ setLogAndErrorFiles()

◆ writeExecInfoFile()

void Arcane::ArcaneSession::writeExecInfoFile ( )
virtual

Writes the execution information file.

Reimplemented from Arcane::Session.

Definition at line 239 of file ArcaneSession.cc.

Member Data Documentation

◆ m_case_name

String Arcane::ArcaneSession::m_case_name
private

Definition at line 58 of file impl/ArcaneSession.h.

◆ m_listing_directory

Directory Arcane::ArcaneSession::m_listing_directory
private

Definition at line 56 of file impl/ArcaneSession.h.

◆ m_output_directory

Directory Arcane::ArcaneSession::m_output_directory
private

Definition at line 57 of file impl/ArcaneSession.h.

◆ m_result_doc

IXmlDocumentHolder* Arcane::ArcaneSession::m_result_doc
private

Code results.

Definition at line 55 of file impl/ArcaneSession.h.


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