Arcane::CaseOptionsMulti Class Reference

Base class for an array of complex data set options. More...

#include <arcane/core/CaseOptionsMulti.h>

Inheritance diagram for Arcane::CaseOptionsMulti:

Collaboration diagram for Arcane::CaseOptionsMulti:

Public Member Functions
	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
Public Member Functions inherited from Arcane::ICaseOptionsMulti
virtual void	multiAllocate (const XmlNodeList &)=0

Private Attributes
UniqueArray< ICaseOptionList * >	m_values

Additional Inherited Members
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 inherited from Arcane::CaseOptions
CaseOptionsPrivate *	m_p
	Implementation.

Detailed Description

Base class for an array of complex data set options.

Definition at line 33 of file CaseOptionsMulti.h.

Constructor & Destructor Documentation

CaseOptionsMulti() [1/2]

Arcane::CaseOptionsMulti::CaseOptionsMulti	(	ICaseMng *	cm,
		const String &	tag_root_name,
		const XmlNode &	element,
		Integer	min_occurs,
		Integer	max_occurs )

Definition at line 625 of file CaseOptions.cc.

CaseOptionsMulti() [2/2]

Arcane::CaseOptionsMulti::CaseOptionsMulti	(	ICaseOptionList *	parent,
		const String &	tag_root_name,
		const XmlNode &	element,
		Integer	min_occurs,
		Integer	max_occurs )

Definition at line 637 of file CaseOptions.cc.

Member Function Documentation

addChild()

void Arcane::CaseOptionsMulti::addChild ( ICaseOptionList * v )

inlineoverridevirtual

Implements Arcane::ICaseOptionsMulti.

Definition at line 47 of file CaseOptionsMulti.h.

child()

ICaseOptionList * Arcane::CaseOptionsMulti::child ( Integer index ) const

inlineoverridevirtual

Implements Arcane::ICaseOptionsMulti.

Definition at line 49 of file CaseOptionsMulti.h.

nbChildren()

Integer Arcane::CaseOptionsMulti::nbChildren ( ) const

inlineoverridevirtual

Implements Arcane::ICaseOptionsMulti.

Definition at line 48 of file CaseOptionsMulti.h.

toCaseOptions()

ICaseOptions * Arcane::CaseOptionsMulti::toCaseOptions ( )

inlineoverridevirtual

Implements Arcane::ICaseOptionsMulti.

Definition at line 46 of file CaseOptionsMulti.h.

toCaseOptionsMulti()

ICaseOptionsMulti * Arcane::CaseOptionsMulti::toCaseOptionsMulti ( )

inline

Definition at line 50 of file CaseOptionsMulti.h.

Member Data Documentation

m_values

UniqueArray<ICaseOptionList*> Arcane::CaseOptionsMulti::m_values

private

Definition at line 54 of file CaseOptionsMulti.h.

---

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

• CaseOptionsMulti.h
• CaseOptions.cc