Référence de la classe Arcane::IIOMng

Interface du gestionnaire des entrées sorties. Plus de détails...

#include <arcane/core/IIOMng.h>

Fonctions membres publiques
virtual	~IIOMng ()=default
	Libère les ressources.
virtual IXmlDocumentHolder *	parseXmlFile (const String &filename, const String &schemaname=String{})=0
	Lit et analyse le fichier XML filename.
virtual IXmlDocumentHolder *	parseXmlFile (const String &filename, const String &schemaname, ConstArrayView< Byte > schema_data)=0
	Lit et analyse le fichier XML filename.
virtual IXmlDocumentHolder *	parseXmlBuffer (Span< const Byte > buffer, const String &name)=0
	Lit et analyse le fichier XML contenu dans le buffer buffer.
virtual IXmlDocumentHolder *	parseXmlBuffer (Span< const std::byte > buffer, const String &name)=0
	Lit et analyse le fichier XML contenu dans le buffer buffer.
virtual IXmlDocumentHolder *	parseXmlString (const String &str, const String &name)=0
	Lit et analyse le fichier XML contenu dans la chaîne str.
virtual bool	writeXmlFile (IXmlDocumentHolder *doc, const String &filename, const bool indented=false)=0
	Ecrit l'arbre XML du document doc dans le fichier filename.
virtual bool	collectiveRead (const String &filename, ByteArray &bytes)=0
	Lecture collective d'un fichier.
virtual bool	collectiveRead (const String &filename, ByteArray &bytes, bool is_binary)=0
	Lecture collective d'un fichier.
virtual bool	localRead (const String &filename, ByteArray &bytes)=0
	Lecture locale d'un fichier.
virtual bool	localRead (const String &filename, ByteArray &bytes, bool is_binary)=0
	Lecture locale d'un fichier.

Description détaillée

Interface du gestionnaire des entrées sorties.

Définition à la ligne 35 du fichier IIOMng.h.

Documentation des fonctions membres

collectiveRead() [1/2]

virtual bool Arcane::IIOMng::collectiveRead ( const String & filename, ByteArray & bytes )

pure virtual

Lecture collective d'un fichier.

Lit collectivement le fichier filename et retourne son contenu dans bytes. Le fichier est considéré comme un fichier binaire. La lecture collective signifie que l'ensemble des processeurs appellent cette opération et vont lire le même fichier. L'implémentation peut alors optimiser les accès disque en regroupant la lecture effective sur un ou plusieurs processeurs puis envoyer le contenu du fichier sur les autres.

Valeurs retournées

true	en cas d'erreur
false	si tout est ok.

collectiveRead() [2/2]

virtual bool Arcane::IIOMng::collectiveRead ( const String & filename, ByteArray & bytes, bool is_binary )

pure virtual

Lecture collective d'un fichier.

Lit collectivement le fichier filename et retourne son contenu dans bytes. Le fichier est considéré comme un fichier binaire si is_binary est vrai. La lecture collective signifie que l'ensemble des processeurs appellent cette opération et vont lire le même fichier. L'implémentation peut alors optimiser les accès disque en regroupant la lecture effective sur un ou plusieurs processeurs puis envoyer le contenu du fichier sur les autres.

Valeurs retournées

true	en cas d'erreur
false	si tout est ok.

localRead() [1/2]

virtual bool Arcane::IIOMng::localRead ( const String & filename, ByteArray & bytes )

pure virtual

Lecture locale d'un fichier.

Lit localement le fichier filename et retourne son contenu dans bytes. Le fichier est considéré comme un fichier binaire. Cette opération n'est pas collective.

Valeurs retournées

true	en cas d'erreur.
false	si tout est ok.

Avertissement

retourne aussi true si le fichier est vide.

si le ByteUniqueArray doit être converti en String, il faut y ajouter un 0 terminal au préalable (bytes.add(0))

localRead() [2/2]

virtual bool Arcane::IIOMng::localRead ( const String & filename, ByteArray & bytes, bool is_binary )

pure virtual

Lecture locale d'un fichier.

Lit localement le fichier filename et retourne son contenu dans bytes. Cette opération n'est pas collective.

Valeurs retournées

true	en cas d'erreur.
false	si tout est ok.

Avertissement

retourne aussi true si le fichier est vide.

si le ByteUniqueArray doit être converti en String, il faut y ajouter un 0 terminal au préalable (bytes.add(0))

parseXmlBuffer() [1/2]

virtual IXmlDocumentHolder * Arcane::IIOMng::parseXmlBuffer ( Span< const Byte > buffer, const String & name )

pure virtual

Lit et analyse le fichier XML contenu dans le buffer buffer.

En cas d'erreur, retourne 0. L'appelant est propriétaire de l'instance retournée et doit la détruire par l'opérateur delete. L'argument name associe un nom à la zone mémoire qui est utilisé pour afficher les messages d'erreur.

Référencé par Arcane::Hdf5VariableReaderHelper2::open().

parseXmlBuffer() [2/2]

virtual IXmlDocumentHolder * Arcane::IIOMng::parseXmlBuffer ( Span< const std::byte > buffer, const String & name )

pure virtual

Lit et analyse le fichier XML contenu dans le buffer buffer.

En cas d'erreur, retourne 0. L'appelant est propriétaire de l'instance retournée et doit la détruire par l'opérateur delete. L'argument name associe un nom à la zone mémoire qui est utilisé pour afficher les messages d'erreur.

parseXmlFile() [1/2]

virtual IXmlDocumentHolder * Arcane::IIOMng::parseXmlFile ( const String & filename, const String & schemaname, ConstArrayView< Byte > schema_data )

pure virtual

Lit et analyse le fichier XML filename.

En cas d'erreur, retourne 0. L'appelant est propriétaire de l'instance retournée et doit la détruire par l'opérateur delete. La cohérence du fichier relativement au schéma est vérifiée; Le nom du schéma est donnée uniquement pour traitement des messages d'erreurs.

parseXmlFile() [2/2]

virtual IXmlDocumentHolder * Arcane::IIOMng::parseXmlFile ( const String & filename, const String & schemaname = String{} )

pure virtual

Lit et analyse le fichier XML filename.

En cas d'erreur, retourne 0. L'appelant est propriétaire de l'instance retournée et doit la détruire par l'opérateur delete. Si un nom de schéma est spécifié, la cohérence du fichier relativement au schéma est vérifiée.

Référencé par Arcane::Hdf5VariableReaderHelper::open().

parseXmlString()

virtual IXmlDocumentHolder * Arcane::IIOMng::parseXmlString ( const String & str, const String & name )

pure virtual

Lit et analyse le fichier XML contenu dans la chaîne str.

En cas d'erreur, retourne 0. L'appelant est propriétaire de l'instance retournée et doit la détruire par l'opérateur delete. L'argument name associe un nom à la zone mémoire qui est utilisé pour afficher les messages d'erreur.

writeXmlFile()

virtual bool Arcane::IIOMng::writeXmlFile ( IXmlDocumentHolder * doc, const String & filename, const bool indented = false )

pure virtual

Ecrit l'arbre XML du document doc dans le fichier filename.

Valeurs retournées

true	en cas d'erreur,

Renvoie

false en cas de succès.

Référencé par Arcane::ManualHdf5VariableWriter::notifyEndWrite().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• IIOMng.h