Template specialisation of JBinaryFileReader for serialisable data types. More...

#include <JBinaryFileReader.hh>

Inheritance diagram for JIO::JBinaryFileReader< T, true >:

Public Types
typedef JPointer< T >	pointer_type
	Type definition of pointer_type. More...

typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JBinaryFileReader ()
	Default constructor. More...

virtual bool	hasNext ()=0
	Check availability of next element. More...

virtual const pointer_type &	next ()=0
	Get next element. More...

virtual skip_type	skip (const skip_type ns)
	Skip items. More...

virtual bool	is_open () const =0
	Check is device is open. More...

virtual void	open (const char *file_name)=0
	Open device. More...

virtual void	close ()=0
	Close device. More...

virtual void	open (const char *file_name) override
	Open file. More...

virtual bool	is_open () const
	Check is file is open. More...

virtual void	close ()
	Close file. More...

virtual bool	getStatus () const override
	Status of reader. More...

virtual void	clear () override
	Clear status of reader. More...

virtual int	read (char *buffer, const int length) override
	Read byte array. More...

JReader &	operator>> (JSerialisable &object)
	Read serialisable data object. More...

JReader &	operator>> (bool &value)

JReader &	operator>> (char &value)

JReader &	operator>> (unsigned char &value)

JReader &	operator>> (short &value)

JReader &	operator>> (unsigned short &value)

JReader &	operator>> (int &value)

JReader &	operator>> (unsigned int &value)

JReader &	operator>> (long int &value)

JReader &	operator>> (unsigned long int &value)

JReader &	operator>> (long long int &value)

JReader &	operator>> (unsigned long long int &value)

JReader &	operator>> (float &value)

JReader &	operator>> (double &value)

JReader &	operator>> (long double &value)

JReader &	operator>> (JLANG::JObjectID &value)

JReader &	load (JSerialisable &object)
	Read object. More...

template<class T >
JReader &	load (T &object)
	Read object. More...

	operator bool () const
	Type conversion operator. More...

bool	operator! () const
	Negated status of this object. More...

virtual bool	setObject (T &object) override
	Set object. More...

virtual bool	hasNext () override
	Check availability of next element. More...

virtual const pointer_type &	next () override
	Get next element. More...

Static Public Member Functions
static void	Throw (const bool option)
	Enable/disable throw option. More...

static int	Throw (const JException_t &error, const int value=-1)
	Throw exception or return error. More...

Protected Attributes
std::istream &	in

T	object
	object More...

bool	has_next
	status More...

Static Protected Attributes
static bool	do_throw
	throw option More...

Private Member Functions
bool	setObject (T &object, JLANG::JBool< true >)

bool	setObject (T &object, JLANG::JBool< false >)

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
class JIO::JBinaryFileReader< T, true >

Template specialisation of JBinaryFileReader for serialisable data types.

This class provides for an implementation of the JLANG::JAccessibleObjectIterator interface.

Definition at line 41 of file JBinaryFileReader.hh.

Member Typedef Documentation

◆ pointer_type [1/2]

template<class T >

typedef JPointer<T> JLANG::JObjectIterator< T >::pointer_type

inherited

Type definition of pointer_type.

Definition at line 58 of file JObjectIterator.hh.

◆ pointer_type [2/2]

template<class T >

typedef JObjectIterator<T>::pointer_type JLANG::JAbstractObjectIterator< T >::pointer_type

inherited

Definition at line 39 of file JAbstractObjectIterator.hh.

Constructor & Destructor Documentation

◆ JBinaryFileReader()

template<class T >

JIO::JBinaryFileReader< T, true >::JBinaryFileReader ( )

inline

Default constructor.

Definition at line 51 of file JBinaryFileReader.hh.

                         :
       JAccessibleBinaryInputStream(),
       JStreamReader           (static_cast<std::istream&> (*this)),
       JReaderObjectIterator<T>(static_cast<JStreamReader&>(*this))
     {}

Member Function Documentation

◆ hasNext() [1/2]

template<class T >

virtual bool JLANG::JObjectIterator< T >::hasNext ( )

pure virtualinherited

Check availability of next element.

Returns: true if the iteration has more elements; else false

Implemented in JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner<>, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner< Evt >, JROOT::JTreeReaderObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JMarkerAttributes, JROOT::JLineAttributes, JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< T, JSampler >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectIterator< T >, and JLANG::JNullIterator< T >.

◆ next() [1/2]

template<class T >

virtual const pointer_type& JLANG::JObjectIterator< T >::next ( )

pure virtualinherited

Get next element.

Returns: pointer to element

Implemented in JSUPPORT::JTriggeredFileScanner< JTypelist_t, JFileScanner_t >, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner<>, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JParallelFileScanner< T, JFileScanner_t >, JSUPPORT::JParallelFileScanner< JTypeList< JDAQEvent, JNullType >, JMultipleFileScanner >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner< Evt >, JROOT::JTreeReaderObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JMarkerAttributes, JROOT::JLineAttributes, JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JObjectSampler< T, JSampler_t >, JLANG::JObjectSampler< T, JSampler >, JLANG::JObjectMultiplexer< JTypeList< JHead_t, JTail_t >, JBase_t >, JLANG::JObjectMultiplexer< JDerived_t, JBase_t >, JLANG::JObjectMultiplexer< JHead_t, JBase_t >, JLANG::JObjectMultiplexer< JTail_t, JBase_t >, JLANG::JConversionIterator< JInput_t, JOutput_t >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectIterator< T >, and JLANG::JNullIterator< T >.

◆ skip()

template<class T >

virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type ns )

inlinevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns: number of items skipped

Reimplemented in JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, and JLANG::JAbstractObjectReader< T >.

Definition at line 90 of file JObjectIterator.hh.

     {
       skip_type i = 0;
  
       for ( ; i != ns && hasNext(); ++i) {
         next();
       }
  
       return i;
     }

◆ is_open() [1/2]

virtual bool JLANG::JAccessible::is_open ( ) const

pure virtualinherited

Check is device is open.

Returns: true if open; else false

Implemented in JROOT::JTreeReaderAccessibleObjectIterator< T >, JROOT::JRootFile, JLANG::JGZFileWriter< T >, JLANG::JGZFileReader< T >, JLANG::JNullAccess, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAccessibleOutputStream, and JLANG::JAccessibleInputStream.

◆ open() [1/2]

virtual void JLANG::JAccessible::open ( const char * file_name )

pure virtualinherited

◆ close() [1/2]

virtual void JLANG::JAccessible::close ( )

pure virtualinherited

Close device.

Implemented in JSUPPORT::JTreeRecorder< T >, JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JROOT::JTreeReaderAccessibleObjectIterator< T >, JROOT::JRootOutputFile, JROOT::JRootInputFile, JLANG::JGZFileWriter< T >, JLANG::JGZFileReader< T >, JLANG::JNullAccess, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAccessibleOutputStream, and JLANG::JAccessibleInputStream.

◆ Throw() [1/2]

static void JLANG::JThrow< JAccessible >::Throw ( const bool option )

inlinestaticinherited

Enable/disable throw option.

Parameters

option true enable; false disable

Definition at line 37 of file JThrow.hh.

     {
       do_throw = option;
     }

◆ Throw() [2/2]

static int JLANG::JThrow< JAccessible >::Throw	(	const JException_t &	error,
		const int	value = `-1`
	)

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns: return code

Definition at line 51 of file JThrow.hh.

     {
       using namespace std;
       
       if (do_throw) {
         throw error;
       }
  
       cerr << error.what() << endl;
       
       return value;
     }

◆ open() [2/2]

virtual void JLANG::JAccessibleBinaryInputStream::open ( const char * file_name )

inlineoverridevirtualinherited

Open file.

Parameters

file_name file name

Reimplemented from JLANG::JAccessibleInputStream.

Definition at line 52 of file JAccessibleBinaryStream.hh.

     {
       std::ifstream::open(file_name, std::ios::binary);
     }

◆ is_open() [2/2]

virtual bool JLANG::JAccessibleInputStream::is_open ( ) const

inlinevirtualinherited

Check is file is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 53 of file JAccessibleStream.hh.

     {
       return std::ifstream::is_open();
     }

◆ close() [2/2]

virtual void JLANG::JAccessibleInputStream::close ( )

inlinevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 77 of file JAccessibleStream.hh.

     {
       std::ifstream::close();
     }

◆ getStatus()

virtual bool JIO::JStreamReader::getStatus ( ) const

inlineoverridevirtualinherited

Status of reader.

Returns: status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 43 of file JStreamIO.hh.

     { 
       return (bool) in; 
     }

◆ clear()

virtual void JIO::JStreamReader::clear ( )

inlineoverridevirtualinherited

Clear status of reader.

Reimplemented from JIO::JReader.

Definition at line 52 of file JStreamIO.hh.

     {
       in.clear();
     }

◆ read()

virtual int JIO::JStreamReader::read	(	char *	buffer,
		const int	length
	)

inlineoverridevirtualinherited

Read byte array.

Parameters

buffer	pointer to byte array
length	number of bytes

Returns: number of bytes read

Implements JLANG::JBinaryInput.

Definition at line 65 of file JStreamIO.hh.

     { 
       in.read(buffer, length); 
  
       return in.gcount();
     }

◆ operator>>() [1/16]

JReader& JIO::JReader::operator>> ( JSerialisable & object )

inlineinherited

Read serialisable data object.

Parameters

object serialisable data object

Returns: JReader

Definition at line 81 of file JSerialisable.hh.

     { 
       return object.read(*this); 
     }

◆ operator>>() [2/16]

JReader& JIO::JReader::operator>> ( bool & value )

inlineinherited

Definition at line 87 of file JSerialisable.hh.

87 { read((char*) &value, sizeof(bool)); return *this; }

JLANG::JBinaryInput::read

virtual int read(char *buffer, const int length)=0

Read byte array.

◆ operator>>() [3/16]

JReader& JIO::JReader::operator>> ( char & value )

inlineinherited

Definition at line 88 of file JSerialisable.hh.

88 { read((char*) &value, sizeof(char)); return *this; }

◆ operator>>() [4/16]

JReader& JIO::JReader::operator>> ( unsigned char & value )

inlineinherited

Definition at line 89 of file JSerialisable.hh.

89 { read((char*) &value, sizeof(unsigned char)); return *this; }

◆ operator>>() [5/16]

JReader& JIO::JReader::operator>> ( short & value )

inlineinherited

Definition at line 90 of file JSerialisable.hh.

90 { read((char*) &value, sizeof(short)); return *this; }

◆ operator>>() [6/16]

JReader& JIO::JReader::operator>> ( unsigned short & value )

inlineinherited

Definition at line 91 of file JSerialisable.hh.

91 { read((char*) &value, sizeof(unsigned short)); return *this; }

◆ operator>>() [7/16]

JReader& JIO::JReader::operator>> ( int & value )

inlineinherited

Definition at line 92 of file JSerialisable.hh.

92 { read((char*) &value, sizeof(int)); return *this; }

◆ operator>>() [8/16]

JReader& JIO::JReader::operator>> ( unsigned int & value )

inlineinherited

Definition at line 93 of file JSerialisable.hh.

93 { read((char*) &value, sizeof(unsigned int)); return *this; }

◆ operator>>() [9/16]

JReader& JIO::JReader::operator>> ( long int & value )

inlineinherited

Definition at line 94 of file JSerialisable.hh.

94 { read((char*) &value, sizeof(long int)); return *this; }

◆ operator>>() [10/16]

JReader& JIO::JReader::operator>> ( unsigned long int & value )

inlineinherited

Definition at line 95 of file JSerialisable.hh.

95 { read((char*) &value, sizeof(unsigned long int)); return *this; }

◆ operator>>() [11/16]

JReader& JIO::JReader::operator>> ( long long int & value )

inlineinherited

Definition at line 96 of file JSerialisable.hh.

96 { read((char*) &value, sizeof(long long int)); return *this; }

◆ operator>>() [12/16]

JReader& JIO::JReader::operator>> ( unsigned long long int & value )

inlineinherited

Definition at line 97 of file JSerialisable.hh.

97 { read((char*) &value, sizeof(unsigned long long int)); return *this; }

◆ operator>>() [13/16]

JReader& JIO::JReader::operator>> ( float & value )

inlineinherited

Definition at line 98 of file JSerialisable.hh.

98 { read((char*) &value, sizeof(float)); return *this; }

◆ operator>>() [14/16]

JReader& JIO::JReader::operator>> ( double & value )

inlineinherited

Definition at line 99 of file JSerialisable.hh.

99 { read((char*) &value, sizeof(double)); return *this; }

◆ operator>>() [15/16]

JReader& JIO::JReader::operator>> ( long double & value )

inlineinherited

Definition at line 100 of file JSerialisable.hh.

100 { read((char*) &value, sizeof(long double)); return *this; }

◆ operator>>() [16/16]

JReader& JIO::JReader::operator>> ( JLANG::JObjectID & value )

inlineinherited

Definition at line 101 of file JSerialisable.hh.

101 { return (*this) >> value.getID(); }

JLANG::JObjectID::getID

int getID() const

Get identifier.

Definition: JObjectID.hh:50

◆ load() [1/2]

JReader& JIO::JReader::load ( JSerialisable & object )

inlineinherited

Read object.

Parameters

object object

Returns: this reader

Definition at line 110 of file JSerialisable.hh.

     {
       return object.read(*this);
     }

◆ load() [2/2]

template<class T >

JReader& JIO::JReader::load ( T & object )

inlineinherited

Read object.

Parameters

object object

Returns: this reader

Definition at line 123 of file JSerialisable.hh.

     {
       return *this >> object;
     }

◆ operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const

inlineinherited

Type conversion operator.

Returns: status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

     {
       return this->getStatus();
     }

◆ operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const

inlineinherited

Negated status of this object.

Returns: negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

     {
       return !(this->getStatus());
     }

◆ setObject() [1/3]

template<class T >

virtual bool JIO::JReaderObjectIterator< T >::setObject ( T & object )

inlineoverridevirtualinherited

Set object.

Parameters

object reference to object to be set

Returns: true if set; else false

Implements JLANG::JAbstractObjectIterator< T >.

Reimplemented in JSUPPORT::JDAQFileReader< T, true >.

Definition at line 48 of file JReaderObjectIterator.hh.

     {
       return setObject(object, JLANG::JBool<JLANG::JConversion<T,JSerialisable>::is_derived>());
     }

◆ setObject() [2/3]

template<class T >

bool JIO::JReaderObjectIterator< T >::setObject	(	T &	object,
		JLANG::JBool< true >
	)

inlineprivateinherited

Definition at line 54 of file JReaderObjectIterator.hh.

54 { return (bool) object.read(in); }

JIO::JReaderObjectIterator::in

JReader & in

Definition: JReaderObjectIterator.hh:57

◆ setObject() [3/3]

template<class T >

bool JIO::JReaderObjectIterator< T >::setObject	(	T &	object,
		JLANG::JBool< false >
	)

inlineprivateinherited

Definition at line 55 of file JReaderObjectIterator.hh.

55 { return (bool) (in >> object); }

JLANG::JAbstractObjectIterator::object

T object

object

Definition: JAbstractObjectIterator.hh:34

◆ hasNext() [2/2]

template<class T >

virtual bool JLANG::JAbstractObjectIterator< T >::hasNext ( )

inlineoverridevirtualinherited

Check availability of next element.

Returns: true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 56 of file JAbstractObjectIterator.hh.

     {
       if (!has_next) {
         has_next = this->setObject(object);
       }
  
       return has_next;
     }

◆ next() [2/2]

template<class T >

virtual const pointer_type& JLANG::JAbstractObjectIterator< T >::next ( )

inlineoverridevirtualinherited

Get next element.

Returns: pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 71 of file JAbstractObjectIterator.hh.

     {
       if (has_next)
         ps.reset(&this->object);
       else
         ps.reset(NULL);
  
       has_next = false;
       
       return ps;
     }

Member Data Documentation

◆ do_throw

bool JLANG::JThrow< JAccessible >::do_throw

staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

◆ in

std::istream& JIO::JStreamReader::in

protectedinherited

Definition at line 73 of file JStreamIO.hh.

◆ object

template<class T >

T JLANG::JAbstractObjectIterator< T >::object

protectedinherited

object

Definition at line 34 of file JAbstractObjectIterator.hh.

◆ has_next

template<class T >

bool JLANG::JAbstractObjectIterator< T >::has_next

protectedinherited

status

Definition at line 35 of file JAbstractObjectIterator.hh.

◆ ps

template<class T >

pointer_type JLANG::JAbstractObjectIterator< T >::ps

privateinherited

Definition at line 84 of file JAbstractObjectIterator.hh.

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

JBinaryFileReader.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class T> class JIO::JBinaryFileReader< T, true >

Member Typedef Documentation

◆ pointer_type [1/2]

◆ pointer_type [2/2]

Constructor & Destructor Documentation

◆ JBinaryFileReader()

Member Function Documentation

◆ hasNext() [1/2]

◆ next() [1/2]

◆ skip()

◆ is_open() [1/2]

◆ open() [1/2]

◆ close() [1/2]

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ open() [2/2]

◆ is_open() [2/2]

◆ close() [2/2]

◆ getStatus()

◆ clear()

◆ read()

◆ operator>>() [1/16]

◆ operator>>() [2/16]

◆ operator>>() [3/16]

◆ operator>>() [4/16]

◆ operator>>() [5/16]

◆ operator>>() [6/16]

◆ operator>>() [7/16]

◆ operator>>() [8/16]

◆ operator>>() [9/16]

◆ operator>>() [10/16]

◆ operator>>() [11/16]

◆ operator>>() [12/16]

◆ operator>>() [13/16]

◆ operator>>() [14/16]

◆ operator>>() [15/16]

◆ operator>>() [16/16]

◆ load() [1/2]

◆ load() [2/2]

◆ operator bool()

◆ operator!()

◆ setObject() [1/3]

◆ setObject() [2/3]

◆ setObject() [3/3]

◆ hasNext() [2/2]

◆ next() [2/2]

Member Data Documentation

◆ do_throw

◆ in

◆ object

◆ has_next

◆ ps

template<class T>
class JIO::JBinaryFileReader< T, true >