JROOT::JRootOutputFile Class Reference

ROOT output file. More...

#include <JRootFile.hh>

Inheritance diagram for JROOT::JRootOutputFile:

Public Types
typedef JPointer< JClass_t >	pointer_type
typedef JMemory_t< JClass_t >	memory_type

Public Member Functions
	JRootOutputFile ()
	Default constructor. More...
	JRootOutputFile (const char *file_name)
	Constructor. More...
	~JRootOutputFile ()
	Destructor. More...
virtual void	open (const char *file_name) override
	Open file. More...
virtual void	close () override
	Close file. More...
TFile *	getFile () const
	Get file. More...
virtual bool	is_open () const override
	Check is file is open. More...
virtual void	reset () override
	Reset pointer. More...
template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer. More...
void	reset (JClass_t *p)
	Reset pointer. More...
void	recreate ()
	Recreate object in memory. More...
void	create ()
	Create object in memory. More...
void	create (const unsigned int size)
	Create array of objects in memory. More...
virtual JClass_t *	get () const override
	Get pointer. More...
virtual void	set (JClass_t *p) override
	Set pointer. More...
template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer. More...
JClass_t *const &	getReference () const
	Get rereference to internal pointer. More...
JClass_t *&	getReference ()
	Get rereference to internal pointer. More...
virtual bool	equals (const JAbstractPointer &object) const
	Equals. More...
bool	is_valid () const
	Check validity of pointer. More...
JClass_t *	operator-> () const
	Smart pointer operator. More...
	operator JClass_t * () const
	Type conversion operator. 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 Member Functions
void	release ()
	Release memory. More...

Protected Attributes
JClass_t *	__p
	pointer to object More...

Static Protected Attributes
static bool	do_throw
	throw option More...

Private Member Functions
void	do_open (const char *file_name)
	Open file. More...
void	do_close ()
	Close file. More...

Detailed Description

ROOT output file.

This class implements the methods open() and close() of the JLANG::JAccessible interface.

Definition at line 196 of file JRootFile.hh.

Member Typedef Documentation

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

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

inherited

Definition at line 32 of file JStorage.hh.

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

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

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

JROOT::JRootOutputFile::JRootOutputFile ( )

inline

Default constructor.

Definition at line 203 of file JRootFile.hh.

                      :
      JRootFile()
    {}

JROOT::JRootOutputFile::JRootOutputFile ( const char *  file_name )

inline

Constructor.

Parameters

file_name

file name

Definition at line 213 of file JRootFile.hh.

                                           :
      JRootFile()
    {
      do_open(file_name);
    }

JROOT::JRootOutputFile::~JRootOutputFile ( )

inline

Destructor.

The destructor writes and closes the file if it is still open.

Definition at line 225 of file JRootFile.hh.

    {
      do_close();
    }

Member Function Documentation

virtual void JROOT::JRootOutputFile::open ( const char *  file_name )

inlineoverridevirtual

Open file.

The file is not opened when a file exists with the given name.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Reimplemented in JROOT::JRootFileWriter< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

Definition at line 237 of file JRootFile.hh.

    {
      do_open(file_name);
    }

virtual void JROOT::JRootOutputFile::close ( )

inlineoverridevirtual

Close file.

This method calls the TFile::Write method before closing the file.

Implements JLANG::JAccessible.

Reimplemented in JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

Definition at line 247 of file JRootFile.hh.

    {
      do_close();
    }

void JROOT::JRootOutputFile::do_open ( const char *  file_name )

inlineprivate

Open file.

The file is not opened when a file exists with the given name.

Parameters

file_name

file name

Definition at line 260 of file JRootFile.hh.

    {
      set(TFile::Open(file_name, "CREATE"));

      if (!is_open()) {
        Throw(MAKE_EXCEPTION(JFileOpenException, "Error opening file " << file_name));
      }
    }

void JROOT::JRootOutputFile::do_close ( )

inlineprivate

Close file.

This method calls the TFile::Write method before closing the file.

Definition at line 274 of file JRootFile.hh.

    {
      if (getFile() != NULL && getFile()->IsOpen()) {
        getFile()->Write();
        getFile()->Close();
      }

      reset();
    }

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

inlineinherited

Get file.

Returns

pointer to file

Definition at line 66 of file JRootFile.hh.

    {
      return get();
    }

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

inlineoverridevirtualinherited

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

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

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< const TFormula >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JEvtWeight >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JAccessibleObjectIterator< JNullType > >, JLANG::JSharedPointer< match_type >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JDiffuseFlux >, JLANG::JSharedPointer< JEvtWeightFactor_t >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JExceptionHandler >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JOscProb >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JTRIGGER::JMatch >, JLANG::JSharedPointer< JRewindableObjectIterator< const T > >, JLANG::JSharedPointer< JEvtWeightFactor >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, and JLANG::JSharedPointer< JRadiation >.

Definition at line 42 of file JStorage.hh.

    { 
      if (this->is_valid()) {
        this->release();
      }

      pointer_type::reset();
    }

template<class JClass_t>

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

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

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

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

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

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

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< JTypeList< JHead_t, JTail_t > >, JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< T >, and JLANG::JMultiPointer< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__p;
    }

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

Reimplemented in JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JAccessibleObjectIterator< KM3NETDAQ::KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< const TFormula >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JEvtWeight >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JAccessibleObjectIterator< JNullType > >, JLANG::JSharedPointer< match_type >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JDiffuseFlux >, JLANG::JSharedPointer< JEvtWeightFactor_t >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JExceptionHandler >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JOscProb >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JTRIGGER::JMatch >, JLANG::JSharedPointer< JRewindableObjectIterator< const T > >, JLANG::JSharedPointer< JEvtWeightFactor >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, and JLANG::JSharedPointer< JRadiation >.

Definition at line 75 of file JPointer.hh.

    {
      this->__p = p;
    }

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

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

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

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

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

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

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

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