Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
CaseOptionsArcanePostProcessing::CaseOptionOutput Class Reference
Inheritance diagram for CaseOptionsArcanePostProcessing::CaseOptionOutput:
Collaboration diagram for CaseOptionsArcanePostProcessing::CaseOptionOutput:

Public Member Functions

 CaseOptionOutput (Arcane::ICaseOptionList *icl, const Arcane::String &s, const Arcane::XmlNode &element, bool is_optional=false)
const CaseOptionOutput & operator() () const
Arcane::ConstArrayView< Arcane::StringgetVariable ()
Arcane::ConstArrayView< Arcane::ItemGroupgetGroup ()
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
IServiceInfocaseServiceInfo () const override
 Returns the associated service or 0 if none exists.
IModulecaseModule () 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.
ICaseOptionListconfigList () override
const ICaseOptionListconfigList () const override
ICaseFunctionactivateFunction () 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.
ICaseMngcaseMng () const override
ITraceMngtraceMng () const override
ISubDomainsubDomain () const override
 Associated sub-domain.
IMeshmesh () const override
MeshHandle meshHandle () const override
ICaseDocumentcaseDocument () const override
ICaseDocumentFragmentcaseDocumentFragment () 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< ICaseOptionstoReference () override

Public Attributes

Arcane::CaseOptionMultiSimpleT< Arcane::Stringvariable
Arcane::CaseOptionMultiExtendedT< Arcane::ItemGroupgroup

Private Member Functions

Arcane::ICaseOptionList_configList ()
Arcane::XmlNode _element ()

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
CaseOptionsPrivatem_p
 Implementation.

Detailed Description

Definition at line 46 of file ArcanePostProcessing_axl.h.

Constructor & Destructor Documentation

◆ CaseOptionOutput()

CaseOptionsArcanePostProcessing::CaseOptionOutput::CaseOptionOutput ( Arcane::ICaseOptionList * icl,
const Arcane::String & s,
const Arcane::XmlNode & element,
bool is_optional = false )
inline

Definition at line 51 of file ArcanePostProcessing_axl.h.

Member Function Documentation

◆ _configList()

Arcane::ICaseOptionList * CaseOptionsArcanePostProcessing::CaseOptionOutput::_configList ( )
inlineprivate

Definition at line 95 of file ArcanePostProcessing_axl.h.

◆ _element()

Arcane::XmlNode CaseOptionsArcanePostProcessing::CaseOptionOutput::_element ( )
inlineprivate

Definition at line 96 of file ArcanePostProcessing_axl.h.

◆ getGroup()

Arcane::ConstArrayView< Arcane::ItemGroup > CaseOptionsArcanePostProcessing::CaseOptionOutput::getGroup ( )
inline

Definition at line 87 of file ArcanePostProcessing_axl.h.

◆ getVariable()

Arcane::ConstArrayView< Arcane::String > CaseOptionsArcanePostProcessing::CaseOptionOutput::getVariable ( )
inline

Definition at line 85 of file ArcanePostProcessing_axl.h.

◆ operator()()

const CaseOptionOutput & CaseOptionsArcanePostProcessing::CaseOptionOutput::operator() ( ) const
inline

Definition at line 80 of file ArcanePostProcessing_axl.h.

Member Data Documentation

◆ group

Arcane::CaseOptionMultiExtendedT< Arcane::ItemGroup > CaseOptionsArcanePostProcessing::CaseOptionOutput::group

Definition at line 101 of file ArcanePostProcessing_axl.h.

◆ variable

Arcane::CaseOptionMultiSimpleT< Arcane::String > CaseOptionsArcanePostProcessing::CaseOptionOutput::variable

Definition at line 100 of file ArcanePostProcessing_axl.h.


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