Binary data chunk reader base class. More...

#include <BinaryParser.hpp>

Inheritance diagram for castor3d::BinaryParserBase< TParsed >:

[legend]

Collaboration diagram for castor3d::BinaryParserBase< TParsed >:

[legend]

Public Member Functions
	BinaryParserBase ()=default

	BinaryParserBase (BinaryParserBase const &)=default

	BinaryParserBase (BinaryParserBase &&) noexcept=default

BinaryParserBase &	operator= (BinaryParserBase const &)=default

BinaryParserBase &	operator= (BinaryParserBase &&) noexcept=default

virtual	~BinaryParserBase () noexcept=default

template<typename T >
BinaryParser< T >	createBinaryParser ()
	Creates a binary parser.

bool	parse (TParsed &obj, castor::BinaryFile &file)
	From file reader function.

bool	parse (TParsed &obj, BinaryChunk &chunk)
	From chunk reader function.

Protected Member Functions
bool	doIsLittleEndian () const noexcept

bool	doParseHeader (BinaryChunk &chunk) const
	Parses the header chunk.

template<typename T >
bool	doParseChunk (T *values, size_t count, BinaryChunk &chunk) const
	Retrieves a value array from a chunk.

template<typename T , size_t Count>
bool	doParseChunk (T(&values)[Count], BinaryChunk &chunk) const
	Retrieves a value array from a chunk.

template<typename T , size_t Count>
bool	doParseChunk (castor::Array< T, Count > &values, BinaryChunk &chunk) const
	Retrieves a value array from a chunk.

template<typename T >
bool	doParseChunk (castor::Vector< T > &values, BinaryChunk &chunk) const
	Retrieves a value array from a chunk.

template<typename T >
bool	doParseChunk (T &value, BinaryChunk &chunk) const
	Retrieves a value from a chunk.

bool	doGetSubChunk (BinaryChunk &chunk)
	Retrieves a subchunk.

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

Protected Attributes
BinaryChunk *	m_chunk { nullptr }

Version	m_fileVersion

Static Protected Attributes
static C3D_API castor::String	Name

Friends
template<typename T >
class	BinaryParserBase

Detailed Description

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

Binary data chunk reader base class.

Constructor & Destructor Documentation

◆ 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 > && )

defaultnoexcept

◆ ~BinaryParserBase()

template<class TParsed >

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

virtualdefaultnoexcept

Member Function Documentation

◆ checkError()

template<class TParsed >

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

inlineprotected

References castor3d::log::error, and castor3d::BinaryParserBase< TParsed >::Name.

Referenced by castor3d::BinaryParserBase< TParsed >::doParseHeader(), castor3d::BinaryParserBase< TParsed >::parse(), and castor3d::BinaryParserBase< TParsed >::parse().

Here is the caller graph for this function:

◆ createBinaryParser()

template<class TParsed >

template<typename T >

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

inline

Creates a binary parser.

References castor3d::BinaryParserBase< TParsed >::m_fileVersion.

◆ doGetSubChunk()

template<class TParsed >

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

inlineprotected

Retrieves a subchunk.

Parameters

[out] chunk Receives the subchunk.

Returns: false if any error occured.

References castor3d::BinaryChunk::checkAvailable(), CU_Require, castor3d::BinaryChunk::getSubChunk(), and castor3d::BinaryParserBase< TParsed >::m_chunk.

Here is the call graph for this function:

◆ doIsLittleEndian()

template<class TParsed >

bool castor3d::BinaryParserBase< TParsed >::doIsLittleEndian ( ) const

inlineprotectednoexcept

References castor::isLittleEndian(), castor3d::isLittleEndian(), and castor3d::BinaryParserBase< TParsed >::m_chunk.

Here is the call graph for this function:

◆ doParseChunk() [1/5]

template<class TParsed >

template<typename T , size_t Count>

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

inlineprotected

Retrieves a value array from a chunk.

Parameters

[out]	values	Receives the parsed values
[in]	chunk	The chunk containing the values

Returns: false if any error occured

References castor3d::ChunkParser< T >::parse().

Here is the call graph for this function:

◆ doParseChunk() [2/5]

template<class TParsed >

template<typename T >

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

inlineprotected

Retrieves a value array from a chunk.

Parameters

[out]	values	Receives the parsed values
[in]	chunk	The chunk containing the values

Returns: false if any error occured

References castor3d::ChunkParser< T >::parse().

Here is the call graph for this function:

◆ doParseChunk() [3/5]

template<class TParsed >

template<typename T >

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

inlineprotected

Retrieves a value from a chunk.

Parameters

[out]	value	Receives the parsed value
[in]	chunk	The chunk containing the value

Returns: false if any error occured

References castor3d::ChunkParser< T >::parse().

Here is the call graph for this function:

◆ doParseChunk() [4/5]

template<class TParsed >

template<typename T >

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

inlineprotected

Retrieves a value array from a chunk.

Parameters

[out]	values	Receives the parsed values
[out]	count	The values count
[in]	chunk	The chunk containing the values

Returns: false if any error occured

References castor3d::ChunkParser< T >::parse().

Referenced by castor3d::BinaryParserBase< TParsed >::doParseHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doParseChunk() [5/5]

template<class TParsed >

template<typename T , size_t Count>

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

inlineprotected

Retrieves a value array from a chunk.

Parameters

[out]	values	Receives the parsed values
[in]	chunk	The chunk containing the values

Returns: false if any error occured

References castor3d::ChunkParser< T >::parse().

Here is the call graph for this function:

◆ doParseHeader()

template<class TParsed >

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

inlineprotected

Parses the header chunk.

Parameters

[in,out] chunk The parent chunk.

Returns: false if any error occured.

References castor3d::BinaryParserBase< TParsed >::checkError(), castor3d::CurrentCmshVersion, cuT, castor3d::BinaryParserBase< TParsed >::doParseChunk(), castor3d::eCmshHeader, castor3d::eCmshVersion, castor3d::eName, castor3d::BinaryChunk::endParse(), castor3d::getCmshMajor(), castor3d::getCmshMinor(), castor3d::getCmshRevision(), castor3d::BinaryChunk::getSubChunk(), castor3d::isLittleEndian(), castor3d::BinaryParserBase< TParsed >::m_fileVersion, and castor3d::log::warn.

Referenced by castor3d::BinaryParserBase< TParsed >::parse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

template<class TParsed >

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

defaultnoexcept

◆ 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

From chunk reader function.

Parameters

[out]	obj	The object to read
[in]	chunk	The chunk

Returns: false if any error occured

References castor3d::BinaryParserBase< TParsed >::checkError(), cuT, castor3d::BinaryChunk::endParse(), castor3d::BinaryChunk::getChunkType(), castor3d::BinaryParserBase< TParsed >::m_chunk, and castor3d::BinaryChunk::resetParse().

Here is the call graph for this function:

◆ parse() [2/2]

template<class TParsed >

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

inline

From file reader function.

Parameters

[out]	obj	The object to read
[in]	file	The file containing the chunk

Returns: false if any error occured

References castor3d::BinaryParserBase< TParsed >::checkError(), cuT, castor3d::BinaryParserBase< TParsed >::doParseHeader(), castor3d::eCmshFile, castor3d::isLittleEndian(), castor3d::BinaryParserBase< TParsed >::parse(), and castor3d::BinaryChunk::read().

Referenced by castor3d::BinaryParserBase< TParsed >::parse().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ BinaryParserBase

template<class TParsed >

template<typename T >

friend class BinaryParserBase

friend

Member Data Documentation

◆ m_chunk

template<class TParsed >

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

protected

The writer's chunk.

Referenced by castor3d::BinaryParserBase< TParsed >::doGetSubChunk(), castor3d::BinaryParserBase< TParsed >::doIsLittleEndian(), and castor3d::BinaryParserBase< TParsed >::parse().

◆ m_fileVersion

template<class TParsed >

Version castor3d::BinaryParserBase< TParsed >::m_fileVersion

mutableprotected

The chunk version from the file.

Referenced by castor3d::BinaryParserBase< TParsed >::createBinaryParser(), and castor3d::BinaryParserBase< TParsed >::doParseHeader().

◆ Name

template<class TParsed >

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

staticprotected

Referenced by castor3d::BinaryParserBase< TParsed >::checkError().

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

Castor3D/Binary/BinaryModule.hpp
Castor3D/Binary/BinaryParser.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BinaryParserBase() [1/3]

◆ BinaryParserBase() [2/3]

◆ BinaryParserBase() [3/3]

◆ ~BinaryParserBase()

Member Function Documentation

◆ checkError()

◆ createBinaryParser()

◆ doGetSubChunk()

◆ doIsLittleEndian()

◆ 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]

Friends And Related Symbol Documentation

◆ BinaryParserBase

Member Data Documentation

◆ m_chunk

◆ m_fileVersion

◆ Name