JLANG::JASCIIFileReader< T > Class Template Reference

Object reading from ASCII file. More...

#include <JASCIIFileReader.hh>

Inheritance diagram for JLANG::JASCIIFileReader< T >:

Public Types
typedef JObjectIterator< T > ::pointer_type	pointer_type

Public Member Functions
	JASCIIFileReader ()
	Default constructor. More...
	JASCIIFileReader (const char *file_name)
	Constructor. More...
virtual bool	is_open () const
	Check is file is open. More...
virtual void	open (const char *file_name)
	Open file. More...
virtual void	close ()
	Close file. 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...
virtual skip_type	skip (const skip_type ns)
	Skip items. More...

Static Public Member Functions
static void	Throw (const bool option)
	Enable/disable throw option. More...
static int	Throw (const JException &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...

Detailed Description

template<class T>
class JLANG::JASCIIFileReader< T >

Object reading from ASCII file.

This class implements the JAccessibleObjectIterator interface.

Definition at line 26 of file JASCIIFileReader.hh.

Member Typedef Documentation

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

template<class T >

JLANG::JASCIIFileReader< T >::JASCIIFileReader ( )

inline

Default constructor.

Definition at line 35 of file JASCIIFileReader.hh.

                       :
      JAccessibleInputStream(),
      JStreamObjectIterator<T>(static_cast<std::istream&>(*this))
    {}

template<class T >

JLANG::JASCIIFileReader< T >::JASCIIFileReader ( const char *  file_name )

inline

Constructor.

Parameters

file_name

file name

Definition at line 46 of file JASCIIFileReader.hh.

                                            :
      JAccessibleInputStream(file_name),
      JStreamObjectIterator<T>(static_cast<std::istream&>(*this))
    {}

Member Function Documentation

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

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

inlinevirtualinherited

Open file.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Reimplemented in JLANG::JAccessibleBinaryInputStream.

Definition at line 64 of file JAccessibleStream.hh.

    {
      std::ifstream::open(file_name);

      if (!this->is_open()) {
        Throw(JFileOpenException(std::string("Error opening file ") + file_name));
      }
    }

virtual void JLANG::JAccessibleInputStream::close ( )

inlinevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 77 of file JAccessibleStream.hh.

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

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

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

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns

return code

Definition at line 50 of file JThrow.hh.

    {
      using namespace std;
      
      if (do_throw) {
        throw error;
      }

      cerr << error.what() << endl;
      
      return value;
    }

template<class T >

virtual bool JLANG::JStreamObjectIterator< 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 >.

Definition at line 45 of file JStreamObjectIterator.hh.

    {
      return (bool) (__in && __in >> object);
    }

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

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

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

Definition at line 90 of file JObjectIterator.hh.

    {
      skip_type i = 0;

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

      return i;
    }

Member Data Documentation

bool JLANG::JThrow< JAccessible >::do_throw

staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

template<class T >

std::istream& JLANG::JStreamObjectIterator< T >::__in

protectedinherited

Definition at line 51 of file JStreamObjectIterator.hh.

template<class T>

T JLANG::JAbstractObjectIterator< T >::object

protectedinherited

object

Definition at line 34 of file JAbstractObjectIterator.hh.

template<class T>

bool JLANG::JAbstractObjectIterator< T >::has_next

protectedinherited

status

Definition at line 35 of file JAbstractObjectIterator.hh.

---

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

• JASCIIFileReader.hh