#include <BinaryChunk.hpp>

Fonctions membres publiques
C3D_API	BinaryChunk ()
	Constructeur. Plus de détails...

C3D_API	BinaryChunk (ChunkType type)
	Constructeur. Plus de détails...

C3D_API void	finalise ()
	Crée le tampon final à partir de tout ce qui a été ajouté jusqu'à cet appel. Plus de détails...

C3D_API void	add (uint8_t *data, uint32_t size)
	Ajoute des données au chunk. Plus de détails...

C3D_API void	get (uint8_t *data, uint32_t size)
	Récupère des données du chunk. Plus de détails...

C3D_API bool	checkAvailable (uint32_t size=0) const
	Vérifie que la place restante peut contenir la taille donnée. Plus de détails...

C3D_API uint32_t	getRemaining () const
	Récupère la place restante. Plus de détails...

C3D_API bool	getSubChunk (BinaryChunk &subchunk)
	Récupère un sous chunk. Plus de détails...

C3D_API bool	addSubChunk (BinaryChunk const &subchunk)
	Ecrit un subchunk dans un chunk. Plus de détails...

C3D_API bool	write (castor::BinaryFile &file)
	Fonction d'écriture dans un fichier. Plus de détails...

C3D_API bool	read (castor::BinaryFile &file)
	Fonction de lecture à partir d'un fichier. Plus de détails...

uint8_t const *	getRemainingData () const
	Récupère le tampon restant. Plus de détails...

ChunkType	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 begin, uint8_t const end)
	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...

void	resetParse ()
	Réinitialise le chunk, afin de pouvoir le reparser. Plus de détails...

Documentation des constructeurs et destructeur

◆ BinaryChunk() [1/2]

C3D_API castor3d::BinaryChunk::BinaryChunk ( )

Constructeur.

◆ BinaryChunk() [2/2]

C3D_API castor3d::BinaryChunk::BinaryChunk ( ChunkType type )

explicit

Constructeur.

Paramètres

[in] type Le type du chunk

Documentation des fonctions membres

◆ add()

C3D_API void castor3d::BinaryChunk::add	(	uint8_t *	data,
		uint32_t	size
	)

Ajoute des données au chunk.

Paramètres

[in]	data	Le tampon de données
[in]	size	La taille du tampon

◆ addSubChunk()

C3D_API bool castor3d::BinaryChunk::addSubChunk ( BinaryChunk const & subchunk )

Ecrit un subchunk dans un chunk.

Paramètres

[in] subchunk Le subchunk

Renvoie: false si une erreur quelconque est arrivée

Référencé par castor3d::BinaryWriterBase< TWritten >::doWriteHeader(), castor3d::BinaryWriterBase< TWritten >::write(), et castor3d::ChunkWriterBase::write().

Voici le graphe des appelants de cette fonction :

◆ checkAvailable()

C3D_API bool castor3d::BinaryChunk::checkAvailable ( uint32_t size = 0 ) const

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

Paramètres

[in] size La taille

Référencé par castor3d::BinaryParserBase< TParsed >::doGetSubChunk(), castor3d::BinaryParserBase< TParsed >::doParseHeader(), castor3d::ChunkParser< castor::Path >::parse(), castor3d::ChunkParser< castor::String >::parse(), castor3d::BinaryParserBase< TParsed >::parse(), et castor3d::ChunkParserBase::parse().

Voici le graphe des appelants de cette fonction :

◆ endParse()

void castor3d::BinaryChunk::endParse ( )

inline

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

Référencé par castor3d::BinaryParserBase< TParsed >::doParseHeader(), castor3d::BinaryParserBase< TParsed >::parse(), castor3d::BinaryParserBase< TParsed >::parse_v1_1(), castor3d::BinaryParserBase< TParsed >::parse_v1_2(), castor3d::BinaryParserBase< TParsed >::parse_v1_3(), et castor3d::BinaryParserBase< TParsed >::parse_v1_4().

Voici le graphe des appelants de cette fonction :

◆ finalise()

C3D_API void castor3d::BinaryChunk::finalise ( )

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

Référencé par castor3d::BinaryWriterBase< TWritten >::write().

Voici le graphe des appelants de cette fonction :

◆ get()

C3D_API void castor3d::BinaryChunk::get	(	uint8_t *	data,
		uint32_t	size
	)

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

Paramètres

[in]	data	Le tampon de données à remplir
[in]	size	La taille du tampon

Référencé par castor3d::ChunkParserBase::parse().

Voici le graphe des appelants de cette fonction :

◆ getChunkType()

ChunkType castor3d::BinaryChunk::getChunkType ( ) const

inline

Récupère le type de chunk.

Renvoie: La valeur

Référencé par castor3d::BinaryParserBase< TParsed >::doParseHeader(), castor3d::BinaryParserBase< TParsed >::parse(), castor3d::BinaryParserBase< TParsed >::parse_v1_1(), castor3d::BinaryParserBase< TParsed >::parse_v1_2(), castor3d::BinaryParserBase< TParsed >::parse_v1_3(), et castor3d::BinaryParserBase< TParsed >::parse_v1_4().

Voici le graphe des appelants de cette fonction :

◆ getData()

uint8_t const * castor3d::BinaryChunk::getData ( ) const

inline

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

Renvoie: La valeur

◆ getDataSize()

uint32_t castor3d::BinaryChunk::getDataSize ( ) const

inline

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

Renvoie: La valeur

◆ getRemaining()

C3D_API uint32_t castor3d::BinaryChunk::getRemaining ( ) const

Récupère la place restante.

Renvoie: La valeur

Référencé par castor3d::ChunkParser< castor::Path >::parse(), et castor3d::ChunkParser< castor::String >::parse().

Voici le graphe des appelants de cette fonction :

◆ getRemainingData()

uint8_t const * castor3d::BinaryChunk::getRemainingData ( ) const

inline

Récupère le tampon restant.

Renvoie: La valeur

◆ getSubChunk()

C3D_API bool castor3d::BinaryChunk::getSubChunk ( BinaryChunk & subchunk )

Récupère un sous chunk.

Paramètres

[out] subchunk Reçoit le sous chunk

Renvoie: false si une erreur quelconque est arrivée

Référencé par castor3d::BinaryParserBase< TParsed >::doGetSubChunk(), castor3d::BinaryParserBase< TParsed >::doParseHeader(), et castor3d::BinaryParserBase< TParsed >::parse().

Voici le graphe des appelants de cette fonction :

◆ read()

C3D_API bool castor3d::BinaryChunk::read ( castor::BinaryFile & file )

Fonction de lecture à partir d'un fichier.

Paramètres

[in] file Le fichier qui contient le chunk

Renvoie: false si une erreur quelconque est arrivée

Référencé par castor3d::BinaryParserBase< TParsed >::parse().

Voici le graphe des appelants de cette fonction :

◆ resetParse()

void castor3d::BinaryChunk::resetParse ( )

inline

Réinitialise le chunk, afin de pouvoir le reparser.

Référencé par castor3d::BinaryParserBase< TParsed >::parse().

Voici le graphe des appelants de cette fonction :

◆ setData()

void castor3d::BinaryChunk::setData	(	uint8_t const *	begin,
		uint8_t const *	end
	)

inline

Définit les données du chunk.

Paramètres

[in]	begin	Le début du tampon de données
[in]	end	La fin du tampon de données

Référencé par castor3d::ChunkWriterBase::write().

Voici le graphe des appelants de cette fonction :

◆ write()

C3D_API bool castor3d::BinaryChunk::write ( castor::BinaryFile & file )

Fonction d'écriture dans un fichier.

Paramètres

[in] file Le fichier

Renvoie: false si une erreur quelconque est arrivée

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

Binary/BinaryChunk.hpp

Fonctions membres publiques

Documentation des constructeurs et destructeur

◆ BinaryChunk() [1/2]

◆ BinaryChunk() [2/2]

Documentation des fonctions membres

◆ add()

◆ addSubChunk()

◆ checkAvailable()

◆ endParse()

◆ finalise()

◆ get()

◆ getChunkType()

◆ getData()

◆ getDataSize()

◆ getRemaining()

◆ getRemainingData()

◆ getSubChunk()

◆ read()

◆ resetParse()

◆ setData()

◆ write()