Base class for a service option that can appear multiple times. More...

#include <arcane/core/CaseOptionServiceImpl.h>

Inheritance diagram for Arcane::CaseOptionMultiServiceImpl:

Collaboration diagram for Arcane::CaseOptionMultiServiceImpl:

Public Member Functions
	CaseOptionMultiServiceImpl (const CaseOptionBuildInfo &cob, bool allow_null)
void	getAvailableNames (StringArray &names) const
	Returns the valid implementation names for this service in names.
String	serviceName (Integer index) const
	Name of the nth service.
void	multiAllocate (const XmlNodeList &) override
void	visit (ICaseDocumentVisitor *visitor) const override
	Applies the visitor to this option.
void	setContainer (ICaseOptionServiceContainer *container)
	Positions the instance container.
void	setMeshName (const String &mesh_name)
String	meshName () const
void	_setNotifyAllocateFunctor (IFunctor *f)
Public Member Functions inherited from Arcane::CaseOptionsMulti
	CaseOptionsMulti (ICaseMng *, const String &tag_root_name, const XmlNode &element, Integer min_occurs, Integer max_occurs)
	CaseOptionsMulti (ICaseOptionList *, const String &tag_root_name, const XmlNode &element, Integer min_occurs, Integer max_occurs)
ICaseOptions *	toCaseOptions () override
void	addChild (ICaseOptionList *v) override
Integer	nbChildren () const override
ICaseOptionList *	child (Integer index) const override
ICaseOptionsMulti *	toCaseOptionsMulti ()
Public Member Functions inherited from Arcane::CaseOptions
	CaseOptions (ICaseMng *cm, const String &name)
	Constructs an options set.
	CaseOptions (ICaseOptionList *, const String &name)
	Constructs an options set.
	CaseOptions (ICaseMng *cm, const String &name, const XmlNode &parent)
	Constructs an options set.
	CaseOptions (ICaseOptionList *, const String &name, const XmlNode &parent, bool is_optional=false, bool is_multi=false)
	Constructs an options set.
	~CaseOptions () override
	Frees resources.
String	rootTagTrueName () const override
	Returns the true name (non-translated) of the element.
String	rootTagName () const override
	Returns the name of the element in the data set language.
String	translatedName (const String &lang) const override
	Name in language lang of the option. Returns rootTagTrueName() if no translation exists.
virtual String	trueName () const
	Returns the true name (non-translated) of the element.
virtual String	name () const
	Returns the name of the element in the data set language.
void	read (bool is_phase1) override
void	read (eCaseOptionReadPhase phase) override
	Performs the reading of the read_phase phase of the options.
void	addInvalidChildren (XmlNodeList &) override
	Adds unrecognized elements to nlist.
void	printChildren (const String &lang, int indent) override
IServiceInfo *	caseServiceInfo () const override
	Returns the associated service or 0 if none exists.
IModule *	caseModule () const override
	Returns the associated module or 0 if none exists.
void	setCaseServiceInfo (IServiceInfo *m) override
	Associates service m with this data set.
void	setCaseModule (IModule *m) override
	Associates module m with this data set.
void	deepGetChildren (Array< CaseOptionBase * > &col) override
	Adds all child options to the list col.
ICaseOptionList *	configList () override
const ICaseOptionList *	configList () const override
ICaseFunction *	activateFunction () override
	Function indicating the activation status of the option.
bool	isPresent () const override
	True if the option is present in the file, false if it is the default value.
void	addAlternativeNodeName (const String &lang, const String &name) override
	Adds a translation for the option name. Adds the option name name corresponding to language lang. If a translation already exists for this language, it is replaced by this one.
ICaseMng *	caseMng () const override
ITraceMng *	traceMng () const override
ISubDomain *	subDomain () const override
	Associated sub-domain.
IMesh *	mesh () const override
MeshHandle	meshHandle () const override
ICaseDocument *	caseDocument () const override
ICaseDocumentFragment *	caseDocumentFragment () const override
void	detach () override
void	visit (ICaseDocumentVisitor *visitor) const override
	Applies the visitor to this option.
String	xpathFullName () const override
	Full name in XPath format corresponding to rootElement().
Ref< ICaseOptions >	toReference () override

Protected Member Functions
String	_defaultValue () const
Protected Member Functions inherited from Arcane::CaseOptions
	CaseOptions (ICaseMng , const String &name, ICaseOptionList parent)
	Constructs an options set.
	CaseOptions (ICaseOptionList , const String &name, ICaseOptionList parent)
	Constructs an options set.
void	_setTranslatedName ()
bool	_setMeshHandleAndCheckDisabled (const String &mesh_name)
	Positions the mesh associated with this option.

Protected Attributes
bool	m_allow_null
String	m_default_value
String	m_mesh_name
IFunctor *	m_notify_functor
ICaseOptionServiceContainer *	m_container
UniqueArray< ReferenceCounter< ICaseOptions > >	m_allocated_options
	List of allocated options that must be deleted.
UniqueArray< String >	m_services_name
	Service names for each occurrence.
Protected Attributes inherited from Arcane::CaseOptions
CaseOptionsPrivate *	m_p
	Implementation.

Detailed Description

Base class for a service option that can appear multiple times.

You must call setContainer() to position a container before using this class.

Definition at line 135 of file CaseOptionServiceImpl.h.

Constructor & Destructor Documentation

◆ CaseOptionMultiServiceImpl()

Arcane::CaseOptionMultiServiceImpl::CaseOptionMultiServiceImpl	(	const CaseOptionBuildInfo &	cob,
		bool	allow_null )

Definition at line 336 of file CaseOptionService.cc.

◆ ~CaseOptionMultiServiceImpl()

Arcane::CaseOptionMultiServiceImpl::~CaseOptionMultiServiceImpl ( )

Definition at line 349 of file CaseOptionService.cc.

Member Function Documentation

◆ _defaultValue()

String Arcane::CaseOptionMultiServiceImpl::_defaultValue ( ) const

inlineprotected

Definition at line 176 of file CaseOptionServiceImpl.h.

◆ _setNotifyAllocateFunctor()

void Arcane::CaseOptionMultiServiceImpl::_setNotifyAllocateFunctor ( IFunctor * f )

inline

Definition at line 169 of file CaseOptionServiceImpl.h.

◆ getAvailableNames()

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

Returns the valid implementation names for this service in names.

Definition at line 558 of file CaseOptionService.cc.

◆ meshName()

String Arcane::CaseOptionMultiServiceImpl::meshName ( ) const

inline

Definition at line 165 of file CaseOptionServiceImpl.h.

◆ multiAllocate()

void Arcane::CaseOptionMultiServiceImpl::multiAllocate ( const XmlNodeList & elem_list )

overridevirtual

Implements Arcane::ICaseOptionsMulti.

Definition at line 381 of file CaseOptionService.cc.

◆ serviceName()

String Arcane::CaseOptionMultiServiceImpl::serviceName ( Integer index ) const

inline

Name of the nth service.

Definition at line 148 of file CaseOptionServiceImpl.h.

References m_services_name.

◆ setContainer()

void Arcane::CaseOptionMultiServiceImpl::setContainer ( ICaseOptionServiceContainer * container )

Positions the instance container.

container remains the property of the caller, who must manage its lifetime.

Definition at line 357 of file CaseOptionService.cc.

◆ setMeshName()

void Arcane::CaseOptionMultiServiceImpl::setMeshName ( const String & mesh_name )

inline

Definition at line 164 of file CaseOptionServiceImpl.h.

◆ visit()

void Arcane::CaseOptionMultiServiceImpl::visit ( ICaseDocumentVisitor * visitor ) const

overridevirtual

Applies the visitor to this option.

Implements Arcane::ICaseOptions.

Definition at line 366 of file CaseOptionService.cc.

References m_allocated_options.

Member Data Documentation

◆ m_allocated_options

UniqueArray<ReferenceCounter<ICaseOptions> > Arcane::CaseOptionMultiServiceImpl::m_allocated_options

protected

List of allocated options that must be deleted.

Definition at line 186 of file CaseOptionServiceImpl.h.

Referenced by visit().

◆ m_allow_null

bool Arcane::CaseOptionMultiServiceImpl::m_allow_null

protected

Definition at line 180 of file CaseOptionServiceImpl.h.

◆ m_container

ICaseOptionServiceContainer* Arcane::CaseOptionMultiServiceImpl::m_container

protected

Definition at line 184 of file CaseOptionServiceImpl.h.

◆ m_default_value

String Arcane::CaseOptionMultiServiceImpl::m_default_value

protected

Definition at line 181 of file CaseOptionServiceImpl.h.

◆ m_mesh_name

String Arcane::CaseOptionMultiServiceImpl::m_mesh_name

protected

Definition at line 182 of file CaseOptionServiceImpl.h.

◆ m_notify_functor

IFunctor* Arcane::CaseOptionMultiServiceImpl::m_notify_functor

protected

Definition at line 183 of file CaseOptionServiceImpl.h.

◆ m_services_name

UniqueArray<String> Arcane::CaseOptionMultiServiceImpl::m_services_name

protected

Service names for each occurrence.

Definition at line 188 of file CaseOptionServiceImpl.h.

Referenced by serviceName().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaseOptionMultiServiceImpl()

◆ ~CaseOptionMultiServiceImpl()

Member Function Documentation

◆ _defaultValue()

◆ _setNotifyAllocateFunctor()

◆ getAvailableNames()

◆ meshName()

◆ multiAllocate()

◆ serviceName()

◆ setContainer()

◆ setMeshName()

◆ visit()

Member Data Documentation

◆ m_allocated_options

◆ m_allow_null

◆ m_container

◆ m_default_value

◆ m_mesh_name

◆ m_notify_functor

◆ m_services_name