Classes | Fonctions membres publiques

# Référence de la classe USpeedGameEngine::ResReader

Classe pour la lecture de ressources incluses dans un fichier. Plus de détails...

Liste de tous les membres

## Classes

struct | IndexEntry
| Structure de stockage d'une information de l'index.

## Fonctions membres publiques

| ResReader ()
| Constructeur par défaut.
| ~ResReader ()
| Destructeur par défaut.
bool | open (std::string const &filename, std::string const &pwd)
| Charge l'index des ressources (avec mot de passe éventuel).
bool | open (std::string const &filename)
| Charge l'index des ressources (pas de mot de passe).
void | close ()
| Ferme éventuellement le fichier ouvert.
bool | load (std::string const &key, std::string &value)
| Charge la ressource demandée.
bool | loadPart (std::string const &key, std::string &value, unsigned int partToRead)
| Charge le segment de ressource demandé.
bool | loadPart (std::string const &key, std::string &value, unsigned int seekPosition, unsigned int sizeToRead)
| Charge la partie de la ressource demandée.
void | getKeys (std::vector< std::string > &keys)
| Retourne la liste des clés lues dans l'index.

## Description détaillée

Classe pour la lecture de ressources incluses dans un fichier.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

ResReader::ResReader | ( |  | ) |

Constructeur par défaut.

Auteur:
  U.Speed

ResReader::~ResReader | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

void ResReader::close | ( |  | ) |

Ferme éventuellement le fichier ouvert.

Auteur:
  U.Speed

void ResReader::getKeys | ( | std::vector< std::string > & | keys | ) |

Retourne la liste des clés lues dans l'index.

Auteur:
  U.Speed

Paramètres:

  | keys | std::vector<std::string>& : le tampon de destination

bool ResReader::load | ( | std::string const & | key,
|  | std::string & | value |
| ) |  |  |

Charge la ressource demandée.

Auteur:
  U.Speed

Voir également:
  bool ResReader::loadPart(std::string const &key, std::string &value, unsigned int partToRead)

Paramètres:

  | key | std::string const& : la clé de la ressource
  | value | std::string& : la destination de la valeur de la ressource

Renvoie:
  bool : `false` en cas d'échec

bool ResReader::loadPart | ( | std::string const & | key,
|  | std::string & | value,
|  | unsigned int | partToRead |
| ) |  |  |

Charge le segment de ressource demandé.

Auteur:
  U.Speed

Paramètres:

  | key | std::string const& : la clé de la ressource
  | value | std::string& : la destination de la valeur de la ressource
  | partToRead | unsigned int : la partie à lire (1..max)

Renvoie:
  bool : `false` en cas d'échec

bool ResReader::loadPart | ( | std::string const & | key,
|  | std::string & | value,
|  | unsigned int | seekPosition,
|  | unsigned int | sizeToRead |
| ) |  |  |

Charge la partie de la ressource demandée.

Auteur:
  U.Speed

Voir également:
  bool ResReader::loadPart(std::string const &key, std::string &value, std::string &blockSizeList, unsigned int partToRead)

Paramètres:

  | key | std::string const& : la clé de la ressource
  | value | std::string& : la destination de la valeur de la ressource
  | seekPosition | unsigned int : la partie à lire (1..max)
  | sizeToRead | unsigned int : le nombre d'octets à lire (1..max)

Renvoie:
  bool : `false` en cas d'échec.

bool ResReader::open | ( | std::string const & | filename | ) |

Charge l'index des ressources (pas de mot de passe).

Auteur:
  U.Speed

Voir également:
  bool ResReader::open(std::string const &filename, std::string const &pwd)

Paramètres:

  | filename | std::string const& : le nom du fichier à ouvrir

Renvoie:
  bool : l'état de l'ouverture du fichier

bool ResReader::open | ( | std::string const & | filename,
|  | std::string const & | pwd |
| ) |  |  |

Charge l'index des ressources (avec mot de passe éventuel).

Auteur:
  U.Speed

Paramètres:

  | filename | std::string const& : le nom du fichier à ouvrir
  | pwd | std::string const& : le mot de passe pour lire le fichier à ouvrir

Renvoie:
  bool : l'état de l'ouverture du fichier

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

- src/ResReader/ResReader.hpp
- src/ResReader/ResReader.cpp
- src/ResReader/ResReader_close.cpp
- src/ResReader/ResReader_getKeys.cpp
- src/ResReader/ResReader_load.cpp
- src/ResReader/ResReader_loadPart.cpp
- src/ResReader/ResReader_open.cpp