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

#include <BinaryParser.hpp>

Graphe d'héritage de castor3d::BinaryParserBase< TParsed >:

[légende]

Graphe de collaboration de castor3d::BinaryParserBase< TParsed >:

Fonctions membres publiques
	BinaryParserBase ()=default

	BinaryParserBase (BinaryParserBase const &)=default

	BinaryParserBase (BinaryParserBase &&)=default

BinaryParserBase &	operator= (BinaryParserBase const &)=default

BinaryParserBase &	operator= (BinaryParserBase &&)=default

virtual	~BinaryParserBase ()=default

template<typename T >
BinaryParser< T >	createBinaryParser ()
	Crée un parser binaire.

bool	parse (TParsed &obj, castor::BinaryFile &file)
	Fonction de lecture à partir d'un fichier.

bool	parse (TParsed &obj, BinaryChunk &chunk)
	Fonction de lecture à partir d'un chunk.

bool	parse_v1_1 (TParsed &obj, BinaryChunk &chunk)
	Fonction de lecture à partir d'un chunk.

bool	parse_v1_2 (TParsed &obj, BinaryChunk &chunk)
	Fonction de lecture à partir d'un chunk.

bool	parse_v1_3 (TParsed &obj, BinaryChunk &chunk)
	Fonction de lecture à partir d'un chunk.

bool	parse_v1_4 (TParsed &obj, BinaryChunk &chunk)
	Fonction de lecture à partir d'un chunk.

bool	parse_v1_5 (TParsed &obj, BinaryChunk &chunk)
	Fonction de lecture à partir d'un chunk.

Fonctions membres protégées
bool	doParseHeader (BinaryChunk &chunk) const
	Lit le chunk d'en-tête.

template<typename T >
bool	doParseChunk (T *values, size_t count, BinaryChunk &chunk) const
	Récupère un tableau de valeurs à partir d'un chunk.

template<typename T , size_t Count>
bool	doParseChunk (T(&values)[Count], BinaryChunk &chunk) const
	Récupère un tableau de valeurs à partir d'un chunk.

template<typename T , size_t Count>
bool	doParseChunk (std::array< T, Count > &values, BinaryChunk &chunk) const
	Récupère un tableau de valeurs à partir d'un chunk.

template<typename T >
bool	doParseChunk (std::vector< T > &values, BinaryChunk &chunk) const
	Récupère un tableau de valeurs à partir d'un chunk.

template<typename T >
bool	doParseChunk (T &value, BinaryChunk &chunk) const
	Récupère une valeur à partir d'un chunk.

bool	doGetSubChunk (BinaryChunk &chunk)
	Récupère un sous-chunk.

void	checkError (bool result, castor::String const &text) const

Attributs protégés
BinaryChunk *	m_chunk { nullptr }

Version	m_fileVersion

Attributs protégés statiques
static C3D_API castor::String	Name

Amis
template<typename T >
class	BinaryParserBase

Description détaillée

template<class TParsed>
class castor3d::BinaryParserBase< TParsed >

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

Documentation des constructeurs et destructeur

◆ BinaryParserBase() [1/3]

template<class TParsed >

castor3d::BinaryParserBase< TParsed >::BinaryParserBase ( )

default

◆ BinaryParserBase() [2/3]

template<class TParsed >

castor3d::BinaryParserBase< TParsed >::BinaryParserBase ( BinaryParserBase< TParsed > const & )

default

◆ BinaryParserBase() [3/3]

template<class TParsed >

castor3d::BinaryParserBase< TParsed >::BinaryParserBase ( BinaryParserBase< TParsed > && )

default

◆ ~BinaryParserBase()

template<class TParsed >

virtual castor3d::BinaryParserBase< TParsed >::~BinaryParserBase ( )

virtualdefault

Documentation des fonctions membres

◆ checkError()

template<class TParsed >

void castor3d::BinaryParserBase< TParsed >::checkError	(	bool	result,
		castor::String const &	text
	)		const

inlineprotected

Références castor3d::log::error, et castor3d::BinaryParserBase< TParsed >::Name.

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(), castor3d::BinaryParserBase< TParsed >::parse_v1_4(), et castor3d::BinaryParserBase< TParsed >::parse_v1_5().

Voici le graphe des appelants de cette fonction :

◆ createBinaryParser()

template<class TParsed >

template<typename T >

BinaryParser< T > castor3d::BinaryParserBase< TParsed >::createBinaryParser ( )

inline

Crée un parser binaire.

Références castor3d::BinaryParserBase< TParsed >::m_fileVersion.

◆ doGetSubChunk()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::doGetSubChunk ( BinaryChunk & chunk )

inlineprotected

Récupère un sous-chunk.

Paramètres

[out] chunk Reçoit le sous-chunk.

Renvoie: false si une erreur quelconque est arrivée.

Références castor3d::BinaryChunk::checkAvailable(), castor3d::BinaryChunk::getSubChunk(), et castor3d::BinaryParserBase< TParsed >::m_chunk.

Voici le graphe d'appel pour cette fonction :

◆ doParseChunk() [1/5]

template<class TParsed >

template<typename T , size_t Count>

bool castor3d::BinaryParserBase< TParsed >::doParseChunk	(	std::array< T, Count > &	values,
		BinaryChunk &	chunk
	)		const

inlineprotected

Récupère un tableau de valeurs à partir d'un chunk.

Paramètres

[out]	values	Reçoit les valeurs
[in]	chunk	Le chunk contenant les valeurs

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::ChunkParser< T >::parse().

Voici le graphe d'appel pour cette fonction :

◆ doParseChunk() [2/5]

template<class TParsed >

template<typename T >

bool castor3d::BinaryParserBase< TParsed >::doParseChunk	(	std::vector< T > &	values,
		BinaryChunk &	chunk
	)		const

inlineprotected

Récupère un tableau de valeurs à partir d'un chunk.

Paramètres

[out]	values	Reçoit les valeurs
[in]	chunk	Le chunk contenant les valeurs

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::ChunkParser< T >::parse().

Voici le graphe d'appel pour cette fonction :

◆ doParseChunk() [3/5]

template<class TParsed >

template<typename T >

bool castor3d::BinaryParserBase< TParsed >::doParseChunk	(	T &	value,
		BinaryChunk &	chunk
	)		const

inlineprotected

Récupère une valeur à partir d'un chunk.

Paramètres

[out]	value	Reçoit la valeur
[in]	chunk	Le chunk contenant la valeur

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::ChunkParser< T >::parse().

Voici le graphe d'appel pour cette fonction :

◆ doParseChunk() [4/5]

template<class TParsed >

template<typename T >

bool castor3d::BinaryParserBase< TParsed >::doParseChunk	(	T *	values,
		size_t	count,
		BinaryChunk &	chunk
	)		const

inlineprotected

Récupère un tableau de valeurs à partir d'un chunk.

Paramètres

[out]	values	Reçoit les valeurs
[out]	count	Le compte des valeurs
[in]	chunk	Le chunk contenant les valeurs

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::ChunkParser< T >::parse().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ doParseChunk() [5/5]

template<class TParsed >

template<typename T , size_t Count>

bool castor3d::BinaryParserBase< TParsed >::doParseChunk	(	T(&)	values[Count],
		BinaryChunk &	chunk
	)		const

inlineprotected

Récupère un tableau de valeurs à partir d'un chunk.

Paramètres

[out]	values	Reçoit les valeurs
[in]	chunk	Le chunk contenant les valeurs

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::ChunkParser< T >::parse().

Voici le graphe d'appel pour cette fonction :

◆ doParseHeader()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::doParseHeader ( BinaryChunk & chunk ) const

inlineprotected

Lit 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::checkAvailable(), castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::CurrentCmshVersion, castor3d::BinaryParserBase< TParsed >::doParseChunk(), castor3d::eCmshHeader, castor3d::eCmshVersion, castor3d::eName, castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), castor3d::getCmshMajor(), castor3d::getCmshMinor(), castor3d::getCmshRevision(), castor3d::BinaryChunk::getSubChunk(), castor3d::BinaryParserBase< TParsed >::m_fileVersion, et castor3d::log::warn.

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ operator=() [1/2]

template<class TParsed >

BinaryParserBase & castor3d::BinaryParserBase< TParsed >::operator= ( BinaryParserBase< TParsed > && )

default

◆ operator=() [2/2]

template<class TParsed >

BinaryParserBase & castor3d::BinaryParserBase< TParsed >::operator= ( BinaryParserBase< TParsed > const & )

default

◆ parse() [1/2]

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse	(	TParsed &	obj,
		BinaryChunk &	chunk
	)

inline

Fonction de lecture à partir d'un chunk.

Paramètres

[out]	obj	L'objet à lire
[in]	chunk	Le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), castor3d::BinaryParserBase< TParsed >::m_chunk, et castor3d::BinaryChunk::resetParse().

Voici le graphe d'appel pour cette fonction :

◆ parse() [2/2]

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse	(	TParsed &	obj,
		castor::BinaryFile &	file
	)

inline

Fonction de lecture à partir d'un fichier.

Paramètres

[out]	obj	L'objet à lire
[in]	file	Le fichier qui contient le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryChunk::checkAvailable(), castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryParserBase< TParsed >::doParseHeader(), castor3d::eCmshFile, castor3d::BinaryChunk::getChunkType(), castor3d::BinaryChunk::getSubChunk(), castor3d::BinaryParserBase< TParsed >::parse(), et castor3d::BinaryChunk::read().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ parse_v1_1()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse_v1_1	(	TParsed &	obj,
		BinaryChunk &	chunk
	)

inline

Fonction de lecture à partir d'un chunk.

Paramètres

[out]	obj	L'objet à lire
[in]	chunk	Le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), et castor3d::BinaryParserBase< TParsed >::m_chunk.

Voici le graphe d'appel pour cette fonction :

◆ parse_v1_2()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse_v1_2	(	TParsed &	obj,
		BinaryChunk &	chunk
	)

inline

Fonction de lecture à partir d'un chunk.

Paramètres

[out]	obj	L'objet à lire
[in]	chunk	Le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), et castor3d::BinaryParserBase< TParsed >::m_chunk.

Voici le graphe d'appel pour cette fonction :

◆ parse_v1_3()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse_v1_3	(	TParsed &	obj,
		BinaryChunk &	chunk
	)

inline

Fonction de lecture à partir d'un chunk.

Paramètres

[out]	obj	L'objet à lire
[in]	chunk	Le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), et castor3d::BinaryParserBase< TParsed >::m_chunk.

Voici le graphe d'appel pour cette fonction :

◆ parse_v1_4()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse_v1_4	(	TParsed &	obj,
		BinaryChunk &	chunk
	)

inline

Fonction de lecture à partir d'un chunk.

Paramètres

[out]	obj	L'objet à lire
[in]	chunk	Le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), et castor3d::BinaryParserBase< TParsed >::m_chunk.

Voici le graphe d'appel pour cette fonction :

◆ parse_v1_5()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::parse_v1_5	(	TParsed &	obj,
		BinaryChunk &	chunk
	)

inline

Fonction de lecture à partir d'un chunk.

Paramètres

[out]	obj	L'objet à lire
[in]	chunk	Le chunk

Renvoie: false si une erreur quelconque est arrivée

Références castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), et castor3d::BinaryParserBase< TParsed >::m_chunk.

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions amies et associées

◆ BinaryParserBase

template<class TParsed >

template<typename T >

friend class BinaryParserBase

friend

Documentation des données membres

◆ m_chunk

template<class TParsed >

BinaryChunk* castor3d::BinaryParserBase< TParsed >::m_chunk { nullptr }

protected

Le chunk du writer.

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

◆ m_fileVersion

template<class TParsed >

Version castor3d::BinaryParserBase< TParsed >::m_fileVersion

mutableprotected

La version du chunk dans le fichier.

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

◆ Name

template<class TParsed >

C3D_API castor::String castor3d::BinaryParserBase< TParsed >::Name

staticprotected

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

La documentation de cette classe a été générée à partir des fichiers suivants :

Binary/BinaryModule.hpp
Binary/BinaryParser.hpp

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Attributs protégés statiques

Amis

Description détaillée

Documentation des constructeurs et destructeur

◆ BinaryParserBase() [1/3]

◆ BinaryParserBase() [2/3]

◆ BinaryParserBase() [3/3]

◆ ~BinaryParserBase()

Documentation des fonctions membres

◆ checkError()

◆ createBinaryParser()

◆ doGetSubChunk()

◆ doParseChunk() [1/5]

◆ doParseChunk() [2/5]

◆ doParseChunk() [3/5]

◆ doParseChunk() [4/5]

◆ doParseChunk() [5/5]

◆ doParseHeader()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse() [1/2]

◆ parse() [2/2]

◆ parse_v1_1()

◆ parse_v1_2()

◆ parse_v1_3()

◆ parse_v1_4()

◆ parse_v1_5()

Documentation des fonctions amies et associées

◆ BinaryParserBase

Documentation des données membres

◆ m_chunk

◆ m_fileVersion

◆ Name