JLANG::JAccessibleAbstractObjectIterator< T > Class Template Reference

Abstract object iterator with named access. More...

#include <JAbstractObjectIterator.hh>

Inheritance diagram for JLANG::JAccessibleAbstractObjectIterator< T >:

Public Types
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
virtual bool	setObject (T &object)=0
	Set 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.
virtual bool	is_open () const =0
	Check is device is open.
virtual void	open (const char *file_name)=0
	Open device.
virtual void	close ()=0
	Close device.

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
T	object
	object
bool	has_next
	status

Static Protected Attributes
static bool	do_throw
	throw option

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
class JLANG::JAccessibleAbstractObjectIterator< T >

Abstract object iterator with named access.

Definition at line 102 of file JAbstractObjectIterator.hh.

Member Typedef Documentation

pointer_type

template<class T >

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

inherited

Definition at line 39 of file JAbstractObjectIterator.hh.

Member Function Documentation

setObject()

template<class T >

virtual bool JLANG::JAbstractObjectIterator< T >::setObject ( T & object )

pure virtualinherited

Set object.

Parameters

object

reference to object to be set

Returns

true if set; else false

Implemented in JDATABASE::JDatabaseObjectIterator< T >, JIO::JReaderObjectIterator< T >, JLANG::JStreamObjectIterator< T >, JNET::JControlHostObjectIterator< T >, JNET::JLigierObjectIterator< T >, and JSUPPORT::JDAQFileReader< T, true >.

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< Evt >, JLANG::JAbstractObjectReader< JDAQSummaryslice >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JPipe< T >, JLANG::JPipe< JHead_t >, JLANG::JPipe< JTail_t >, JLANG::JSTDObjectIterator< T >, JROOT::JRootFileReader< T, false >, JROOT::JTreeReaderObjectIterator< T >, JSUPPORT::JMultipleFileScanner< T >, JSUPPORT::JMultipleFileScanner< Evt >, JSUPPORT::JMultipleFileScanner< JDAQSummaryslice >, JSUPPORT::JMultipleFileScanner< JHead_t >, JSUPPORT::JMultipleFileScanner< JTail_t >, JSUPPORT::JMultipleFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >, JSUPPORT::JMultipleFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JMultipleFileScanner<>, JSUPPORT::JSingleFileScanner< T >, JSUPPORT::JSingleFileScanner< JHead_t >, JSUPPORT::JSingleFileScanner< JTail_t >, JSUPPORT::JSingleFileScanner< JTypeList< JHead_t, JTail_t > >, and JSUPPORT::JSingleFileScanner<>.

Definition at line 90 of file JObjectIterator.hh.

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

is_open()

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

pure virtualinherited

Check is device is open.

Returns

true if open; else false

Implemented in JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< Evt >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JLANG::JNullAccess, JROOT::JRootFile, and JROOT::JTreeReaderAccessibleObjectIterator< T >.

open()

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

pure virtualinherited

Open device.

Parameters

file_name

file name

Implemented in JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< Evt >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JAccessibleBinaryInputStream, JLANG::JAccessibleBinaryOutputStream, JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JLANG::JNullAccess, JROOT::JRootFileReader< T, false >, JROOT::JRootFileReader< T, true >, JROOT::JRootFileWriter< T >, JROOT::JRootInputFile, JROOT::JRootOutputFile, JROOT::JTreeReaderAccessibleObjectIterator< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JFileRecorder< T >, JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< Evt >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

close()

virtual void JLANG::JAccessible::close ( )

pure virtualinherited

Close device.

Implemented in JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< Evt >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< JTypeList< JDAQEvent, JNullType > >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JLANG::JNullAccess, JROOT::JRootInputFile, JROOT::JRootOutputFile, JROOT::JTreeReaderAccessibleObjectIterator< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< Evt >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< JTypeList< JDAQEvent, JNullType > >, JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

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

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.

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 class was generated from the following file:

• JAbstractObjectIterator.hh