XMLIOSERVER 0.4
Serveur d'Entrées/Sorties parallèles
Référence de la classe xmlioserver::io::CINetCDF4

Classe permettant de lire les fichiers de données au format netCDF-4. Plus de détails...

#include <inetcdf4.hpp>

Liste de tous les membres

Types publics

typedef std::vector< std::string > CNetCDF4Path
 Redéfinition de std::vector<std::string> pour simplification d'écriture.

Fonctions membres publiques

 CINetCDF4 (void)
 Constructeur simple.
 CINetCDF4 (const std::string &_filename)
 Constructeur à partir d'un nom de fichier au format netCDF4.
 CINetCDF4 (const CINetCDF4 &_inetcdf4)
 Constructeur par copie .
 CINetCDF4 (const CINetCDF4 *const _inetcdf4_ptr)
 Constructeur par copie.
 ~CINetCDF4 (void)
 Destructeur de l'objet (le fichier est clos lors de son appel).

Attributs publics

CONetCDF4Path path
 Chemin vers le groupe de données en cours de lecture.
int ncidp
 Identifiant de fichiers netCDF.

Fonctions membres protégées

int getCurrentGroup (void)
 Retourne l'identifiant du groupe courant (le chemin est gardée en mémoire dans la variable path).
int getGroup (const CNetCDF4Path &_path)
 Retourne l'identifiant du groupe dont le chemin est passé en argument.
int getVariable (const std::string &_varname)
 Retourne l'identifiant d'un variable dans le groupe courant.
int getDimension (const std::string &_dimname)
 Retourne l'identifiant d'une dimension dans le groupe courant.
std::vector< std::size_t > getDimensions (const std::string &_varname)
 Retourne les dimensions d'une variable.
int getUnlimitedDimension (void)
 Retourne l'identifiant de la dimension non limité dans le fichier.
bool varExist (const std::string &_varname)
 Indique si une variable existe dans le groupe courant.

Fonctions membres privées statiques

static void CheckError (int _status)
 Vérifie le code d'erreur retourné lors de l'appel d'une fonction dans la bibliothèque netCDF afin de détecter les erreurs.

Description détaillée

Classe permettant de lire les fichiers de données au format netCDF-4.

Définition à la ligne 41 du fichier inetcdf4.hpp.


Documentation des définitions de type membres

typedef std::vector<std::string> xmlioserver::io::CINetCDF4::CNetCDF4Path

Redéfinition de std::vector<std::string> pour simplification d'écriture.

Définition à la ligne 46 du fichier inetcdf4.hpp.


Documentation des constructeurs et destructeur

xmlioserver::io::CINetCDF4::CINetCDF4 ( void  )

Constructeur simple.

xmlioserver::io::CINetCDF4::CINetCDF4 ( const std::string &  _filename) [explicit]

Constructeur à partir d'un nom de fichier au format netCDF4.

Paramètres:
_filename: un nom de fichier au format netCDF4.
xmlioserver::io::CINetCDF4::CINetCDF4 ( const CINetCDF4 _inetcdf4)

Constructeur par copie .

Paramètres:
_inetcdf4: référence de l'objet à copier.
xmlioserver::io::CINetCDF4::CINetCDF4 ( const CINetCDF4 *const  _inetcdf4_ptr)

Constructeur par copie.

Paramètres:
_inetcdf4_ptr: le pointeur sur l'objet à copier.
xmlioserver::io::CINetCDF4::~CINetCDF4 ( void  )

Destructeur de l'objet (le fichier est clos lors de son appel).


Documentation des fonctions membres

static void xmlioserver::io::CINetCDF4::CheckError ( int  _status) [static, private]

Vérifie le code d'erreur retourné lors de l'appel d'une fonction dans la bibliothèque netCDF afin de détecter les erreurs.

Paramètres:
_status: le code d'erreur retourné par l'appel d'une fonction netCDF.
Remarques:
Tous les appels de fonction dans la bibliothèque netCDF doivent être pris en charge par cette méthode statique.

Exemple d'utilisation:

 //> Retourne l'identifiant d'une variable netCDF dont le nom est 'varname' dans le groupe grpid 
 CheckError(nc_inq_varid (grpid, varname, varid));
int xmlioserver::io::CINetCDF4::getCurrentGroup ( void  ) [protected]

Retourne l'identifiant du groupe courant (le chemin est gardée en mémoire dans la variable path).

Renvoie:
l'identifiant du groupe courant
Voir également:
path
int xmlioserver::io::CINetCDF4::getDimension ( const std::string &  _dimname) [protected]

Retourne l'identifiant d'une dimension dans le groupe courant.

Paramètres:
_dimname: Le nom d'une dimension dans le fichier de données.
Renvoie:
l'identifiant de la dimension.
std::vector<std::size_t> xmlioserver::io::CINetCDF4::getDimensions ( const std::string &  _varname) [protected]

Retourne les dimensions d'une variable.

Paramètres:
_varname: Le nom d'une variable dans le fichier de données.
Renvoie:
Un vecteur des dimensions associées à la variables
int xmlioserver::io::CINetCDF4::getGroup ( const CNetCDF4Path _path) [protected]

Retourne l'identifiant du groupe dont le chemin est passé en argument.

Paramètres:
_path: Un chemin dans la structure de donnée netCDF.
Renvoie:
l'identifiant du groupe.

Exemple d'utilisation:

 //> Retourne l'identifiant d'un group.
 CINetCDF4 ncinput(std::string("mon_fichier.nc"));
 CNetCDF4Path path;
 path.push_back("mes_donnees"); path.push_back("mes_tableaux");
 int groupid = ncinput.getGroup(path);
int xmlioserver::io::CINetCDF4::getUnlimitedDimension ( void  ) [protected]

Retourne l'identifiant de la dimension non limité dans le fichier.

Renvoie:
l'identifiant de la dimension non limité.
int xmlioserver::io::CINetCDF4::getVariable ( const std::string &  _varname) [protected]

Retourne l'identifiant d'un variable dans le groupe courant.

Paramètres:
_varname: Le nom d'une variable dans le fichier de données.
Renvoie:
l'identifiant de la variable.
bool xmlioserver::io::CINetCDF4::varExist ( const std::string &  _varname) [protected]

Indique si une variable existe dans le groupe courant.

Paramètres:
_varname: Le nom d'une variable dans le fichier de données.
Renvoie:
true si la variable existe, false sinon.

Documentation des données membres

Identifiant de fichiers netCDF.

Définition à la ligne 157 du fichier inetcdf4.hpp.

Chemin vers le groupe de données en cours de lecture.

Définition à la ligne 156 du fichier inetcdf4.hpp.


La documentation de cette classe a été générée à partir du fichier suivant :
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Définition de type Amis Macros