Abstract interface for object reading with named access. More...

#include <JAbstractObjectReader.hh>

Inheritance diagram for JLANG::JAbstractAccessibleObjectReader< T >:

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

typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
virtual JAccessibleObjectIterator< T > *	getHelper () const override=0
	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 ()=0
	Check availability of next element.

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

virtual skip_type	skip (const skip_type ns)
	Skip items.

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.

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::JAbstractAccessibleObjectReader< T >

Abstract interface for object reading with named access.

This class implements the JAccessibleObjectIterator interface by transferring the interface methods to a helper object via a single interface method getHelper().

Definition at line 120 of file JAbstractObjectReader.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::JAbstractObjectReader< T >::pointer_type

inherited

Definition at line 27 of file JAbstractObjectReader.hh.

Member Function Documentation

◆ getHelper()

template<class T >

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

overridepure virtual

Get helper.

Returns: pointer to helper

Implements JLANG::JAbstractObjectReader< T >.

Implemented in JLANG::JAccessibleObjectReader< T >, JLANG::JAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAccessibleObjectReader< JHead_t >, JLANG::JAccessibleObjectReader< JTail_t >, and JLANG::JAccessibleObjectReader< KM3NETDAQ::JDAQEvent >.

◆ is_open()

template<class T >

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

inlineoverridevirtual

Check is device is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 137 of file JAbstractObjectReader.hh.

    {
      if (this->getHelper() != NULL)
        return this->getHelper()->is_open();
      else
        return false;
    }

◆ open()

template<class T >

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

inlineoverridevirtual

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 >, and JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >.

Definition at line 151 of file JAbstractObjectReader.hh.

    {
      if (this->getHelper() != NULL) {
        this->getHelper()->open(file_name);
      }
    }

◆ close()

template<class T >

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

inlineoverridevirtual

Close device.

Implements JLANG::JAccessible.

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

Definition at line 162 of file JAbstractObjectReader.hh.

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

◆ 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

◆ next() [1/2]

template<class T >

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

pure virtualinherited

Get next element.

Returns: pointer to element

◆ skip() [1/2]

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

◆ 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.

◆ hasNext() [2/2]

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 43 of file JAbstractObjectReader.hh.

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

◆ next() [2/2]

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 54 of file JAbstractObjectReader.hh.

    {
      if (this->getHelper() != NULL)
        return this->getHelper()->next();
      else
        return ps;
    }

◆ skip() [2/2]

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 69 of file JAbstractObjectReader.hh.

    {
      if (this->getHelper() != NULL)
        return this->getHelper()->skip(ns);
      else
        return 0;
    } 

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.

◆ ps

template<class T >

pointer_type JLANG::JAbstractObjectReader< T >::ps

privateinherited

Definition at line 78 of file JAbstractObjectReader.hh.

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

JAbstractObjectReader.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ pointer_type [1/2]

◆ pointer_type [2/2]

Member Function Documentation

◆ getHelper()

◆ is_open()

◆ open()

◆ close()

◆ hasNext() [1/2]

◆ next() [1/2]

◆ skip() [1/2]

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ hasNext() [2/2]

◆ next() [2/2]

◆ skip() [2/2]

Member Data Documentation

◆ do_throw

◆ ps