Classes | Fonctions membres publiques | Fonctions membres publiques statiques

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

Classe pour l'écriture de ressources dans un fichier. Plus de détails...

Liste de tous les membres

## Classes

struct | KeyFilename
| Structure de stockage de la clé et du nom de fichier.

## Fonctions membres publiques

| ResWriter ()
| Constructeur par défaut.
| ResWriter (unsigned int dataBlockSize)
| Constructeur avec valorisation de la taille des blocs.
| ~ResWriter ()
| Destructeur par défaut.
void | setBlockSize (unsigned int dataBlockSize)
| Définit la taille des blocs de données.
unsigned int | getBlockSize ()
| Retourne la taille des blocs de données.
bool | open (std::string const &filename)
| Ouvre le fichier cible en lecture/écriture pour écrire des ressources (sans mot de passe).
bool | open (std::string const &filename, std::string const &pwd)
| Ouvre le fichier cible en lecture/écriture pour écrire des ressources (avec ou sans mot de passe).
void | close ()
| Ferme éventuellement le fichier ouvert.
bool | add (std::string const &key, std::string const &filename)
| Ajouter un fichier dans la file d'attente de traitement.
bool | persist ()
| Écrit effectivement en tant que ressource les fichiers en file d'attente et crée l'index puis ferme le fichier.
bool | persist (bool cPrint)
| Écrit effectivement en tant que ressource les fichiers en file d'attente et crée l'index puis ferme le fichier.

## Fonctions membres publiques statiques

static bool | getFileContent (std::string const &filename, std::string &content)
| Lit l'intégralité d'un fichier et le place dans le tampon fourni.

## Description détaillée

Classe pour l'écriture de ressources dans un fichier.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

ResWriter::ResWriter | ( |  | ) |

Constructeur par défaut.

Auteur:
  U.Speed

ResWriter::ResWriter | ( | unsigned int | dataBlockSize | ) |

Constructeur avec valorisation de la taille des blocs.

Auteur:
  U.Speed

Voir également:
  void ResWriter::setBlockSize(unsigned int dataBlockSize)

Paramètres:

  | dataBlockSize | unsigned int : La taille d'un bloc de données brutes (entre 1Ko et 50Ko). Taille par défaut : 4Ko

ResWriter::~ResWriter | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

bool ResWriter::add | ( | std::string const & | key,
|  | std::string const & | filename |
| ) |  |  |

Ajouter un fichier dans la file d'attente de traitement.

Auteur:
  U.Speed

Paramètres:

  | key | std::string : la clé d'association de la ressource (23 caractères maximum)
  | filename | std::string : le chemin du fichier à ajouter

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

void ResWriter::close | ( |  | ) |

Ferme éventuellement le fichier ouvert.

Auteur:
  U.Speed

unsigned int ResWriter::getBlockSize | ( |  | ) |

Retourne la taille des blocs de données.

Auteur:
  U.Speed

Renvoie:
  unsigned int : La taille d'un bloc de données brutes (entre 1Ko et 50Ko). Taille par défaut : 4Ko

bool ResWriter::getFileContent | ( | std::string const & | filename,
|  | std::string & | content |
| ) |  |  | `[static]`

Lit l'intégralité d'un fichier et le place dans le tampon fourni.

Auteur:
  U.Speed

Paramètres:

  | filename | std::string : le nom du fichier à lire
  | content | std::string* : le tampon cible

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

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

Ouvre le fichier cible en lecture/écriture pour écrire des ressources (avec ou sans mot de passe).

Auteur:
  U.Speed

Paramètres:

  | filename | std::string const& : le nom du fichier à ouvrir
  | pwd | std::string const& : l'éventuel mot de passe pour crypter les données

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

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

Ouvre le fichier cible en lecture/écriture pour écrire des ressources (sans mot de passe).

Auteur:
  U.Speed

Paramètres:

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

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

bool ResWriter::persist | ( | bool | cPrint | ) |

Écrit effectivement en tant que ressource les fichiers en file d'attente et crée l'index puis ferme le fichier.

Avec "cPrint", il est possible d'afficher l'état de l'ajout de la donnée.

Auteur:
  U.Speed

Paramètres:

  | cPrint | bool : `false` pour ne pas afficher l'état de chaque ajout (vai la fonction C "printf")

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

bool ResWriter::persist | ( |  | ) |

Écrit effectivement en tant que ressource les fichiers en file d'attente et crée l'index puis ferme le fichier.

Lancement en mode muet (cPrint = false)

Voir également:
  bool ResWriter::persist(bool cPrint)

Auteur:
  U.Speed

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

void ResWriter::setBlockSize | ( | unsigned int | dataBlockSize | ) |

Définit la taille des blocs de données.

Cette fonction n'effectue aucun changement une fois le fichier d'archive est ouverte.

Auteur:
  U.Speed

Paramètres:

  | dataBlockSize | unsigned int : La taille d'un bloc de données brutes (entre 1Ko et 50Ko). Taille par défaut : 4Ko

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

- src/ResWriter/ResWriter.hpp
- src/ResWriter/ResWriter.cpp
- src/ResWriter/ResWriter_add.cpp
- src/ResWriter/ResWriter_close.cpp
- src/ResWriter/ResWriter_getBlockSize.cpp
- src/ResWriter/ResWriter_getFileContent.cpp
- src/ResWriter/ResWriter_open.cpp
- src/ResWriter/ResWriter_persist.cpp
- src/ResWriter/ResWriter_setBlockSize.cpp