Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::CaseOptionName Class Reference

Public Member Functions

 CaseOptionName (const String &true_name)
 Constructs a name option true_name.
 CaseOptionName (const CaseOptionName &rhs)
 Copy constructor.
virtual ~CaseOptionName ()
 Releases resources.
String name (const String &lang) const
 returns the name of the option in the language lang. If no translation is available in the language lang, trueName() is returned.
String trueName () const
 Returns the true name (non-translated) of the option.
void addAlternativeNodeName (const String &lang, const String &tname)
 Adds a translation for the option name. Adds the name tname corresponding to the language lang. If a translation already exists for this language, it is replaced by this one.

Detailed Description

Definition at line 33 of file CaseOptionEnum.h.

Constructor & Destructor Documentation

◆ CaseOptionName() [1/2]

Arcane::CaseOptionName::CaseOptionName ( const String & true_name)

Constructs a name option true_name.

Definition at line 35 of file CaseOptionEnum.cc.

Referenced by Arcane::CaseOptionEnumValue::CaseOptionEnumValue(), and CaseOptionName().

◆ CaseOptionName() [2/2]

Arcane::CaseOptionName::CaseOptionName ( const CaseOptionName & rhs)

Copy constructor.

Definition at line 45 of file CaseOptionEnum.cc.

References CaseOptionName().

◆ ~CaseOptionName()

Arcane::CaseOptionName::~CaseOptionName ( )
virtual

Releases resources.

Definition at line 57 of file CaseOptionEnum.cc.

Member Function Documentation

◆ addAlternativeNodeName()

void Arcane::CaseOptionName::addAlternativeNodeName ( const String & lang,
const String & tname )

Adds a translation for the option name. Adds the name tname corresponding to the language lang. If a translation already exists for this language, it is replaced by this one.

Parameters
tnametranslation of the name
langlanguage of the translation

Definition at line 66 of file CaseOptionEnum.cc.

References name().

◆ name()

String Arcane::CaseOptionName::name ( const String & lang) const

returns the name of the option in the language lang. If no translation is available in the language lang, trueName() is returned.

Definition at line 77 of file CaseOptionEnum.cc.

References Arcane::String::null().

Referenced by addAlternativeNodeName().

◆ trueName()

String Arcane::CaseOptionName::trueName ( ) const
inline

Returns the true name (non-translated) of the option.

Definition at line 52 of file CaseOptionEnum.h.


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