JROOT::JRootFileWriter< T > Class Template Reference

ROOT file object output. More...

#include <JRootFileWriter.hh>

Inheritance diagram for JROOT::JRootFileWriter< T >:

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

Public Member Functions
	JRootFileWriter ()
	Default constructor.
	JRootFileWriter (const char *file_name)
	Constructor.
virtual void	open (const char *file_name) override
	Open file.
virtual void	close () override
	Close file.
TFile *	getFile () const
	Get file.
virtual bool	is_open () const override
	Check is file is open.
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.
virtual bool	put (const T &object)=0
	Object output.

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

Protected Attributes
JClass_t *	__p
	pointer to object

Static Protected Attributes
static bool	do_throw
	throw option

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

Detailed Description

template<class T>
class JROOT::JRootFileWriter< T >

ROOT file object output.

This class implements the JLANG::JAccessibleObjectOutput interface.

Definition at line 207 of file JRootFileWriter.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

JRootFileWriter() [1/2]

template<class T >

JROOT::JRootFileWriter< T >::JRootFileWriter ( )

inline

Default constructor.

Definition at line 216 of file JRootFileWriter.hh.

                      :
      JRootFileObjectOutput  <T>(),
      JAccessibleObjectOutput<T>()
    {}

JRootFileWriter() [2/2]

template<class T >

JROOT::JRootFileWriter< T >::JRootFileWriter ( const char * file_name )

inline

Constructor.

Parameters

file_name

file name

Definition at line 227 of file JRootFileWriter.hh.

                                           :
      JRootFileObjectOutput  <T>(),
      JAccessibleObjectOutput<T>()
    {
      open(file_name);
    }

Member Function Documentation

open()

template<class T >

virtual void JROOT::JRootFileWriter< T >::open ( const char * file_name )

inlineoverridevirtual

Open file.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Definition at line 240 of file JRootFileWriter.hh.

    {
      JRootOutputFile::open(file_name);
 
      if (is_open()) {
        this->SetDirectory(getFile());
      }
    }

close()

virtual void JROOT::JRootOutputFile::close ( )

inlineoverridevirtualinherited

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

do_open()

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

inlineprivateinherited

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

do_close()

void JROOT::JRootOutputFile::do_close ( )

inlineprivateinherited

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

getFile()

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

inlineinherited

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

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

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

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

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

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

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

put()

template<class T >

virtual bool JLANG::JObjectOutput< T >::put ( const T & object )

pure virtualinherited

Object output.

Parameters

object

object

Returns

true if OK; else false

Implemented in JIO::JWriterObjectOutput< T >, JLANG::JAbstractObjectWriter< T >, JLANG::JAbstractObjectWriter< JHead_t >, JLANG::JAbstractObjectWriter< JTail_t >, JLANG::JNullOutput< T >, JLANG::JNullOutput< JHead_t >, JLANG::JNullOutput< JTail_t >, JLANG::JObjectDemultiplexer< JBase_t, JDerived_t >, JLANG::JObjectDemultiplexer< JBase_t, JHead_t >, JLANG::JObjectDemultiplexer< JBase_t, JTail_t >, JLANG::JObjectDemultiplexer< JBase_t, JTypeList< JHead_t, JTail_t > >, JLANG::JStreamObjectOutput< T >, JLANG::JStreamObjectOutput< Evt >, JLANG::JStreamObjectOutput< Head >, JLANG::JStreamObjectOutput< JHead_t >, JLANG::JStreamObjectOutput< JTail_t >, JNET::JControlHostObjectOutput< T >, JNET::JControlHostObjectOutput< JHead_t >, JNET::JControlHostObjectOutput< JTail_t >, JROOT::JRootObjectOutput< T, false >, JROOT::JRootStreamObjectOutput< T >, JROOT::JSonObjectOutput< T >, and JROOT::JTreeWriterObjectOutput< T >.

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:

• JRootFileWriter.hh