Référence du modèle de la classe castor3d::BinaryWriterBase< TWritten >

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

#include <BinaryWriter.hpp>

Graphe d'héritage de castor3d::BinaryWriterBase< TWritten >:

Graphe de collaboration de castor3d::BinaryWriterBase< TWritten >:

Fonctions membres publiques
virtual	~BinaryWriterBase ()=default
bool	write (TWritten const &obj, castor::BinaryFile &file)
	Fonction d'écriture dans un fichier. Plus de détails...
bool	write (TWritten const &obj, BinaryChunk &chunk)
	Fonction d'écriture dans un chunk. Plus de détails...

Fonctions membres protégées
bool	doWriteHeader (BinaryChunk &chunk) const
	Ecrit une le chunk d'en-tête. Plus de détails...
template<typename T >
bool	doWriteChunk (T const *values, size_t count, ChunkType chunkType, BinaryChunk &chunk) const
	Ecrit une valeur d'un subchunk dans un chunk. Plus de détails...
template<typename T , size_t Count>
bool	doWriteChunk (T const(&values)[Count], ChunkType chunkType, BinaryChunk &chunk) const
	Ecrit une valeur d'un subchunk dans un chunk. Plus de détails...
template<typename T , size_t Count>
bool	doWriteChunk (std::array< T, Count > const &values, ChunkType chunkType, BinaryChunk &chunk) const
	Ecrit une valeur d'un subchunk dans un chunk. Plus de détails...
template<typename T >
bool	doWriteChunk (std::vector< T > const &values, ChunkType chunkType, BinaryChunk &chunk) const
	Ecrit une valeur d'un subchunk dans un chunk. Plus de détails...
template<typename T >
bool	doWriteChunk (T const *begin, T const *end, ChunkType chunkType, BinaryChunk &chunk) const
	Ecrit une valeur d'un subchunk dans un chunk. Plus de détails...
template<typename T >
bool	doWriteChunk (T const &value, ChunkType chunkType, BinaryChunk &chunk) const
	Ecrit une valeur d'un subchunk dans un chunk. Plus de détails...

Attributs protégés
BinaryChunk	m_chunk { ChunkTyper< TWritten >::Value }

Description détaillée

template<class TWritten>
class castor3d::BinaryWriterBase< TWritten >

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

Documentation des constructeurs et destructeur

~BinaryWriterBase()

template<class TWritten >

virtual castor3d::BinaryWriterBase< TWritten >::~BinaryWriterBase ( )

virtualdefault

Documentation des fonctions membres

doWriteChunk() [1/6]

template<class TWritten >

template<typename T , size_t Count>

bool castor3d::BinaryWriterBase< TWritten >::doWriteChunk ( std::array< T, Count > const &  values, ChunkType  chunkType, BinaryChunk &  chunk  ) const

inlineprotected

Ecrit une valeur d'un subchunk dans un chunk.

Paramètres

[in]	values	Les valeurs.
[in]	chunkType	Le type du subchunk.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::ChunkWriter< T >::write().

Voici le graphe d'appel pour cette fonction :

doWriteChunk() [2/6]

template<class TWritten >

template<typename T >

bool castor3d::BinaryWriterBase< TWritten >::doWriteChunk ( std::vector< T > const &  values, ChunkType  chunkType, BinaryChunk &  chunk  ) const

inlineprotected

Ecrit une valeur d'un subchunk dans un chunk.

Paramètres

[in]	values	Les valeurs.
[in]	chunkType	Le type du subchunk.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::ChunkWriter< T >::write().

Voici le graphe d'appel pour cette fonction :

doWriteChunk() [3/6]

template<class TWritten >

template<typename T >

bool castor3d::BinaryWriterBase< TWritten >::doWriteChunk ( T const &  value, ChunkType  chunkType, BinaryChunk &  chunk  ) const

inlineprotected

Ecrit une valeur d'un subchunk dans un chunk.

Paramètres

[in]	value	La valeur.
[in]	chunkType	Le type du subchunk.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::ChunkWriter< T >::write().

Voici le graphe d'appel pour cette fonction :

doWriteChunk() [4/6]

template<class TWritten >

template<typename T >

bool castor3d::BinaryWriterBase< TWritten >::doWriteChunk ( T const *  begin, T const *  end, ChunkType  chunkType, BinaryChunk &  chunk  ) const

inlineprotected

Ecrit une valeur d'un subchunk dans un chunk.

Paramètres

[in]	begin	Le début des valeurs.
[in]	end	La fin des valeurs.
[in]	chunkType	Le type du subchunk.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::ChunkWriter< T >::write().

Voici le graphe d'appel pour cette fonction :

doWriteChunk() [5/6]

template<class TWritten >

template<typename T >

bool castor3d::BinaryWriterBase< TWritten >::doWriteChunk ( T const *  values, size_t  count, ChunkType  chunkType, BinaryChunk &  chunk  ) const

inlineprotected

Ecrit une valeur d'un subchunk dans un chunk.

Paramètres

[in]	values	Les valeurs.
[in]	count	Le nombre de valeurs.
[in]	chunkType	Le type du subchunk.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::ChunkWriter< T >::write().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

doWriteChunk() [6/6]

template<class TWritten >

template<typename T , size_t Count>

bool castor3d::BinaryWriterBase< TWritten >::doWriteChunk ( T const(&)  values[Count], ChunkType  chunkType, BinaryChunk &  chunk  ) const

inlineprotected

Ecrit une valeur d'un subchunk dans un chunk.

Paramètres

[in]	values	Les valeurs.
[in]	chunkType	Le type du subchunk.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::ChunkWriter< T >::write().

Voici le graphe d'appel pour cette fonction :

doWriteHeader()

template<class TWritten >

bool castor3d::BinaryWriterBase< TWritten >::doWriteHeader ( BinaryChunk &  chunk ) const

inlineprotected

Ecrit une le chunk d'en-tête.

Paramètres

[in,out]

chunk

Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::BinaryChunk::addSubChunk(), castor3d::CurrentCmshVersion, castor3d::BinaryWriterBase< TWritten >::doWriteChunk(), castor3d::eCmshHeader, castor3d::eCmshVersion, et castor3d::eName.

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

write() [1/2]

template<class TWritten >

bool castor3d::BinaryWriterBase< TWritten >::write ( TWritten const &  obj, BinaryChunk &  chunk  )

inline

Fonction d'écriture dans un chunk.

Paramètres

[in]	obj	L'objet à écrire.
[in,out]	chunk	Le chunk.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::BinaryChunk::addSubChunk(), castor3d::BinaryChunk::finalise(), et castor3d::BinaryWriterBase< TWritten >::m_chunk.

Voici le graphe d'appel pour cette fonction :

write() [2/2]

template<class TWritten >

bool castor3d::BinaryWriterBase< TWritten >::write ( TWritten const &  obj, castor::BinaryFile &  file  )

inline

Fonction d'écriture dans un fichier.

Paramètres

[in]	obj	L'objet à écrire.
[in,out]	file	Le fichier.

Renvoie

false si une erreur quelconque est arrivée.

Références castor3d::BinaryWriterBase< TWritten >::doWriteHeader(), castor3d::eCmshFile, et castor3d::BinaryWriterBase< TWritten >::write().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des données membres

m_chunk

template<class TWritten >

BinaryChunk castor3d::BinaryWriterBase< TWritten >::m_chunk { ChunkTyper< TWritten >::Value }

protected

Le chunk du writer.

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

---

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

• Binary/BinaryModule.hpp
• Binary/BinaryWriter.hpp