Arcane  4.2.3.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::ArcaNetReader

Classe permettant de lire les fichiers ArcaNet. Plus de détails...

#include <arccore/common/ArcaNetReader.h>

Fonctions membres publiques

 ArcaNetReader (const JSONValue &root)
 Constructeur.
void init (const String &case_and_variations_values, const String &prog_name)
 Méthode permettant d'initialiser le lecteur de fichier.
void read ()
 Méthode permettant de lire le fichier et de remplir la chaîne de dépendances. Il faut d'abord appeler la méthode 'init()'.
ArrayView< JSONValue > jsonValues ()
 Méthode permettant d'obtenir toutes les JSONValue à lire, en suivant la chaîne de dépendances.
JSONValue extractFilePart (const JSONValue &config_part)
 Méthode permettant d'obtenir la partie fichier d'une JSONValue (à partir du tableau 'jsonValues()').
JSONValue extractProgPart (const JSONValue &config_part)
 Méthode permettant d'obtenir la partie programme d'une JSONValue (à partir du tableau 'jsonValues()').
JSONValue extractPart (const String &part_name, const JSONValue &config_part)
 Méthode permettant d'obtenir une partie d'une JSONValue (à partir du tableau 'jsonValues()').
bool computePath () const
 Méthode permettant de déterminer si le chemin est enregistré. Pour activer l'enregistrement, il est possible de définir la variable d'environnement ARCCORE_ARCANET_PATH.
String path () const
 Méthode permettant d'obtenir le chemin des dépendances.
String configPartName ()
 Méthode permettant d'obtenir le nom final de la partie programme.

Description détaillée

Classe permettant de lire les fichiers ArcaNet.

Définition à la ligne 200 du fichier ArcaNetReader.h.

Documentation des constructeurs et destructeur

◆ ArcaNetReader()

Arcane::ArcaNetReader::ArcaNetReader ( const JSONValue & root)

Constructeur.

Paramètres
rootélément racine du fichier ArcaNet.

Définition à la ligne 29 du fichier ArcaNetReader.cc.

Documentation des fonctions membres

◆ computePath()

bool Arcane::ArcaNetReader::computePath ( ) const
inline

Méthode permettant de déterminer si le chemin est enregistré. Pour activer l'enregistrement, il est possible de définir la variable d'environnement ARCCORE_ARCANET_PATH.

Définition à la ligne 266 du fichier ArcaNetReader.h.

◆ configPartName()

String Arcane::ArcaNetReader::configPartName ( )
inline

Méthode permettant d'obtenir le nom final de la partie programme.

Définition à la ligne 276 du fichier ArcaNetReader.h.

Références Arcane::String::empty().

◆ extractFilePart()

JSONValue Arcane::ArcaNetReader::extractFilePart ( const JSONValue & config_part)

Méthode permettant d'obtenir la partie fichier d'une JSONValue (à partir du tableau 'jsonValues()').

Paramètres
config_partUn élément du tableau 'jsonValues()'.
Renvoie
La partie fichier.

Définition à la ligne 114 du fichier ArcaNetReader.cc.

Références Arcane::JSONValue::child().

◆ extractPart()

JSONValue Arcane::ArcaNetReader::extractPart ( const String & part_name,
const JSONValue & config_part )

Méthode permettant d'obtenir une partie d'une JSONValue (à partir du tableau 'jsonValues()').

Paramètres
part_nameLe nom de la partie à obtenir.
config_partUn élément du tableau 'jsonValues()'.
Renvoie
La partie json.

Définition à la ligne 139 du fichier ArcaNetReader.cc.

Références Arcane::JSONValue::child().

◆ extractProgPart()

JSONValue Arcane::ArcaNetReader::extractProgPart ( const JSONValue & config_part)

Méthode permettant d'obtenir la partie programme d'une JSONValue (à partir du tableau 'jsonValues()').

Paramètres
config_partUn élément du tableau 'jsonValues()'.
Renvoie
La partie programme.

Définition à la ligne 123 du fichier ArcaNetReader.cc.

Références Arcane::JSONValue::child(), et Arcane::JSONValue::null().

◆ init()

void Arcane::ArcaNetReader::init ( const String & case_and_variations_values,
const String & prog_name )

Méthode permettant d'initialiser le lecteur de fichier.

Paramètres
case_and_variations_valuesLe nom du cas avec les valeurs de variation (exemple : "case1~init:nb_proc=4").
prog_nameNom du programme à lire dans le fichier (exemple : "arcane').

Définition à la ligne 39 du fichier ArcaNetReader.cc.

Références Arcane::Array< T >::add(), ARCCORE_FATAL, Arcane::String::empty(), Arcane::AbstractArray< T >::size(), et Arcane::String::split().

◆ jsonValues()

ArrayView< JSONValue > Arcane::ArcaNetReader::jsonValues ( )
inline

Méthode permettant d'obtenir toutes les JSONValue à lire, en suivant la chaîne de dépendances.

Définition à la ligne 231 du fichier ArcaNetReader.h.

◆ path()

String Arcane::ArcaNetReader::path ( ) const
inline

Méthode permettant d'obtenir le chemin des dépendances.

Définition à la ligne 271 du fichier ArcaNetReader.h.

◆ read()

void Arcane::ArcaNetReader::read ( )

Méthode permettant de lire le fichier et de remplir la chaîne de dépendances. Il faut d'abord appeler la méthode 'init()'.

Définition à la ligne 84 du fichier ArcaNetReader.cc.

Références ARCCORE_FATAL, Arcane::JSONValue::child(), Arcane::JSONValue::isNull(), et Arcane::JSONValue::null().


La documentation de cette classe a été générée à partir des fichiers suivants :