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

Public Types

typedef Arcane::ArrayView< CaseOptionWriteValue * > BaseClass
typedef CaseOptionWriteValue value_type

Public Member Functions

 CaseOptionWrite (Arcane::ICaseOptionList *icl, const Arcane::String &s, const Arcane::XmlNode &element)
BaseClass operator() ()
const value_type & operator[] (Arcane::Integer i) const
value_type & operator[] (Arcane::Integer i)
Arcane::Integer count () const
Arcane::Integer size () const
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)
ICaseOptionstoCaseOptions () override
void addChild (ICaseOptionList *v) override
Integer nbChildren () const override
ICaseOptionListchild (Integer index) const override
ICaseOptionsMultitoCaseOptionsMulti ()
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

Protected Member Functions

void multiAllocate (const Arcane::XmlNodeList &elist)
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.

Additional Inherited Members

Protected Attributes inherited from Arcane::CaseOptions
CaseOptionsPrivatem_p
 Implementation.
Private Types inherited from Arcane::ArrayView< CaseOptionWriteValue * >
using ThatClass
typedef CaseOptionWriteValue * value_type
 Type of the array elements.
typedef value_typepointer
 Pointer type of an array element.
typedef const value_typeconst_pointer
 Constant pointer type of an array element.
typedef ArrayIterator< pointeriterator
 Type of the iterator over an array element.
typedef ArrayIterator< const_pointerconst_iterator
 Type of the constant iterator over an array element.
typedef value_typereference
 Reference type of an array element.
typedef const value_typeconst_reference
 Constant reference type of an array element.
typedef Integer size_type
 Type indexing the array.
typedef std::ptrdiff_t difference_type
 Type of a distance between array iterator elements.
typedef IterT< ArrayView< CaseOptionWriteValue * > > iter
 Type of an iterator over the entire array.
typedef ConstIterT< ArrayView< CaseOptionWriteValue * > > const_iter
 Type of a constant iterator over the entire array.
typedef std::reverse_iterator< iteratorreverse_iterator
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
using ThatClass
typedef CaseOptionWriteValue * value_type
 Type of the array elements.
typedef value_typepointer
 Pointer type of an array element.
typedef const value_typeconst_pointer
 Constant pointer type of an array element.
typedef ArrayIterator< pointeriterator
 Type of the iterator over an array element.
typedef ArrayIterator< const_pointerconst_iterator
 Type of the constant iterator over an array element.
typedef value_typereference
 Reference type of an array element.
typedef const value_typeconst_reference
 Constant reference type of an array element.
typedef Integer size_type
 Type indexing the array.
typedef std::ptrdiff_t difference_type
 Type of a distance between array iterator elements.
typedef IterT< ArrayView< CaseOptionWriteValue * > > iter
 Type of an iterator over the entire array.
typedef ConstIterT< ArrayView< CaseOptionWriteValue * > > const_iter
 Type of a constant iterator over the entire array.
typedef std::reverse_iterator< iteratorreverse_iterator
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
Private Member Functions inherited from Arcane::ArrayView< CaseOptionWriteValue * >
constexpr ArrayView () noexcept
 Constructs an empty view.
 ArrayView (const ArrayView< CaseOptionWriteValue * > &from)=default
 Copy constructor from another view.
constexpr ArrayView (Integer asize, pointer ptr) noexcept
 Constructs a view over a memory region starting at ptr and.
constexpr ArrayView (std::array< CaseOptionWriteValue *, N > &v)
ArrayView< CaseOptionWriteValue * > & operator= (const ArrayView< CaseOptionWriteValue * > &from)=default
 Copy assignment operator.
constexpr ArrayView< CaseOptionWriteValue * > & operator= (std::array< CaseOptionWriteValue *, N > &from)
constexpr reference operator[] (Integer i)
 i-th element of the array.
constexpr const_reference operator[] (Integer i) const
 i-th element of the array.
constexpr reference operator() (Integer i)
 i-th element of the array.
constexpr const_reference operator() (Integer i) const
 i-th element of the array.
constexpr const_reference item (Integer i) const
 i-th element of the array.
constexpr void setItem (Integer i, const_reference v)
 Sets the i-th element of the array.
constexpr Integer size () const noexcept
 Returns the size of the array.
constexpr Integer length () const noexcept
 Number of elements in the array.
constexpr iterator begin () noexcept
 Iterator to the first element of the array.
constexpr iterator end () noexcept
 Iterator to the first element after the end of the array.
constexpr const_iterator begin () const noexcept
 Constant iterator to the first element of the array.
constexpr const_iterator end () const noexcept
 Constant iterator to the first element after the end of the array.
constexpr reverse_iterator rbegin () noexcept
 Reverse iterator to the first element of the array.
constexpr const_reverse_iterator rbegin () const noexcept
 Reverse iterator to the first element of the array.
constexpr reverse_iterator rend () noexcept
 Reverse iterator to the first element after the end of the array.
constexpr const_reverse_iterator rend () const noexcept
 Reverse iterator to the first element after the end of the array.
ArrayRange< pointerrange ()
 Iteration range from the first to the last element.
ArrayRange< const_pointerrange () const
 Iteration range from the first to the last element.
constexpr pointer ptrAt (Integer index)
 Address of the index-th element.
constexpr const_pointer ptrAt (Integer index) const
 Address of the index-th element.
constexpr const_reference at (Integer i) const
void setAt (Integer i, const_reference value)
void fill (const CaseOptionWriteValue *&o) noexcept
 Fills the array with the value o.
constexpr ConstArrayView< CaseOptionWriteValue * > constView () const noexcept
 Constant view of this view.
constexpr ArrayView< CaseOptionWriteValue * > subView (Integer abegin, Integer asize) noexcept
 Sub-view starting from element abegin and containing asize elements.
constexpr ThatClass subPart (Integer abegin, Integer asize) noexcept
 Sub-view starting from element abegin and containing asize elements.
constexpr ConstArrayView< CaseOptionWriteValue * > subConstView (Integer abegin, Integer asize) const noexcept
 Constant sub-view starting from element abegin and containing asize elements.
constexpr ArrayView< CaseOptionWriteValue * > subViewInterval (Integer index, Integer nb_interval)
 Sub-view corresponding to the interval index over nb_interval.
constexpr ThatClass subPartInterval (Integer index, Integer nb_interval)
 Sub-view corresponding to the interval index over nb_interval.
void copy (const U &copy_array)
 Copies the array copy_array into the instance.
constexpr bool empty () const noexcept
 Returns true if the array is empty (zero dimension).
bool contains (const_reference v) const
 true if the array contains the element with value v
void setArray (const ArrayView< CaseOptionWriteValue * > &v) noexcept
constexpr pointer unguardedBasePointer () noexcept
 Pointer to the beginning of the view.
constexpr const_pointer unguardedBasePointer () const noexcept
 Constant pointer to the start of the view.
constexpr const_pointer data () const noexcept
 Pointer to the start of the view.
constexpr pointer data () noexcept
 Constant pointer to the start of the view.
constexpr ArrayView () noexcept
 Constructs an empty view.
 ArrayView (const ArrayView< CaseOptionWriteValue * > &from)=default
 Copy constructor from another view.
constexpr ArrayView (Integer asize, pointer ptr) noexcept
 Constructs a view over a memory region starting at ptr and.
constexpr ArrayView (std::array< CaseOptionWriteValue *, N > &v)
ArrayView< CaseOptionWriteValue * > & operator= (const ArrayView< CaseOptionWriteValue * > &from)=default
 Copy assignment operator.
constexpr ArrayView< CaseOptionWriteValue * > & operator= (std::array< CaseOptionWriteValue *, N > &from)
constexpr reference operator[] (Integer i)
 i-th element of the array.
constexpr const_reference operator[] (Integer i) const
 i-th element of the array.
constexpr reference operator() (Integer i)
 i-th element of the array.
constexpr const_reference operator() (Integer i) const
 i-th element of the array.
constexpr const_reference item (Integer i) const
 i-th element of the array.
constexpr void setItem (Integer i, const_reference v)
 Sets the i-th element of the array.
constexpr Integer size () const noexcept
 Returns the size of the array.
constexpr Integer length () const noexcept
 Number of elements in the array.
constexpr iterator begin () noexcept
 Iterator to the first element of the array.
constexpr const_iterator begin () const noexcept
 Constant iterator to the first element of the array.
constexpr iterator end () noexcept
 Iterator to the first element after the end of the array.
constexpr const_iterator end () const noexcept
 Constant iterator to the first element after the end of the array.
constexpr reverse_iterator rbegin () noexcept
 Reverse iterator to the first element of the array.
constexpr const_reverse_iterator rbegin () const noexcept
 Reverse iterator to the first element of the array.
constexpr reverse_iterator rend () noexcept
 Reverse iterator to the first element after the end of the array.
constexpr const_reverse_iterator rend () const noexcept
 Reverse iterator to the first element after the end of the array.
ArrayRange< pointerrange ()
 Iteration range from the first to the last element.
ArrayRange< const_pointerrange () const
 Iteration range from the first to the last element.
constexpr pointer ptrAt (Integer index)
 Address of the index-th element.
constexpr const_pointer ptrAt (Integer index) const
 Address of the index-th element.
constexpr const_reference at (Integer i) const
void setAt (Integer i, const_reference value)
void fill (const CaseOptionWriteValue *&o) noexcept
 Fills the array with the value o.
constexpr ConstArrayView< CaseOptionWriteValue * > constView () const noexcept
 Constant view of this view.
constexpr ArrayView< CaseOptionWriteValue * > subView (Integer abegin, Integer asize) noexcept
 Sub-view starting from element abegin and containing asize elements.
constexpr ThatClass subPart (Integer abegin, Integer asize) noexcept
 Sub-view starting from element abegin and containing asize elements.
constexpr ConstArrayView< CaseOptionWriteValue * > subConstView (Integer abegin, Integer asize) const noexcept
 Constant sub-view starting from element abegin and containing asize elements.
constexpr ArrayView< CaseOptionWriteValue * > subViewInterval (Integer index, Integer nb_interval)
 Sub-view corresponding to the interval index over nb_interval.
constexpr ThatClass subPartInterval (Integer index, Integer nb_interval)
 Sub-view corresponding to the interval index over nb_interval.
void copy (const U &copy_array)
 Copies the array copy_array into the instance.
constexpr bool empty () const noexcept
 Returns true if the array is empty (zero dimension).
bool contains (const_reference v) const
 true if the array contains the element with value v
void setArray (const ArrayView< CaseOptionWriteValue * > &v) noexcept
constexpr pointer unguardedBasePointer () noexcept
 Pointer to the beginning of the view.
constexpr const_pointer unguardedBasePointer () const noexcept
 Constant pointer to the start of the view.
constexpr const_pointer data () const noexcept
 Pointer to the start of the view.
constexpr pointer data () noexcept
 Constant pointer to the start of the view.
constexpr pointer _ptr () noexcept
 Returns a pointer to the array.
constexpr const_pointer _ptr () const noexcept
 Returns a pointer to the array.
void _setArray (pointer v, Integer s) noexcept
 Modifies the pointer and size of the array.
void _setPtr (pointer v) noexcept
 Modifies the pointer to the start of the array.
void _setSize (Integer s) noexcept
 Modifies the size of the array.
constexpr pointer _ptr () noexcept
 Returns a pointer to the array.
constexpr const_pointer _ptr () const noexcept
 Returns a pointer to the array.
void _setArray (pointer v, Integer s) noexcept
 Modifies the pointer and size of the array.
void _setPtr (pointer v) noexcept
 Modifies the pointer to the start of the array.
void _setSize (Integer s) noexcept
 Modifies the size of the array.
Static Private Member Functions inherited from Arcane::ArrayView< CaseOptionWriteValue * >
static constexpr ThatClass create (pointer ptr, Integer asize) noexcept
 Constructs a view over a memory region starting at ptr and.
static constexpr ThatClass create (pointer ptr, Integer asize) noexcept
 Constructs a view over a memory region starting at ptr and.

Detailed Description

Definition at line 97 of file Hdf5VariableWriter_axl.h.

Member Typedef Documentation

◆ BaseClass

typedef Arcane::ArrayView< CaseOptionWriteValue * > Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::BaseClass

Definition at line 103 of file Hdf5VariableWriter_axl.h.

◆ value_type

typedef CaseOptionWriteValue Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::value_type

Definition at line 105 of file Hdf5VariableWriter_axl.h.

Constructor & Destructor Documentation

◆ CaseOptionWrite()

Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::CaseOptionWrite ( Arcane::ICaseOptionList * icl,
const Arcane::String & s,
const Arcane::XmlNode & element )
inline

Definition at line 109 of file Hdf5VariableWriter_axl.h.

◆ ~CaseOptionWrite()

Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::~CaseOptionWrite ( )
inline

Definition at line 137 of file Hdf5VariableWriter_axl.h.

Member Function Documentation

◆ count()

Arcane::Integer Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::count ( ) const
inline

Definition at line 154 of file Hdf5VariableWriter_axl.h.

◆ multiAllocate()

void Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::multiAllocate ( const Arcane::XmlNodeList & elist)
inlineprotectedvirtual

Implements Arcane::ICaseOptionsMulti.

Definition at line 122 of file Hdf5VariableWriter_axl.h.

◆ operator()()

BaseClass Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::operator() ( )
inline

Definition at line 119 of file Hdf5VariableWriter_axl.h.

◆ operator[]() [1/2]

value_type & Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::operator[] ( Arcane::Integer i)
inline

Definition at line 152 of file Hdf5VariableWriter_axl.h.

◆ operator[]() [2/2]

const value_type & Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::operator[] ( Arcane::Integer i) const
inline

Definition at line 150 of file Hdf5VariableWriter_axl.h.

◆ size()

Arcane::Integer Arcane::CaseOptionsHdf5VariableWriter::CaseOptionWrite::size ( ) const
inline

Definition at line 156 of file Hdf5VariableWriter_axl.h.


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