JSUPPORT::JDAQFileReader< T, true > Class Template Reference

Template specialisation of JDAQFileReader for DAQ compatible data types. More...

#include <JDAQFileReader.hh>

Inheritance diagram for JSUPPORT::JDAQFileReader< T, true >:

Public Types
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JDAQFileReader ()
	Default constructor.
virtual bool	setObject (T &object) override
	Set object.
virtual void	open (const char *file_name) override
	Open file.
virtual bool	is_open () const
	Check is file is open.
virtual void	close ()
	Close file.
virtual bool	getStatus () const override
	Status of reader.
virtual void	clear () override
	Clear status of reader.
virtual int	read (char *buffer, const int length) override
	Read byte array.
JReader &	operator>> (JSerialisable &object)
	Read serialisable data object.
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 &	operator>> (JLANG::JStatus &value)
JReader &	load (JSerialisable &object)
	Read object.
template<class T >
JReader &	load (T &object)
	Read object.
	operator bool () const
	Type conversion operator.
bool	operator! () const
	Negated status of this object.
virtual bool	hasNext () override
	Check availability of next element.
virtual const pointer_type &	next () override
	Get next element.
virtual skip_type	skip (const skip_type ns)
	Skip items.

Static Public Member Functions
static void	Throw (const bool option)
	Enable/disable throw option.
static int	Throw (const JException_t &error, const int value=-1)
	Throw exception or return error.

Protected Attributes
std::istream &	in
T	object
	object
bool	has_next
	status

Static Protected Attributes
static bool	do_throw
	throw option

Private Attributes
JDAQPreamble	preamble
std::vector< char >	buffer
pointer_type	ps

Detailed Description

template<class T>
class JSUPPORT::JDAQFileReader< T, true >

Template specialisation of JDAQFileReader for DAQ compatible data types.

This class provides for an implementation of the JLANG::JAccessibleObjectIterator interface.
The method JLANG::JAbstractObjectIterator::setObject is overwritten so that the desired object is read from the file which may contain also other objects.

Definition at line 52 of file JDAQFileReader.hh.

Member Typedef Documentation

pointer_type

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

JDAQFileReader()

template<class T >

JSUPPORT::JDAQFileReader< T, true >::JDAQFileReader ( )

inline

Default constructor.

Definition at line 62 of file JDAQFileReader.hh.

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

Member Function Documentation

setObject()

template<class T >

virtual bool JSUPPORT::JDAQFileReader< T, true >::setObject ( T & object )

inlineoverridevirtual

Set object.

Parameters

object

reference to object to be set

Returns

true if set; else false

Reimplemented from JIO::JReaderObjectIterator< T >.

Definition at line 75 of file JDAQFileReader.hh.

    {
      using namespace std;
      using namespace KM3NETDAQ;
      using namespace JIO;
 
      for (JStreamReader& in = static_cast<JStreamReader&>(*this); in >> preamble; ) {
 
        if        (preamble.getLength() < (int) getSizeof<JDAQPreamble>()) {
              
          this->setstate(ios::badbit);
          
          return false;
          
        } else if (preamble.getDataType() == getDataType<T>()) {
            
          buffer.resize(preamble.getLength());
 
          memcpy(buffer.data(), static_cast<JDAQAbstractPreamble*>(&preamble), getSizeof<JDAQPreamble>());
          
          in.read(buffer.data()        + getSizeof<JDAQPreamble>(),
                  preamble.getLength() - getSizeof<JDAQPreamble>());
          
          JByteArrayReader bin(buffer.data(), buffer.size());
 
          bin >> object;
          
          return (bool) in;
          
        } else {
            
          this->ignore((streamsize) (preamble.getLength() - getSizeof<JDAQPreamble>()));
        }
      }  
 
      return false;
    }

open()

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()

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()

virtual void JLANG::JAccessibleInputStream::close ( )

inlinevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 77 of file JAccessibleStream.hh.

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

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.

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.

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/17]

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

inlineinherited

Read serialisable data object.

Parameters

object

serialisable data object

Returns

JReader

Definition at line 82 of file JSerialisable.hh.

    { 
      return object.read(*this); 
    }

operator>>() [2/17]

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

inlineinherited

Definition at line 88 of file JSerialisable.hh.

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

operator>>() [3/17]

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

inlineinherited

Definition at line 89 of file JSerialisable.hh.

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

operator>>() [4/17]

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

inlineinherited

Definition at line 90 of file JSerialisable.hh.

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

operator>>() [5/17]

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

inlineinherited

Definition at line 91 of file JSerialisable.hh.

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

operator>>() [6/17]

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

inlineinherited

Definition at line 92 of file JSerialisable.hh.

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

operator>>() [7/17]

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

inlineinherited

Definition at line 93 of file JSerialisable.hh.

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

operator>>() [8/17]

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

inlineinherited

Definition at line 94 of file JSerialisable.hh.

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

operator>>() [9/17]

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

inlineinherited

Definition at line 95 of file JSerialisable.hh.

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

operator>>() [10/17]

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

inlineinherited

Definition at line 96 of file JSerialisable.hh.

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

operator>>() [11/17]

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

inlineinherited

Definition at line 97 of file JSerialisable.hh.

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

operator>>() [12/17]

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

inlineinherited

Definition at line 98 of file JSerialisable.hh.

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

operator>>() [13/17]

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

inlineinherited

Definition at line 99 of file JSerialisable.hh.

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

operator>>() [14/17]

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

inlineinherited

Definition at line 100 of file JSerialisable.hh.

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

operator>>() [15/17]

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

inlineinherited

Definition at line 101 of file JSerialisable.hh.

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

operator>>() [16/17]

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

inlineinherited

Definition at line 102 of file JSerialisable.hh.

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

operator>>() [17/17]

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

inlineinherited

Definition at line 103 of file JSerialisable.hh.

{ return (*this) >> value.getStatus<JLANG::JStatus::status_type>(); }

load() [1/2]

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

inlineinherited

Read object.

Parameters

object

object

Returns

this reader

Definition at line 112 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 125 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());
    }

hasNext()

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()

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;
    }

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::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, and JLANG::JSTDObjectIterator< T >.

Definition at line 90 of file JObjectIterator.hh.

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

Member Data Documentation

preamble

template<class T >

JDAQPreamble JSUPPORT::JDAQFileReader< T, true >::preamble

mutableprivate

Definition at line 114 of file JDAQFileReader.hh.

buffer

template<class T >

std::vector<char> JSUPPORT::JDAQFileReader< T, true >::buffer

mutableprivate

Definition at line 115 of file JDAQFileReader.hh.

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:

• JDAQFileReader.hh