Deal with binary stream. More...

#include <PStream.h>

Public Member Functions
void	close ()
	Close the stream. More...

bool	isOpen () const
	Say if the stream is opened. More...

bool	open (const PPath &fileName, const PString &mode="r")
	Open the current stream. More...

template<typename T >
PStream &	operator<< (const T &value)
	Flux operator for stream. More...

template<typename T >
PStream &	operator>> (T &value)
	Flux operator for stream. More...

	PStream ()
	Default constructor of PStream. More...

template<typename T >
bool	read (T &value)
	Read a value from the stream. More...

template<typename T >
bool	read (T *tabValue, size_t nbRow, size_t nbCol, size_t padding=0lu)
	Read a table values from the stream. More...

template<typename T >
bool	read (T *tabValue, size_t nbValue)
	Read a value from the stream. More...

template<typename T >
bool	write (const T &value)
	Write a value into the stream. More...

template<typename T >
bool	write (const T *tabValue, size_t nbRow, size_t nbCol, size_t padding=0lu)
	Write a table values into the stream. More...

template<typename T >
bool	write (const T *tabValue, size_t nbValue)
	Write a table values into the stream. More...

virtual	~PStream ()
	Destructor of PStream. More...

Private Member Functions
void	initialisationPStream ()
	Initialisation function of the class PStream. More...

Private Attributes
FILE *	p_fp
	Pointer to the main stream. More...

Detailed Description

Deal with binary stream.

Definition at line 14 of file PStream.h.

Constructor & Destructor Documentation

◆ PStream()

PStream::PStream ( )

Default constructor of PStream.

Definition at line 11 of file PStream.cpp.

                 {
         initialisationPStream();
 }

References initialisationPStream().

Here is the call graph for this function:

◆ ~PStream()

PStream::~PStream ( )

virtual

Destructor of PStream.

Definition at line 16 of file PStream.cpp.

                  {
         close();
 }

References close().

Here is the call graph for this function:

Member Function Documentation

◆ close()

void PStream::close ( )

Close the stream.

Definition at line 32 of file PStream.cpp.

                    {
         if(isOpen()){
                 fclose(p_fp);
                 p_fp = NULL;
         }
 }

References isOpen(), and p_fp.

Referenced by open(), testPStream(), testPStreamMatrix(), testPStreamTable(), and ~PStream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialisationPStream()

void PStream::initialisationPStream ( )

private

Initialisation function of the class PStream.

Definition at line 47 of file PStream.cpp.

                                    {
         p_fp = NULL;
 }

References p_fp.

Referenced by PStream().

Here is the caller graph for this function:

◆ isOpen()

bool PStream::isOpen ( ) const

Say if the stream is opened.

Returns: true if it is opened, false otherwise

Definition at line 42 of file PStream.cpp.

                           {
         return p_fp != NULL;
 }

References p_fp.

Referenced by close(), and open().

Here is the caller graph for this function:

◆ open()

bool PStream::open	(	const PPath &	fileName,
		const PString &	mode = `"r"`
	)

Open the current stream.

Parameters

fileName	: name of the file to be used
mode	: open mode, r : read only, write : write only, etc

Returns: true on success, false otherwise

Definition at line 25 of file PStream.cpp.

                                                               {
         close();
         p_fp = fopen(fileName.c_str(), mode.c_str());
         return isOpen();
 }

References close(), isOpen(), and p_fp.

Referenced by testPStream(), testPStreamMatrix(), and testPStreamTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator<<()

template<typename T >

PStream & PStream::operator<< ( const T & value )

Flux operator for stream.

Parameters

value : value to be put in the stream

Returns: modified stream

Definition at line 17 of file PStream_impl.h.

                                               {
         write(value);
         return *this;
 }

References write().

Here is the call graph for this function:

◆ operator>>()

template<typename T >

PStream & PStream::operator>> ( T & value )

Flux operator for stream.

Parameters

value : value to be read from the stream

Returns: modified stream

Definition at line 27 of file PStream_impl.h.

                                         {
         read(value);
         return *this;
 }

References read().

Here is the call graph for this function:

◆ read() [1/3]

template<typename T >

bool PStream::read ( T & value )

Read a value from the stream.

Parameters

value : value to be read from the stream

Returns: true on success, false otherwise

Definition at line 73 of file PStream_impl.h.

                            {
         return fread((void*)&value, sizeof(T), 1lu, p_fp) == 1lu;
 }

References p_fp.

Referenced by operator>>(), read(), testPStreamMatrix(), and testPStreamTable().

Here is the caller graph for this function:

◆ read() [2/3]

template<typename T >

bool PStream::read	(	T *	tabValue,
		size_t	nbRow,
		size_t	nbCol,
		size_t	padding = `0lu`
	)

Read a table values from the stream.

Parameters

tabValue	: table of values to be read from the stream
nbRow	: number of rows of the matrix
nbCol	: number of columns of the matrix
padding	: padding of the rows

Returns: true on success, false otherwise

Definition at line 94 of file PStream_impl.h.

                                                                           {
         bool b(true);
         size_t rowSize(nbCol + padding);
         for(size_t i(0lu); i < nbRow; ++i){
                 b &= read(tabValue + i*rowSize, nbCol);
         }
         return b;
 }

References read().

Here is the call graph for this function:

◆ read() [3/3]

template<typename T >

bool PStream::read	(	T *	tabValue,
		size_t	nbValue
	)

Read a value from the stream.

Parameters

tabValue	: table of values to be read from the stream
nbValue	: number of values of the table

Definition at line 82 of file PStream_impl.h.

                                               {
         return fread((void*)tabValue, sizeof(T), nbValue, p_fp) == nbValue;
 }

References p_fp.

◆ write() [1/3]

template<typename T >

bool PStream::write ( const T & value )

Write a value into the stream.

Parameters

value : value to be written into the stream

Returns: true on success, false otherwise

Definition at line 37 of file PStream_impl.h.

                                   {
         return fwrite((const void*)&value, sizeof(T), 1lu, p_fp) == 1lu;
 }

References p_fp.

Referenced by operator<<(), testPStreamMatrix(), testPStreamTable(), and write().

Here is the caller graph for this function:

◆ write() [2/3]

template<typename T >

bool PStream::write	(	const T *	tabValue,
		size_t	nbRow,
		size_t	nbCol,
		size_t	padding = `0lu`
	)

Write a table values into the stream.

Parameters

tabValue	: table of values to be written into the stream
nbRow	: number of rows of the matrix
nbCol	: number of columns of the matrix
padding	: padding of the rows

Returns: true on success, false otherwise

Definition at line 59 of file PStream_impl.h.

                                                                                  {
         bool b(true);
         size_t rowSize(nbCol + padding);
         for(size_t i(0lu); i < nbRow; ++i){
                 b &= write(tabValue + i*rowSize, nbCol);
         }
         return b;
 }

References write().

Here is the call graph for this function:

◆ write() [3/3]

template<typename T >

bool PStream::write	(	const T *	tabValue,
		size_t	nbValue
	)

Write a table values into the stream.

Parameters

tabValue	: table of values to be written into the stream
nbValue	: number of values of the table

Returns: true on success, false otherwise

Definition at line 47 of file PStream_impl.h.

                                                      {
         return fwrite((const void*)tabValue, sizeof(T), nbValue, p_fp) == nbValue;
 }

References p_fp.

Member Data Documentation

◆ p_fp

FILE* PStream::p_fp

private

Pointer to the main stream.

Definition at line 51 of file PStream.h.

Referenced by close(), initialisationPStream(), isOpen(), open(), read(), and write().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixCore/src/PStream.h
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixCore/src/PStream.cpp
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixCore/src/PStream_impl.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PStream()

◆ ~PStream()

Member Function Documentation

◆ close()

◆ initialisationPStream()

◆ isOpen()

◆ open()

◆ operator<<()

◆ operator>>()

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

Member Data Documentation

◆ p_fp