JLANG::JAccessibleObjectReader< T > Struct Template Reference

Auxiliary class for object reading with named access. More...

#include <JObjectReader.hh>

Inheritance diagram for JLANG::JAccessibleObjectReader< T >:

Public Types
typedef std::shared_ptr< JAccessibleObjectIterator< T > >	helper_type
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JAccessibleObjectReader ()
	Default constructor.
virtual JAccessibleObjectIterator< T > *	getHelper () const override
	Get helper.
virtual bool	is_open () const override
	Check is device is open.
virtual void	open (const char *file_name) override
	Open device.
virtual void	close () override
	Close device.
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) override
	Skip items.
bool	is_valid () const
	Check validity of helper.

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.

Static Protected Attributes
static bool	do_throw
	throw option

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
struct JLANG::JAccessibleObjectReader< T >

Auxiliary class for object reading with named access.

This class implements the JAbstractAccessibleObjectReader interface.

Definition at line 92 of file JObjectReader.hh.

Member Typedef Documentation

helper_type

template<class T >

std::shared_ptr< JAccessibleObjectIterator<T> > JLANG::JAccessibleObjectReader< T >::helper_type

Definition at line 98 of file JObjectReader.hh.

pointer_type

template<class T >

JObjectIterator<T>::pointer_type JLANG::JAccessibleObjectReader< T >::pointer_type

Definition at line 99 of file JObjectReader.hh.

Constructor & Destructor Documentation

JAccessibleObjectReader()

template<class T >

JLANG::JAccessibleObjectReader< T >::JAccessibleObjectReader ( )

inline

Default constructor.

Definition at line 104 of file JObjectReader.hh.

    {}

Member Function Documentation

getHelper()

template<class T >

virtual JAccessibleObjectIterator< T > * JLANG::JAccessibleObjectReader< T >::getHelper ( ) const

inlineoverridevirtual

Get helper.

Returns

helper

Implements JLANG::JAbstractAccessibleObjectReader< T >.

Definition at line 113 of file JObjectReader.hh.

    {
      return this->get();
    }

is_open()

template<class T >

virtual bool JLANG::JAbstractAccessibleObjectReader< T >::is_open ( ) const

inlineoverridevirtualinherited

Check is device is open.

Returns

true if open; else false

Implements JLANG::JAccessible.

Definition at line 148 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        return this->getHelper()->is_open();
      else
        return false;
    }

open()

template<class T >

virtual void JLANG::JAbstractAccessibleObjectReader< T >::open ( const char * file_name )

inlineoverridevirtualinherited

Open device.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Reimplemented in JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< JTypeList< JDAQEvent, JNullType > >, and JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >.

Definition at line 162 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid()) {
        this->getHelper()->open(file_name);
      }
    }

close()

template<class T >

virtual void JLANG::JAbstractAccessibleObjectReader< T >::close ( )

inlineoverridevirtualinherited

Close device.

Implements JLANG::JAccessible.

Reimplemented in JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< JTypeList< JDAQEvent, JNullType > >, and JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >.

Definition at line 173 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid()) {
        this->getHelper()->close();
      }
    }

hasNext()

template<class T >

virtual bool JLANG::JAbstractObjectReader< 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 54 of file JAbstractObjectReader.hh.

    {
      return (this->is_valid() && this->getHelper()->hasNext());
    }

next()

template<class T >

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

inlineoverridevirtualinherited

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 65 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        return this->getHelper()->next();
      else
        return ps;
    }

skip()

template<class T >

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

inlineoverridevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns

number of items skipped

Reimplemented from JLANG::JObjectIterator< T >.

Definition at line 80 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        return this->getHelper()->skip(ns);
      else
        return 0;
    } 

is_valid()

template<class T >

bool JLANG::JAbstractObjectReader< T >::is_valid ( ) const

inlineinherited

Check validity of helper.

Returns

true if helper not null; else false

Definition at line 35 of file JAbstractObjectReader.hh.

    { 
      return this->getHelper() != NULL; 
    }

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

Member Data Documentation

ps

template<class T >

pointer_type JLANG::JAbstractObjectReader< T >::ps

privateinherited

Definition at line 89 of file JAbstractObjectReader.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.

---

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

• JObjectReader.hh