Référence de la classe Castor3D::BinaryChunk

Classe de base d'un chunk de données binaires. Plus de détails...

Fonctions membres publiques
	BinaryChunk ()
	Constructeur. Plus de détails...
	BinaryChunk (eCHUNK_TYPE p_eType)
	Constructeur. Plus de détails...
void	Finalise ()
	Crée le tampon final à partir de tout ce qui a été ajouté jusqu'à cet appel. Plus de détails...
void	Add (uint8_t *p_data, uint32_t p_size)
	Ajoute des données au chunk. Plus de détails...
void	Get (uint8_t *p_data, uint32_t p_size)
	Récupère des données du chunk. Plus de détails...
bool	CheckAvailable (uint32_t p_size=0) const
	Vérifie que la place restante peut contenir la taille donnée Plus de détails...
uint32_t	GetRemaining () const
	Récupère la place restante. Plus de détails...
uint8_t const *	GetRemainingData () const
	Récupère le tampon restant. Plus de détails...
bool	GetSubChunk (BinaryChunk &p_subchunk)
	Récupère un sous chunk. Plus de détails...
bool	AddSubChunk (BinaryChunk const &p_subchunk)
	Ecrit un subchunk dans un chunk. Plus de détails...
eCHUNK_TYPE	GetChunkType () const
	Récupère le type de chunk. Plus de détails...
uint32_t	GetDataSize () const
	Récupère la taille des données du chunk. Plus de détails...
uint8_t const *	GetData () const
	Récupère les données du chunk. Plus de détails...
void	SetData (uint8_t const *p_data, uint32_t p_size)
	Définit les données du chunk. Plus de détails...
void	EndParse ()
	Récupère la taille des données du chunk. Plus de détails...
bool	Write (Castor::BinaryFile &p_file)
	Fonction d'écriture dans un fichier. Plus de détails...
bool	Read (Castor::BinaryFile &p_file)
	Fonction de lecture à partir d'un fichier. Plus de détails...

Description détaillée

Classe de base d'un chunk de données binaires.

Auteur

Sylvain DOREMUS

Version

0.7.0.0

Date

15/04/2013

Documentation des constructeurs et destructeur

Castor3D::BinaryChunk::BinaryChunk

(

)

Constructeur.

Castor3D::BinaryChunk::BinaryChunk

(

eCHUNK_TYPE

p_eType

)

Constructeur.

Paramètres

[in]

p_eType

Le type du chunk

Documentation des fonctions membres

void Castor3D::BinaryChunk::Add	(	uint8_t *	p_data,
		uint32_t	p_size
	)

Ajoute des données au chunk.

Paramètres

[in]	p_data	Le tampon de données
[in]	p_size	La taille du tampon

bool Castor3D::BinaryChunk::AddSubChunk

(

BinaryChunk const &

p_subchunk

)

Ecrit un subchunk dans un chunk.

Paramètres

[in]

p_subchunk

Le subchunk

Renvoie

false si une erreur quelconque est arrivée

Référencé par Castor3D::ChunkFillerBase::operator()().

Voici le graphe des appelants de cette fonction :

bool Castor3D::BinaryChunk::CheckAvailable

(

uint32_t

p_size = 0

)

const

Vérifie que la place restante peut contenir la taille donnée

Paramètres

[in]

p_size

La taille

Référencé par Castor3D::ChunkParserBase::operator()(), Castor3D::ChunkParser< Castor::String >::operator()(), et Castor3D::ChunkParser< Castor::Path >::operator()().

Voici le graphe des appelants de cette fonction :

void Castor3D::BinaryChunk::EndParse ( )

inline

Récupère la taille des données du chunk.

void Castor3D::BinaryChunk::Finalise

(

)

Crée le tampon final à partir de tout ce qui a été ajouté jusqu'à cet appel.

void Castor3D::BinaryChunk::Get	(	uint8_t *	p_data,
		uint32_t	p_size
	)

Récupère des données du chunk.

Paramètres

[in]	p_data	Le tampon de données à remplir
[in]	p_size	La taille du tampon

Référencé par Castor3D::ChunkParserBase::operator()().

Voici le graphe des appelants de cette fonction :

eCHUNK_TYPE Castor3D::BinaryChunk::GetChunkType ( ) const

inline

Récupère le type de chunk.

Renvoie

La valeur

uint8_t const* Castor3D::BinaryChunk::GetData ( ) const

inline

Récupère les données du chunk.

Renvoie

La valeur

uint32_t Castor3D::BinaryChunk::GetDataSize ( ) const

inline

Récupère la taille des données du chunk.

Renvoie

La valeur

uint32_t Castor3D::BinaryChunk::GetRemaining

(

)

const

Récupère la place restante.

Renvoie

La valeur

Référencé par Castor3D::ChunkParser< Castor::String >::operator()(), et Castor3D::ChunkParser< Castor::Path >::operator()().

Voici le graphe des appelants de cette fonction :

uint8_t const* Castor3D::BinaryChunk::GetRemainingData ( ) const

inline

Récupère le tampon restant.

Renvoie

La valeur

bool Castor3D::BinaryChunk::GetSubChunk

(

BinaryChunk &

p_subchunk

)

Récupère un sous chunk.

Paramètres

[out]

p_subchunk

Reçoit le sous chunk

Renvoie

false si une erreur quelconque est arrivée

bool Castor3D::BinaryChunk::Read

(

Castor::BinaryFile &

p_file

)

Fonction de lecture à partir d'un fichier.

Paramètres

[out]	p_obj	L'objet à lire
[in]	p_file	Le fichier qui contient le chunk

Renvoie

false si une erreur quelconque est arrivée

Référencé par Castor3D::BinaryParser< RenderTarget >::Parse().

Voici le graphe des appelants de cette fonction :

void Castor3D::BinaryChunk::SetData ( uint8_t const *  p_data, uint32_t  p_size  )

inline

Définit les données du chunk.

Paramètres

[in]	p_data	Le tampon de données
[in]	p_size	La taille du tampon

Référencé par Castor3D::ChunkFillerBase::operator()().

Voici le graphe des appelants de cette fonction :

bool Castor3D::BinaryChunk::Write

(

Castor::BinaryFile &

p_file

)

Fonction d'écriture dans un fichier.

Paramètres

[in]	p_obj	L'objet à écrire
[in]	p_file	Le fichier

Renvoie

false si une erreur quelconque est arrivée

Référencé par Castor3D::BinaryParser< RenderTarget >::Fill().

Voici le graphe des appelants de cette fonction :

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Y:/projets/Castor3D/source/Core/Castor3D/Src/BinaryChunk.hpp