Référence de la classe Arcane::CaseOptionService

Classe de base des options utilisant des services. Plus de détails...

#include <arcane/core/CaseOptionService.h>

Graphe d'héritage de Arcane::CaseOptionService:

Graphe de collaboration de Arcane::CaseOptionService:

Fonctions membres publiques
	CaseOptionService (const CaseOptionBuildInfo &cob, bool allow_null, bool is_optional)
	CaseOptionService (const CaseOptionService &)=delete
const CaseOptionService &	operator= (const CaseOptionService &)=delete
	operator CaseOptions & ()
	operator const CaseOptions & () const
const ICaseOptions *	toICaseOptions ()
String	rootTagName () const
String	name () const
String	serviceName () const
bool	isOptional () const
bool	isPresent () const
void	addAlternativeNodeName (const String &lang, const String &name)
void	getAvailableNames (StringArray &names) const
void	setDefaultValue (const String &def_value)
	Positionne la valeur par défaut du nom du service.
void	addDefaultValue (const String &category, const String &value)
	Ajoute la valeur par défaut value à la catégorie category.
void	setMeshName (const String &mesh_name)
	Positionne le nom du maillage auquel le service sera associé.
String	meshName () const
	Nom du maillage auquel le service est associé.

Fonctions membres protégées
CaseOptionServiceImpl *	_impl ()
const CaseOptionServiceImpl *	_impl () const

Attributs privés
ReferenceCounter< CaseOptionServiceImpl >	m_impl

Description détaillée

Classe de base des options utilisant des services.

Les instances de cette classe ne sont pas copiables.

Définition à la ligne 128 du fichier CaseOptionService.h.

Documentation des constructeurs et destructeur

CaseOptionService()

Arcane::CaseOptionService::CaseOptionService ( const CaseOptionBuildInfo &  cob, bool  allow_null, bool  is_optional  )

inline

Définition à la ligne 132 du fichier CaseOptionService.h.

Documentation des fonctions membres

_impl() [1/2]

CaseOptionServiceImpl * Arcane::CaseOptionService::_impl ( )

inlineprotected

Définition à la ligne 212 du fichier CaseOptionService.h.

_impl() [2/2]

const CaseOptionServiceImpl * Arcane::CaseOptionService::_impl ( ) const

inlineprotected

Définition à la ligne 213 du fichier CaseOptionService.h.

addAlternativeNodeName()

void Arcane::CaseOptionService::addAlternativeNodeName ( const String &  lang, const String &  name  )

inline

Définition à la ligne 163 du fichier CaseOptionService.h.

addDefaultValue()

void Arcane::CaseOptionService::addDefaultValue ( const String &  category, const String &  value  )

inline

Ajoute la valeur par défaut value à la catégorie category.

Définition à la ligne 187 du fichier CaseOptionService.h.

getAvailableNames()

void Arcane::CaseOptionService::getAvailableNames ( StringArray &  names ) const

inline

Définition à la ligne 167 du fichier CaseOptionService.h.

isOptional()

bool Arcane::CaseOptionService::isOptional ( ) const

inline

Définition à la ligne 161 du fichier CaseOptionService.h.

isPresent()

bool Arcane::CaseOptionService::isPresent ( ) const

inline

Définition à la ligne 162 du fichier CaseOptionService.h.

meshName()

String Arcane::CaseOptionService::meshName

(

)

const

Nom du maillage auquel le service est associé.

Il s'agit du nom du maillage tel que spécifié dans le descripteur de service (le fichier 'axl'). Pour obtenir le maillage associé après lecture des options il faut utiliser ICaseOptions::meshHandle().

Définition à la ligne 92 du fichier CaseOptionService.cc.

name()

String Arcane::CaseOptionService::name ( ) const

inline

Définition à la ligne 159 du fichier CaseOptionService.h.

operator CaseOptions &()

Arcane::CaseOptionService::operator CaseOptions & ( )

inline

Définition à la ligne 147 du fichier CaseOptionService.h.

operator const CaseOptions &()

Arcane::CaseOptionService::operator const CaseOptions & ( ) const

inline

Définition à la ligne 150 du fichier CaseOptionService.h.

rootTagName()

String Arcane::CaseOptionService::rootTagName ( ) const

inline

Définition à la ligne 158 du fichier CaseOptionService.h.

serviceName()

String Arcane::CaseOptionService::serviceName ( ) const

inline

Définition à la ligne 160 du fichier CaseOptionService.h.

setDefaultValue()

void Arcane::CaseOptionService::setDefaultValue ( const String &  def_value )

inline

Positionne la valeur par défaut du nom du service.

Si l'option n'est pas pas présente dans le jeu de données, alors sa valeur sera celle spécifiée par l'argument def_value, sinon l'appel de cette méthode est sans effet.

Cette méthode ne peut être apellée que lors de la phase 1 de la lecture du jeu de données car par la suite le service est déjà instancié. Une exception FatalErrorException est levé si cette méthode est appelée et que le service est déjà instancié.

Définition à la ligne 182 du fichier CaseOptionService.h.

setMeshName()

void Arcane::CaseOptionService::setMeshName

(

const String &

mesh_name

)

Positionne le nom du maillage auquel le service sera associé.

Si nul, le service est associé au maillage par défaut du sous-domaine (ISubDomain::defaultMeshHandle()). L'association réelle se fait lors de la lecture des options. Appeler cette méthode après lecture des options n'aura aucun impact.

Définition à la ligne 83 du fichier CaseOptionService.cc.

toICaseOptions()

const ICaseOptions * Arcane::CaseOptionService::toICaseOptions ( )

inline

Définition à la ligne 154 du fichier CaseOptionService.h.

Documentation des données membres

m_impl

ReferenceCounter<CaseOptionServiceImpl> Arcane::CaseOptionService::m_impl

private

Définition à la ligne 217 du fichier CaseOptionService.h.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• CaseOptionService.h
• CaseOptionService.cc