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

Interface for a configuration. More...

#include <arcane/core/Configuration.h>

Inheritance diagram for Arcane::IConfiguration:
Collaboration diagram for Arcane::IConfiguration:

Public Member Functions

virtual ~IConfiguration ()
 Frees resources.
virtual IConfigurationSectioncreateSection (const String &name) const =0
 Creates a configuration section.
virtual IConfigurationSectionmainSection () const =0
 Main section.
virtual void addValue (const String &name, const String &value, Integer priority)=0
 Adds a value to the configuration.
virtual IConfigurationclone () const =0
 Clones this configuration.
virtual void merge (const IConfiguration *c)=0
 Merges this configuration with configuration c.
virtual void dump () const =0
 Displays the values of the configuration parameters via traceMng().
virtual void dump (std::ostream &ostr) const =0
 Displays the values of the configuration parameters to the stream o.

Detailed Description

Interface for a configuration.

Definition at line 61 of file Configuration.h.

Constructor & Destructor Documentation

◆ ~IConfiguration()

virtual Arcane::IConfiguration::~IConfiguration ( )
inlinevirtual

Frees resources.

Definition at line 65 of file Configuration.h.

Member Function Documentation

◆ addValue()

virtual void Arcane::IConfiguration::addValue ( const String & name,
const String & value,
Integer priority )
pure virtual

Adds a value to the configuration.

Adds the value value for the name name to the configuration. The new value will have priority priority. If a value for name name already exists, it is replaced by value if priority is lower than the current priority.

Implemented in Arcane::Configuration.

◆ clone()

virtual IConfiguration * Arcane::IConfiguration::clone ( ) const
pure virtual

Clones this configuration.

Implemented in Arcane::Configuration.

◆ createSection()

virtual IConfigurationSection * Arcane::IConfiguration::createSection ( const String & name) const
pure virtual

Creates a configuration section.

The returned instance must be destroyed by the delete operator.

Implemented in Arcane::Configuration.

◆ dump() [1/2]

virtual void Arcane::IConfiguration::dump ( ) const
pure virtual

Displays the values of the configuration parameters via traceMng().

Implemented in Arcane::Configuration.

◆ dump() [2/2]

virtual void Arcane::IConfiguration::dump ( std::ostream & ostr) const
pure virtual

Displays the values of the configuration parameters to the stream o.

Implemented in Arcane::Configuration.

◆ mainSection()

virtual IConfigurationSection * Arcane::IConfiguration::mainSection ( ) const
pure virtual

Main section.

The returned instance remains the property of this instance and should not be destroyed.

Implemented in Arcane::Configuration.

◆ merge()

virtual void Arcane::IConfiguration::merge ( const IConfiguration * c)
pure virtual

Merges this configuration with configuration c.

If an option exists in both this configuration and c, the one with the lowest priority is kept.

Implemented in Arcane::Configuration.

Referenced by Arcane::TimeLoopMng::setUsedTimeLoop().

Here is the caller graph for this function:

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