Data set option list containing multiple identical children. More...

Inheritance diagram for Arcane::CaseOptionListMulti:

Collaboration diagram for Arcane::CaseOptionListMulti:

Public Types
typedef std::pair< CaseOptionBase *, XmlNode >	CaseOptionBasePair
typedef std::vector< CaseOptionBasePair >	CaseOptionBasePairList
Public Types inherited from Arcane::CaseOptionList
typedef std::pair< CaseOptionBase *, XmlNode >	CaseOptionBasePair
typedef std::vector< CaseOptionBasePair >	CaseOptionBasePairList

Public Member Functions
	CaseOptionListMulti (ICaseOptionsMulti com, ICaseOptions co, ICaseMng *m, const XmlNode &element, Integer min_occurs, Integer max_occurs)
	CaseOptionListMulti (ICaseOptionsMulti com, ICaseOptions co, ICaseOptionList *parent, const XmlNode &element, Integer min_occurs, Integer max_occurs)
bool	isOptional () const override
	Indicates if the option is optional.
Integer	minOccurs () const override
	Minimum number of occurrences.
Integer	maxOccurs () const override
	Maximum number of occurrences.
void	readChildren (bool is_phase1) override
	Reads the option values from the DOM elements.
void	addInvalidChildren (XmlNodeList &nlist) override
	Adds child elements that do not correspond to options in nlist.
void	printChildren (const String &lang, int indent) override
	Displays the list of child options in language lang and their value.
void	deepGetChildren (Array< CaseOptionBase * > &col) override
	Adds all child options to the list col.
void	visit (ICaseDocumentVisitor *visitor) override
	Applies the visitor visitor.
void	_checkMinMaxOccurs (Integer nb_occur)
Public Member Functions inherited from Arcane::CaseOptionList
	CaseOptionList (ICaseMng m, ICaseOptions ref_opt, XmlNode parent_element)
	CaseOptionList (ICaseOptionList parent, ICaseOptions ref_opt, XmlNode parent_element)
XmlNode	rootElement () const override
	Returns the element associated with this options list.
XmlNode	parentElement () const override
	Returns the parent element.
ICaseMng *	caseMng () const override
	Returns the case manager.
void	addConfig (CaseOptionBase *cbi, XmlNode parent) override
	Adds option o with parent parent.
void	addChild (ICaseOptions *c) override
	Adds the list co to the list of children.
void	removeChild (ICaseOptions *c) override
	Removes co from the list of children.
String	rootTagName () const override
	Returns the name of the element of this list.
void	setOptional (bool v)
void	setRootElementWithParent (XmlNode parent_element) override
	Positions the root element of the list, with parent_element as parent. If already positioned, does nothing.
void	setRootElement (XmlNode root_element) override
	Positions the root element of the list. If already positioned, throws an exception.
bool	isPresent () const override
	Indicates if the option is present in the data set.
void	setIsMulti (bool v)
	Indicates if the option can be present multiple times.
String	xpathFullName () const override
	Full name in XPath format corresponding to rootElement().
MeshHandle	meshHandle () const override
	Handle of the associated mesh.
ICaseDocumentFragment *	caseDocumentFragment () const override
	Associated document.
void	disable () override
	Disables the option as if it were absent.
virtual ICaseOptionListInternal *	_internalApi () override
	Internal Arcane API.
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const
Public Member Functions inherited from Arcane::ReferenceCounterImpl
void	addReference ()
void	removeReference ()
void	_internalAddReference ()
bool	_internalRemoveReference ()

Protected Member Functions
XmlNode	_rootElement (Integer position) const
Protected Member Functions inherited from Arcane::CaseOptionList
void	_addInvalidChildren (XmlNode parent, XmlNodeList &nlist)
void	_searchChildren (bool is_phase1)
void	_setRootElement (bool force_init, XmlNode parent_element)
void	_strIndent (char *buf, int indent, int max_indent)
void	_printOption (const String &lang, int indent, CaseOptionBase *co, std::ostream &o)
bool	_isValidChildTagName (const String &name)
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const

Private Attributes
ICaseOptionsMulti *	m_case_option_multi
UniqueArray< ICaseOptionList * >	m_case_config_list
XmlNodeList	m_root_element_list
Integer	m_min_occurs
Integer	m_max_occurs

Additional Inherited Members
Protected Attributes inherited from Arcane::CaseOptionList
ICaseMng *	m_case_mng
XmlNode	m_root_element
	Root element for this option list.
ICaseOptionList *	m_parent
ICaseOptions *	m_ref_opt
CaseOptionBasePairList	m_config_list
	List of configuration values.
std::vector< ICaseOptions * >	m_case_options
XmlNode	m_parent_element
	Parent element.
bool	m_is_present
bool	m_is_multi
bool	m_is_optional
bool	m_is_disabled = false
InternalApi	m_internal_api

Detailed Description

Data set option list containing multiple identical children.

Definition at line 566 of file CaseOptionList.cc.

Member Typedef Documentation

◆ CaseOptionBasePair

typedef std::pair<CaseOptionBase*, XmlNode> Arcane::CaseOptionListMulti::CaseOptionBasePair

Definition at line 571 of file CaseOptionList.cc.

◆ CaseOptionBasePairList

typedef std::vector<CaseOptionBasePair> Arcane::CaseOptionListMulti::CaseOptionBasePairList

Definition at line 572 of file CaseOptionList.cc.

Constructor & Destructor Documentation

◆ CaseOptionListMulti() [1/2]

Arcane::CaseOptionListMulti::CaseOptionListMulti	(	ICaseOptionsMulti *	com,
		ICaseOptions *	co,
		ICaseMng *	m,
		const XmlNode &	element,
		Integer	min_occurs,
		Integer	max_occurs )

inline

Definition at line 576 of file CaseOptionList.cc.

◆ CaseOptionListMulti() [2/2]

Arcane::CaseOptionListMulti::CaseOptionListMulti	(	ICaseOptionsMulti *	com,
		ICaseOptions *	co,
		ICaseOptionList *	parent,
		const XmlNode &	element,
		Integer	min_occurs,
		Integer	max_occurs )

inline

Definition at line 583 of file CaseOptionList.cc.

Member Function Documentation

◆ _checkMinMaxOccurs()

void Arcane::CaseOptionListMulti::_checkMinMaxOccurs ( Integer nb_occur )

Definition at line 716 of file CaseOptionList.cc.

◆ _rootElement()

XmlNode Arcane::CaseOptionListMulti::_rootElement ( Integer position ) const

inlineprotected

Definition at line 606 of file CaseOptionList.cc.

◆ addInvalidChildren()

void Arcane::CaseOptionListMulti::addInvalidChildren ( XmlNodeList & nlist )

overridevirtual

Adds child elements that do not correspond to options in nlist.

Reimplemented from Arcane::CaseOptionList.

Definition at line 667 of file CaseOptionList.cc.

◆ deepGetChildren()

void Arcane::CaseOptionListMulti::deepGetChildren ( Array< CaseOptionBase * > & col )

overridevirtual

Adds all child options to the list col.

Reimplemented from Arcane::CaseOptionList.

Definition at line 692 of file CaseOptionList.cc.

◆ isOptional()

bool Arcane::CaseOptionListMulti::isOptional ( ) const

inlineoverridevirtual

Indicates if the option is optional.

Reimplemented from Arcane::CaseOptionList.

Definition at line 594 of file CaseOptionList.cc.

◆ maxOccurs()

Integer Arcane::CaseOptionListMulti::maxOccurs ( ) const

inlineoverridevirtual

Maximum number of occurrences.

Reimplemented from Arcane::CaseOptionList.

Definition at line 596 of file CaseOptionList.cc.

◆ minOccurs()

Integer Arcane::CaseOptionListMulti::minOccurs ( ) const

inlineoverridevirtual

Minimum number of occurrences.

Reimplemented from Arcane::CaseOptionList.

Definition at line 595 of file CaseOptionList.cc.

◆ printChildren()

void Arcane::CaseOptionListMulti::printChildren	(	const String &	lang,
		int	indent )

overridevirtual

Displays the list of child options in language lang and their value.

Reimplemented from Arcane::CaseOptionList.

Definition at line 680 of file CaseOptionList.cc.

◆ readChildren()

void Arcane::CaseOptionListMulti::readChildren ( bool is_phase1 )

overridevirtual

Reads the option values from the DOM elements.

Reimplemented from Arcane::CaseOptionList.

Definition at line 625 of file CaseOptionList.cc.

References Arcane::ICaseOptionList::_internalApi(), ARCANE_FATAL, Arcane::TraceAccessor::info(), Arcane::CaseOptionList::m_config_list, Arcane::CaseOptionList::m_parent_element, Arcane::CaseOptionList::m_root_element, Arcane::CaseOptionList::rootTagName(), and Arcane::ICaseOptionListInternal::setRootElement().

Here is the call graph for this function:

◆ visit()

void Arcane::CaseOptionListMulti::visit ( ICaseDocumentVisitor * visitor )

overridevirtual

Applies the visitor visitor.

Reimplemented from Arcane::CaseOptionList.

Definition at line 704 of file CaseOptionList.cc.

Member Data Documentation

◆ m_case_config_list

UniqueArray<ICaseOptionList*> Arcane::CaseOptionListMulti::m_case_config_list

private

Definition at line 614 of file CaseOptionList.cc.

◆ m_case_option_multi

ICaseOptionsMulti* Arcane::CaseOptionListMulti::m_case_option_multi

private

Definition at line 613 of file CaseOptionList.cc.

◆ m_max_occurs

Integer Arcane::CaseOptionListMulti::m_max_occurs

private

Definition at line 617 of file CaseOptionList.cc.

◆ m_min_occurs

Integer Arcane::CaseOptionListMulti::m_min_occurs

private

Definition at line 616 of file CaseOptionList.cc.

◆ m_root_element_list

XmlNodeList Arcane::CaseOptionListMulti::m_root_element_list

private

Definition at line 615 of file CaseOptionList.cc.

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

CaseOptionList.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CaseOptionBasePair

◆ CaseOptionBasePairList

Constructor & Destructor Documentation

◆ CaseOptionListMulti() [1/2]

◆ CaseOptionListMulti() [2/2]

Member Function Documentation

◆ _checkMinMaxOccurs()

◆ _rootElement()

◆ addInvalidChildren()

◆ deepGetChildren()

◆ isOptional()

◆ maxOccurs()

◆ minOccurs()

◆ printChildren()

◆ readChildren()

◆ visit()

Member Data Documentation

◆ m_case_config_list

◆ m_case_option_multi

◆ m_max_occurs

◆ m_min_occurs

◆ m_root_element_list