Arcane::CaseOptionService Class Reference

Base class for options using services. More...

#include <arcane/core/CaseOptionService.h>

Public Member Functions
	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)
	Sets the default value for the service name.
void	addDefaultValue (const String &category, const String &value)
	Adds the default value value to the category category.
void	setMeshName (const String &mesh_name)
	Sets the mesh name to which the service will be associated.
String	meshName () const
	Mesh name to which the service is associated.

Protected Member Functions
CaseOptionServiceImpl *	_impl ()
const CaseOptionServiceImpl *	_impl () const

Detailed Description

Base class for options using services.

Instances of this class are not copyable.

Definition at line 136 of file CaseOptionService.h.

Constructor & Destructor Documentation

CaseOptionService()

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

inline

Definition at line 140 of file CaseOptionService.h.

Member Function Documentation

_impl() [1/2]

CaseOptionServiceImpl * Arcane::CaseOptionService::_impl ( )

inlineprotected

Definition at line 224 of file CaseOptionService.h.

_impl() [2/2]

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

inlineprotected

Definition at line 225 of file CaseOptionService.h.

addAlternativeNodeName()

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

inline

Definition at line 171 of file CaseOptionService.h.

addDefaultValue()

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

inline

Adds the default value value to the category category.

Definition at line 198 of file CaseOptionService.h.

getAvailableNames()

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

inline

Definition at line 175 of file CaseOptionService.h.

isOptional()

bool Arcane::CaseOptionService::isOptional ( ) const

inline

Definition at line 169 of file CaseOptionService.h.

isPresent()

bool Arcane::CaseOptionService::isPresent ( ) const

inline

Definition at line 170 of file CaseOptionService.h.

meshName()

String Arcane::CaseOptionService::meshName

(

)

const

Mesh name to which the service is associated.

This is the name of the mesh as specified in the service descriptor (the 'axl' file). To get the associated mesh after reading the options you must use ICaseOptions::meshHandle().

Definition at line 97 of file CaseOptionService.cc.

name()

String Arcane::CaseOptionService::name ( ) const

inline

Definition at line 167 of file CaseOptionService.h.

operator CaseOptions &()

Arcane::CaseOptionService::operator CaseOptions & ( )

inline

Definition at line 155 of file CaseOptionService.h.

operator const CaseOptions &()

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

inline

Definition at line 158 of file CaseOptionService.h.

rootTagName()

String Arcane::CaseOptionService::rootTagName ( ) const

inline

Definition at line 166 of file CaseOptionService.h.

serviceName()

String Arcane::CaseOptionService::serviceName ( ) const

inline

Definition at line 168 of file CaseOptionService.h.

setDefaultValue()

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

inline

Sets the default value for the service name.

If the option is not present in the data set, its value will be that specified by the def_value argument; otherwise, calling this method has no effect.

This method can only be called during phase 1 of reading the data set because the service is already instantiated afterwards. A FatalErrorException exception is raised if this method is called and the service is already instantiated.

Definition at line 192 of file CaseOptionService.h.

setMeshName()

void Arcane::CaseOptionService::setMeshName

(

const String &

mesh_name

)

Sets the mesh name to which the service will be associated.

If null, the service is associated with the default mesh of the subdomain (ISubDomain::defaultMeshHandle()). The actual association happens when reading the options. Calling this method after reading the options will have no impact.

Definition at line 88 of file CaseOptionService.cc.

toICaseOptions()

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

inline

Definition at line 162 of file CaseOptionService.h.

---

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

• CaseOptionService.h
• CaseOptionService.cc