Classes | Public Member Functions | Static Public Member Functions

# USpeedGameEngine::ResWriter Class Reference

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

List of all members.

## Classes

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

## Public Member Functions

| 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.

## Static Public Member Functions

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

## Detailed Description

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

Author:
  U.Speed

## Constructor & Destructor Documentation

ResWriter::ResWriter | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

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

Constructeur avec valorisation de la taille des blocs.

Author:
  U.Speed

See also:
  void ResWriter::setBlockSize(unsigned int dataBlockSize)

Parameters:

  | 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.

Author:
  U.Speed

## Member Function Documentation

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

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

Author:
  U.Speed

Parameters:

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

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

void ResWriter::close | ( |  | ) |

Ferme éventuellement le fichier ouvert.

Author:
  U.Speed

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

Retourne la taille des blocs de données.

Author:
  U.Speed

Returns:
  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.

Author:
  U.Speed

Parameters:

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

Returns:
  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).

Author:
  U.Speed

Parameters:

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

Returns:
  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).

Author:
  U.Speed

Parameters:

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

Returns:
  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.

Author:
  U.Speed

Parameters:

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

Returns:
  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)

See also:
  bool ResWriter::persist(bool cPrint)

Author:
  U.Speed

Returns:
  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.

Author:
  U.Speed

Parameters:

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

The documentation for this class was generated from the following files:

- 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