Classes | Public Member Functions

# USpeedGameEngine::SfoFile Class Reference

Classe permettant de lire les fichiers SFO. More...

List of all members.

## Classes

struct | SfoSection
| Structure de stockage des informations d'une section dans un fichier SFO. More...

## Public Member Functions

| SfoFile ()
| Constructeur par défaut.
| ~SfoFile ()
| Destructeur par défaut.
bool | load (const char *filename)
| Charge le fichier SFO spécifié.
unsigned long int | getSectionsCount ()
| Retourne le nombre de sections SFO disponibles à la lecture.
void | resetIterator ()
| Remet le pointeur de parcours des sections à zéro.
bool | nextSection ()
| Sélectionne la section suivante.
bool | selectSection (unsigned long int mySection)
| Choisit la section courante (0 <= .
const unsigned char * | getData ()
| Retourne les données SFO de la section courante.
unsigned char | getDataType ()
| Retourne le type de données de la section courante.
unsigned long int | getDataSize ()
| Retourne la taille des données de la section courante.

## Detailed Description

Classe permettant de lire les fichiers SFO.

Author:
  U.Speed

## Constructor & Destructor Documentation

SfoFile::SfoFile | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

SfoFile::~SfoFile | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

const unsigned char * SfoFile::getData | ( |  | ) |

Retourne les données SFO de la section courante.

Author:
  U.Speed

Returns:
  const unsigned char* : la donnée de la section courante ou pointeur nul

unsigned long int SfoFile::getDataSize | ( |  | ) |

Retourne la taille des données de la section courante.

Author:
  U.Speed

Returns:
  unsigned long int : la taille des données courantes

unsigned char SfoFile::getDataType | ( |  | ) |

Retourne le type de données de la section courante.

Author:
  U.Speed

Returns:
  unsigned char : le type
  - 0 : Texte
  - 1 : Entier
  - 2 : Binaire
  - 3 : ?

unsigned long int SfoFile::getSectionsCount | ( |  | ) |

Retourne le nombre de sections SFO disponibles à la lecture.

Author:
  U.Speed

Returns:
  unsigned long int : le nombre de sections SFO

bool SfoFile::load | ( | const char * | filename | ) |

Charge le fichier SFO spécifié.

Author:
  U.Speed

Parameters:

  | filename | const char* : le fichier à lire

Returns:
  bool : l'état du chargement
  - true : fichier chargé
  - false : échec du chargement

bool SfoFile::nextSection | ( |  | ) |

Sélectionne la section suivante.

Author:
  U.Speed

Returns:
  bool : dernière section ou pas ?
  - true : on n'est pas sur la dernière section
  - false : on est sur la dernière section

void SfoFile::resetIterator | ( |  | ) |

Remet le pointeur de parcours des sections à zéro.

Author:
  U.Speed

bool SfoFile::selectSection | ( | unsigned long int | mySection | ) |

Choisit la section courante (0 <= .

< this->getSectionsCount())

Author:
  U.Speed

Returns:
  bool : l'état de la selection
  - true : sélection valide
  - false : sélection invalide donc pas de modification

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

- src/SfoFile/SfoFile.hpp
- src/SfoFile/SfoFile.cpp
- src/SfoFile/SfoFile_getData.cpp
- src/SfoFile/SfoFile_getDataSize.cpp
- src/SfoFile/SfoFile_getDataType.cpp
- src/SfoFile/SfoFile_getSectionsCount.cpp
- src/SfoFile/SfoFile_load.cpp
- src/SfoFile/SfoFile_nextSection.cpp
- src/SfoFile/SfoFile_reset.cpp
- src/SfoFile/SfoFile_resetIterator.cpp
- src/SfoFile/SfoFile_selectSection.cpp