ROOT file. More...

#include <JRootFile.hh>

Inheritance diagram for JROOT::JRootFile:

Public Types
typedef JPointer< JClass_t >	pointer_type

typedef JMemory_t< JClass_t >	memory_type

Public Member Functions
TFile *	getFile () const
	Get file.

virtual bool	is_open () const override
	Check is file is open.

virtual void	open (const char *file_name)=0
	Open device.

virtual void	close ()=0
	Close device.

virtual void	reset () override
	Reset pointer.

template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer.

void	reset (JClass_t *p)
	Reset pointer.

void	recreate ()
	Recreate object in memory.

void	create ()
	Create object in memory.

void	create (const unsigned int size)
	Create array of objects in memory.

virtual JClass_t *	get () const override
	Get pointer.

virtual void	set (JClass_t *p) override
	Set pointer.

template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer.

JClass_t *const &	getReference () const
	Get rereference to internal pointer.

JClass_t *&	getReference ()
	Get rereference to internal pointer.

virtual bool	equals (const JAbstractPointer &object) const
	Equals.

bool	is_valid () const
	Check validity of pointer.

JClass_t *	operator-> () const
	Smart pointer operator.

	operator JClass_t * () const
	Type conversion operator.

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 void	release (JClass_t *p)
	Release memory.

Protected Member Functions
	JRootFile ()
	Default constructor.

void	release ()
	Release memory.

Protected Attributes
JClass_t *	__p
	pointer to object

Static Protected Attributes
static bool	do_throw
	throw option

Private Member Functions
	JRootFile (const JRootFile &)

	JRootFile (JRootFile &&)

JRootFile &	operator= (const JRootFile &)

JRootFile &	operator= (JRootFile &&)

Detailed Description

ROOT file.

This class implements the method is_open() of the JLANG::JAccessible interface.

Definition at line 45 of file JRootFile.hh.

Member Typedef Documentation

◆ pointer_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JPointer<JClass_t> JLANG::JStorage< JClass_t, JMemory_t >::pointer_type

inherited

Definition at line 32 of file JStorage.hh.

◆ memory_type

template<class JClass_t , template< class > class JMemory_t = JNew>

JMemory_t<JClass_t> JLANG::JStorage< JClass_t, JMemory_t >::memory_type

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JRootFile() [1/3]

JROOT::JRootFile::JRootFile ( )

inlineprotected

Default constructor.

The printing of ROOT errors is suppressed.

Definition at line 54 of file JRootFile.hh.

    {
      gErrorIgnoreLevel = kError;
    }

◆ JRootFile() [2/3]

JROOT::JRootFile::JRootFile ( const JRootFile & )

private

◆ JRootFile() [3/3]

JROOT::JRootFile::JRootFile ( JRootFile && )

private

Member Function Documentation

◆ getFile()

TFile * JROOT::JRootFile::getFile ( ) const

inline

Get file.

Returns: pointer to file

Definition at line 66 of file JRootFile.hh.

    {
      return get();
    }

◆ is_open()

virtual bool JROOT::JRootFile::is_open ( ) const

inlineoverridevirtual

Check is file is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 77 of file JRootFile.hh.

    {
      return (getFile() != NULL && getFile()->IsOpen());
    }

◆ operator=() [1/2]

JRootFile & JROOT::JRootFile::operator= ( const JRootFile & )

private

◆ operator=() [2/2]

JRootFile & JROOT::JRootFile::operator= ( JRootFile && )

private

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

◆ reset() [1/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

virtual void JLANG::JStorage< JClass_t, JMemory_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

The allocated memory is released.

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 42 of file JStorage.hh.

    { 
      if (this->is_valid()) {
        this->release();
      }
 
      pointer_type::reset();
    }

◆ reset() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

template<class T >

void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

    {
      this->reset(pointer.get());
    }

◆ reset() [3/3]

template<class JClass_t >

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

    {
      if (this->get() != p) {
 
        this->reset();
 
        if (p != NULL) {
          this->set(p);
        }
      }
    }

◆ recreate()

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::recreate ( )

inlineinherited

Recreate object in memory.

A new object is created if no memory is allocated yet, else the previously created object is maintained.

Definition at line 57 of file JStorage.hh.

    {
      if (!this->is_valid()) {
        this->set(memory_type::create());
      }
    }

◆ create() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::create ( )

inlineinherited

Create object in memory.

The memory allocated by a previously created object will be released.

Definition at line 69 of file JStorage.hh.

    {
      this->reset(memory_type::create());
    }

◆ create() [2/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::create ( const unsigned int size )

inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters

size	number of elements

Definition at line 81 of file JStorage.hh.

    {
      this->reset(memory_type::create(size));
    }

◆ release() [1/2]

template<class JClass_t , template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::release ( )

inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

    { 
      memory_type::release(this->get());
    }

◆ release() [2/2]

template<class JClass_t >

static void JLANG::JNew< JClass_t >::release ( JClass_t * p )

inlinestaticinherited

Release memory.

Parameters

p	pointer to data

Definition at line 41 of file JMemory.hh.

    {
      delete p;
    }

◆ get()

template<class JClass_t >

virtual JClass_t * JLANG::JPointer< JClass_t >::get ( ) const

inlineoverridevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JTypeList< JDAQEvent, JNullType > >, JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, and JLANG::JMultiPointer< T >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__p;
    }

◆ set() [1/2]

template<class JClass_t >

virtual void JLANG::JPointer< JClass_t >::set ( JClass_t * p )

inlineoverridevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Definition at line 75 of file JPointer.hh.

    {
      this->__p = p;
    }

◆ set() [2/2]

template<class JClass_t >

template<class T >

void JLANG::JPointer< JClass_t >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

    {
      this->set(pointer.get());
    }

◆ getReference() [1/2]

template<class JClass_t >

JClass_t *const & JLANG::JPointer< JClass_t >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 119 of file JPointer.hh.

    {
      return __p;
    }

◆ getReference() [2/2]

template<class JClass_t >

JClass_t *& JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 130 of file JPointer.hh.

    {
      return __p;
    }

◆ equals()

template<class JClass_t >

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object abstract pointer

Returns: true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

    {
      return this->get() == object.get();
    }

◆ is_valid()

template<class JClass_t >

bool JLANG::JAbstractPointer< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns: true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

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

◆ operator->()

template<class JClass_t >

JClass_t * JLANG::JAbstractPointer< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 112 of file JAbstractPointer.hh.

    { 
      if (!is_valid())
        THROW(JNullPointerException, "JAbstractPointer::operator->()");
      else
        return this->get();
    }

◆ operator JClass_t *()

template<class JClass_t >

JLANG::JAbstractPointer< JClass_t >::operator JClass_t * ( ) const

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 126 of file JAbstractPointer.hh.

    {
      return this->get();
    }

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.

◆ __p

template<class JClass_t >

JClass_t* JLANG::JPointer< JClass_t >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

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

JRootFile.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ pointer_type

◆ memory_type

Constructor & Destructor Documentation

◆ JRootFile() [1/3]

◆ JRootFile() [2/3]

◆ JRootFile() [3/3]

Member Function Documentation

◆ getFile()

◆ is_open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ open()

◆ close()

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ recreate()

◆ create() [1/2]

◆ create() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ get()

◆ set() [1/2]

◆ set() [2/2]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Member Data Documentation

◆ do_throw

◆ __p