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

Information for constructing an instance of IApplication. More...

#include <arcane/core/ApplicationBuildInfo.h>

Inheritance diagram for Arcane::ApplicationBuildInfo:
Collaboration diagram for Arcane::ApplicationBuildInfo:

Classes

class  Impl

Public Member Functions

 ApplicationBuildInfo (const ApplicationBuildInfo &rhs)
ApplicationBuildInfo & operator= (const ApplicationBuildInfo &rhs)
void setMessagePassingService (const String &name)
String messagePassingService () const
Int32 nbSharedMemorySubDomain () const
void setNbSharedMemorySubDomain (Int32 v)
Int32 nbReplicationSubDomain () const
void setNbReplicationSubDomain (Int32 v)
Int32 nbProcessusSubDomain () const
void setNbProcessusSubDomain (Int32 v)
void setConfigFileName (const String &name)
 Sets the code configuration file.
String configFileName () const
 Name of the code configuration file.
void setOutputLevel (Int32 v)
 Sets the message verbosity level on standard output.
Int32 outputLevel () const
void setVerbosityLevel (Int32 v)
 Sets the message verbosity level of reduced listing files.
Int32 verbosityLevel () const
Int32 minimalVerbosityLevel () const
void setMinimalVerbosityLevel (Int32 v)
bool isMasterHasOutputFile () const
void setIsMasterHasOutputFile (bool v)
void setOutputDirectory (const String &name)
 Sets the directory containing the various simulation outputs.
String outputDirectory () const
void setApplicationName (const String &v)
 Sets the application name.
String applicationName () const
 Application name.
void setCodeVersion (const VersionInfo &version_info)
 Sets the code version.
VersionInfo codeVersion () const
 Version number.
void setCodeName (const String &code_name)
 Sets the code name.
String codeName () const
 Returns the code name.
String threadBindingStrategy () const
 Strategy for binding task threads.
void threadBindingStrategy (const String &v)
 Sets the strategy for binding task threads.
CaseDatasetSource & caseDatasetSource ()
 Dataset source.
const CaseDatasetSource & caseDatasetSource () const
 Dataset source.
void internalSetDefaultMessagePassingService (const String &name)
 Default message passing manager name. Must only be modified by Arcane.
String internalDefaultMessagePassingService () const
void addDynamicLibrary (const String &lib_name)
 Adds the library lib_name to the list of dynamically loaded libraries.
void parseArguments (const CommandLineArguments &args)
 Parses the arguments in args.
ApplicationInfo & _internalApplicationInfo ()
const ApplicationInfo & _internalApplicationInfo () const
void setDefaultValues () override
void setDefaultServices () override
Public Member Functions inherited from Arcane::ArccoreApplicationBuildInfo
 ArccoreApplicationBuildInfo (const ArccoreApplicationBuildInfo &rhs)
ArccoreApplicationBuildInfo & operator= (const ArccoreApplicationBuildInfo &rhs)
void setTaskImplementationService (const String &name)
void setTaskImplementationServices (const StringList &names)
StringList taskImplementationServices () const
void setThreadImplementationService (const String &name)
void setThreadImplementationServices (const StringList &names)
StringList threadImplementationServices () const
Int32 nbTaskThread () const
void setNbTaskThread (Integer v)
void addParameter (const String &name, const String &value)
void parseArgumentsAndSetDefaultsValues (const CommandLineArguments &args)
 Parses the arguments in args.

Private Attributes

Impl * m_p = nullptr

Additional Inherited Members

Protected Attributes inherited from Arcane::ArccoreApplicationBuildInfo
ArccoreApplicationBuildInfoImpl * m_core = nullptr

Detailed Description

Information for constructing an instance of IApplication.

Definition at line 33 of file ApplicationBuildInfo.h.

Constructor & Destructor Documentation

◆ ApplicationBuildInfo() [1/2]

Arcane::ApplicationBuildInfo::ApplicationBuildInfo ( )

Definition at line 92 of file ApplicationBuildInfo.cc.

◆ ApplicationBuildInfo() [2/2]

Arcane::ApplicationBuildInfo::ApplicationBuildInfo ( const ApplicationBuildInfo & rhs)

Definition at line 101 of file ApplicationBuildInfo.cc.

◆ ~ApplicationBuildInfo()

Arcane::ApplicationBuildInfo::~ApplicationBuildInfo ( )

Definition at line 122 of file ApplicationBuildInfo.cc.

Member Function Documentation

◆ _internalApplicationInfo() [1/2]

ApplicationInfo & Arcane::ApplicationBuildInfo::_internalApplicationInfo ( )

Definition at line 497 of file ApplicationBuildInfo.cc.

◆ _internalApplicationInfo() [2/2]

const ApplicationInfo & Arcane::ApplicationBuildInfo::_internalApplicationInfo ( ) const

Definition at line 506 of file ApplicationBuildInfo.cc.

◆ addDynamicLibrary()

void Arcane::ApplicationBuildInfo::addDynamicLibrary ( const String & lib_name)

Adds the library lib_name to the list of dynamically loaded libraries.

lib_name must be a name, without path or extension. For example, my_lib is valid but not libtoto.so, nor /tmp/toto.

Definition at line 574 of file ApplicationBuildInfo.cc.

◆ applicationName()

String Arcane::ApplicationBuildInfo::applicationName ( ) const

Application name.

Definition at line 520 of file ApplicationBuildInfo.cc.

◆ caseDatasetSource() [1/2]

CaseDatasetSource & Arcane::ApplicationBuildInfo::caseDatasetSource ( )

Dataset source.

Definition at line 559 of file ApplicationBuildInfo.cc.

◆ caseDatasetSource() [2/2]

const CaseDatasetSource & Arcane::ApplicationBuildInfo::caseDatasetSource ( ) const

Dataset source.

Definition at line 565 of file ApplicationBuildInfo.cc.

◆ codeName()

String Arcane::ApplicationBuildInfo::codeName ( ) const

Returns the code name.

Definition at line 550 of file ApplicationBuildInfo.cc.

◆ codeVersion()

VersionInfo Arcane::ApplicationBuildInfo::codeVersion ( ) const

Version number.

Definition at line 535 of file ApplicationBuildInfo.cc.

◆ configFileName()

String Arcane::ApplicationBuildInfo::configFileName ( ) const

Name of the code configuration file.

By default, the value is an empty string (""). In this case, Arcane searches for a file whose name is codeName() followed by the .config extension.

If the value is null, then no configuration file is loaded.

Definition at line 360 of file ApplicationBuildInfo.cc.

Referenced by Arcane::ArcaneLauncher::run().

Here is the caller graph for this function:

◆ internalDefaultMessagePassingService()

String Arcane::ApplicationBuildInfo::internalDefaultMessagePassingService ( ) const

Definition at line 592 of file ApplicationBuildInfo.cc.

◆ internalSetDefaultMessagePassingService()

void Arcane::ApplicationBuildInfo::internalSetDefaultMessagePassingService ( const String & name)

Default message passing manager name. Must only be modified by Arcane.

Definition at line 583 of file ApplicationBuildInfo.cc.

Referenced by Arcane::AutoDetecterMPI::visit().

Here is the caller graph for this function:

◆ isMasterHasOutputFile()

bool Arcane::ApplicationBuildInfo::isMasterHasOutputFile ( ) const

Definition at line 423 of file ApplicationBuildInfo.cc.

◆ messagePassingService()

String Arcane::ApplicationBuildInfo::messagePassingService ( ) const

Definition at line 237 of file ApplicationBuildInfo.cc.

◆ minimalVerbosityLevel()

Int32 Arcane::ApplicationBuildInfo::minimalVerbosityLevel ( ) const

Definition at line 408 of file ApplicationBuildInfo.cc.

◆ nbProcessusSubDomain()

Int32 Arcane::ApplicationBuildInfo::nbProcessusSubDomain ( ) const

Definition at line 342 of file ApplicationBuildInfo.cc.

◆ nbReplicationSubDomain()

Int32 Arcane::ApplicationBuildInfo::nbReplicationSubDomain ( ) const

Definition at line 324 of file ApplicationBuildInfo.cc.

◆ nbSharedMemorySubDomain()

Int32 Arcane::ApplicationBuildInfo::nbSharedMemorySubDomain ( ) const

Definition at line 306 of file ApplicationBuildInfo.cc.

◆ operator=()

ApplicationBuildInfo & Arcane::ApplicationBuildInfo::operator= ( const ApplicationBuildInfo & rhs)

Definition at line 108 of file ApplicationBuildInfo.cc.

◆ outputDirectory()

String Arcane::ApplicationBuildInfo::outputDirectory ( ) const

Definition at line 438 of file ApplicationBuildInfo.cc.

◆ outputLevel()

Int32 Arcane::ApplicationBuildInfo::outputLevel ( ) const

Definition at line 378 of file ApplicationBuildInfo.cc.

◆ parseArguments()

void Arcane::ApplicationBuildInfo::parseArguments ( const CommandLineArguments & args)
inline

Parses the arguments in args.

Only arguments of the style -A,x=b,y=c are retrieved. The setDefaultValues() method is called at the end of this method.

Definition at line 164 of file ApplicationBuildInfo.h.

References parseArguments(), and Arcane::ArccoreApplicationBuildInfo::parseArgumentsAndSetDefaultsValues().

Referenced by parseArguments().

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

◆ setApplicationName()

void Arcane::ApplicationBuildInfo::setApplicationName ( const String & v)

Sets the application name.

Definition at line 515 of file ApplicationBuildInfo.cc.

References Arcane::ApplicationInfo::setApplicationName().

Here is the call graph for this function:

◆ setCodeName()

void Arcane::ApplicationBuildInfo::setCodeName ( const String & code_name)

Sets the code name.

Definition at line 544 of file ApplicationBuildInfo.cc.

◆ setCodeVersion()

void Arcane::ApplicationBuildInfo::setCodeVersion ( const VersionInfo & version_info)

Sets the code version.

Definition at line 529 of file ApplicationBuildInfo.cc.

◆ setConfigFileName()

void Arcane::ApplicationBuildInfo::setConfigFileName ( const String & name)

Sets the code configuration file.

See also
configFileName().

Definition at line 369 of file ApplicationBuildInfo.cc.

Referenced by Arcane::ArcaneLauncher::run().

Here is the caller graph for this function:

◆ setDefaultServices()

void Arcane::ApplicationBuildInfo::setDefaultServices ( )
overridevirtual

Reimplemented from Arcane::ArccoreApplicationBuildInfo.

Definition at line 214 of file ApplicationBuildInfo.cc.

◆ setDefaultValues()

void Arcane::ApplicationBuildInfo::setDefaultValues ( )
overridevirtual

Reimplemented from Arcane::ArccoreApplicationBuildInfo.

Definition at line 131 of file ApplicationBuildInfo.cc.

◆ setIsMasterHasOutputFile()

void Arcane::ApplicationBuildInfo::setIsMasterHasOutputFile ( bool v)

Definition at line 429 of file ApplicationBuildInfo.cc.

◆ setMessagePassingService()

void Arcane::ApplicationBuildInfo::setMessagePassingService ( const String & name)

Definition at line 231 of file ApplicationBuildInfo.cc.

◆ setMinimalVerbosityLevel()

void Arcane::ApplicationBuildInfo::setMinimalVerbosityLevel ( Int32 v)

Definition at line 414 of file ApplicationBuildInfo.cc.

◆ setNbProcessusSubDomain()

void Arcane::ApplicationBuildInfo::setNbProcessusSubDomain ( Int32 v)

Definition at line 351 of file ApplicationBuildInfo.cc.

◆ setNbReplicationSubDomain()

void Arcane::ApplicationBuildInfo::setNbReplicationSubDomain ( Int32 v)

Definition at line 333 of file ApplicationBuildInfo.cc.

◆ setNbSharedMemorySubDomain()

void Arcane::ApplicationBuildInfo::setNbSharedMemorySubDomain ( Int32 v)

Definition at line 315 of file ApplicationBuildInfo.cc.

◆ setOutputDirectory()

void Arcane::ApplicationBuildInfo::setOutputDirectory ( const String & name)

Sets the directory containing the various simulation outputs.

These outputs include the summary, profiling traces, listing outputs, ...

Definition at line 447 of file ApplicationBuildInfo.cc.

◆ setOutputLevel()

void Arcane::ApplicationBuildInfo::setOutputLevel ( Int32 v)

Sets the message verbosity level on standard output.

Definition at line 384 of file ApplicationBuildInfo.cc.

◆ setVerbosityLevel()

void Arcane::ApplicationBuildInfo::setVerbosityLevel ( Int32 v)

Sets the message verbosity level of reduced listing files.

Definition at line 399 of file ApplicationBuildInfo.cc.

◆ threadBindingStrategy() [1/2]

String Arcane::ApplicationBuildInfo::threadBindingStrategy ( ) const

Strategy for binding task threads.

Definition at line 456 of file ApplicationBuildInfo.cc.

◆ threadBindingStrategy() [2/2]

void Arcane::ApplicationBuildInfo::threadBindingStrategy ( const String & v)

Sets the strategy for binding task threads.

Definition at line 462 of file ApplicationBuildInfo.cc.

◆ verbosityLevel()

Int32 Arcane::ApplicationBuildInfo::verbosityLevel ( ) const

Definition at line 393 of file ApplicationBuildInfo.cc.

Member Data Documentation

◆ m_p

Impl* Arcane::ApplicationBuildInfo::m_p = nullptr
private

Definition at line 181 of file ApplicationBuildInfo.h.

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