Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::PropertyImpl::PropertyKeyValues Class Reference
Collaboration diagram for Arcane::PropertyImpl::PropertyKeyValues:

Classes

class  NameValuePair

Public Member Functions

String getValue (const UniqueArray< String > &env_values, const String &param_name, const String &default_value)
 Retrieves the value of an option.
void add (const String &name, const String &value)

Private Member Functions

String _searchParam (const String &param_name)

Private Attributes

UniqueArray< NameValuePairm_values

Detailed Description

Definition at line 168 of file FieldProperty.h.

Member Function Documentation

◆ _searchParam()

String Arcane::PropertyImpl::PropertyKeyValues::_searchParam ( const String & param_name)
inlineprivate

Definition at line 224 of file FieldProperty.h.

◆ add()

void Arcane::PropertyImpl::PropertyKeyValues::add ( const String & name,
const String & value )
inline

Definition at line 213 of file FieldProperty.h.

◆ getValue()

String Arcane::PropertyImpl::PropertyKeyValues::getValue ( const UniqueArray< String > & env_values,
const String & param_name,
const String & default_value )
inline

Retrieves the value of an option.

The retrieval order is as follows:

  • if param_name is not null, check if there is a value in m_values associated with this parameter. If so, return this value.
  • for each name x in env_values, check if an environment variable x exists and return its value if it does.
  • if none of the previous methods worked, return the default_value.

Definition at line 198 of file FieldProperty.h.

References Arcane::Platform::getEnvironmentVariable(), and Arcane::String::null().

Here is the call graph for this function:

Member Data Documentation

◆ m_values

UniqueArray<NameValuePair> Arcane::PropertyImpl::PropertyKeyValues::m_values
private

Definition at line 220 of file FieldProperty.h.


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