Auxiliary class to copy input data to corresponding TTree. More...

#include <JAutoTreeWriter.hh>

Inheritance diagram for JSUPPORT::JAutoTreeWriter< JKey_t >:

Classes
struct	JElement_t
	Auxiliary class for element insertion. More...

Public Types
typedef JAutoMap< JKey_t, JTreeCopyWriterInterface * >::map_type	map_type

typedef JAutoMap< JKey_t, JTreeCopyWriterInterface * >::value_type	value_type

typedef map_type::const_iterator	const_iterator

typedef map_type::iterator	iterator

typedef map_type::const_reverse_iterator	const_reverse_iterator

typedef map_type::reverse_iterator	reverse_iterator

typedef JPointer< JClass_t >	pointer_type

typedef JMemory_t< JClass_t >	memory_type

Public Member Functions
	JAutoTreeWriter ()
	Default constrtuctor. More...

template<class T >
	JAutoTreeWriter (JType< T > type)
	Constructor. More...

template<class T >
void	insert ()
	Insert (list of) data type(s). More...

virtual void	open (const char *file_name) override
	Open file. More...

virtual void	close () override
	Close file. More...

JNET::JTag	getKey (JLANG::JType< T > type)
	Get key for given DAQ data type. More...

int	getKey (JLANG::JType< T > type)
	Get key for given DAQ data type. More...

template<class T , class JElement_t >
void	insert (const JAutomate< JElement_t > &automate)
	Insert list of data types. 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...

virtual void	reset () override
	Reset pointer. More...

template<class T >
void	reset (const JPointer< T > &pointer)
	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
template<class T >
static JKey_t	getKey (JType< T > type)
	Get key. More...

template<class T >
static value_type	getAutoElement (JType< T > type)
	Creation of a map element for given data type. More...

static void	Throw (const bool option)
	Enable/disable throw option. More...

static int	Throw (const JException_t &error, const int value=-1)
	Throw exception or return error. More...

static void	release (JClass_t *p)
	Release memory. More...

Protected Member Functions
template<class T , class JElement_t >
void	insert (JType< T > type, const JAutomate< JElement_t > &automate)
	Insertion of single data type. More...

template<class JHead_t , class JTail_t , class JElement_t >
void	insert (JType< JTypeList< JHead_t, JTail_t > > typelist, const JAutomate< JElement_t > &automate)
	Recursive insertion of data types. More...

template<class JElement_t >
void	insert (JType< JNullType > type, const JAutomate< JElement_t > &automate)
	Template specialisation to terminate insertion of data types. More...

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

template<class JKey_t>
class JSUPPORT::JAutoTreeWriter< JKey_t >

Auxiliary class to copy input data to corresponding TTree.

This class derives from JROOT::JRootOutputFile. It re-implements the methods open and close of the underlying JLANG::JAccessible class so that each TTree is properly attached to and detached from the corresponding TDirectory, respectively.

Definition at line 33 of file JAutoTreeWriter.hh.

Member Typedef Documentation

◆ map_type

template<class JKey_t >

typedef JAutoMap<JKey_t, JTreeCopyWriterInterface*>::map_type JSUPPORT::JAutoTreeWriter< JKey_t >::map_type

Definition at line 39 of file JAutoTreeWriter.hh.

◆ value_type

template<class JKey_t >

typedef JAutoMap<JKey_t, JTreeCopyWriterInterface*>::value_type JSUPPORT::JAutoTreeWriter< JKey_t >::value_type

Definition at line 40 of file JAutoTreeWriter.hh.

◆ const_iterator

template<class JKey_t >

typedef map_type::const_iterator JSUPPORT::JAutoTreeWriter< JKey_t >::const_iterator

Definition at line 42 of file JAutoTreeWriter.hh.

◆ iterator

template<class JKey_t >

typedef map_type::iterator JSUPPORT::JAutoTreeWriter< JKey_t >::iterator

Definition at line 43 of file JAutoTreeWriter.hh.

◆ const_reverse_iterator

template<class JKey_t >

typedef map_type::const_reverse_iterator JSUPPORT::JAutoTreeWriter< JKey_t >::const_reverse_iterator

Definition at line 44 of file JAutoTreeWriter.hh.

◆ reverse_iterator

template<class JKey_t >

typedef map_type::reverse_iterator JSUPPORT::JAutoTreeWriter< JKey_t >::reverse_iterator

Definition at line 45 of file JAutoTreeWriter.hh.

◆ pointer_type

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.

◆ memory_type

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

◆ JAutoTreeWriter() [1/2]

template<class JKey_t >

JSUPPORT::JAutoTreeWriter< JKey_t >::JAutoTreeWriter ( )

inline

Default constrtuctor.

Definition at line 53 of file JAutoTreeWriter.hh.

54 {}

◆ JAutoTreeWriter() [2/2]

template<class JKey_t >

template<class T >

JSUPPORT::JAutoTreeWriter< JKey_t >::JAutoTreeWriter ( JType< T > type )

inline

Constructor.

Parameters

type data type

Definition at line 63 of file JAutoTreeWriter.hh.

     {
       this->template insert<T>();
     }

Member Function Documentation

◆ getKey() [1/3]

template<class JKey_t >

template<class T >

static JKey_t JSUPPORT::JAutoTreeWriter< JKey_t >::getKey ( JType< T > type )

static

Get key.

This method should be overloaded for the requested data types.

Parameters

type data type

Returns: key

◆ insert() [1/5]

template<class JKey_t >

template<class T >

void JSUPPORT::JAutoTreeWriter< JKey_t >::insert ( )

inline

Insert (list of) data type(s).

Definition at line 85 of file JAutoTreeWriter.hh.

     {
       insert<T>(JTOOLS::JAutomate<JElement_t>());
     }

◆ open()

template<class JKey_t >

virtual void JSUPPORT::JAutoTreeWriter< JKey_t >::open ( const char * file_name )

inlineoverridevirtual

Open file.

Parameters

file_name file name

Reimplemented from JROOT::JRootOutputFile.

Definition at line 96 of file JAutoTreeWriter.hh.

     {
       JRootOutputFile::open(file_name);
       
       if (is_open()) {
         for (iterator i = this->begin(); i != this->end(); ++i) {
           i->second->SetDirectory(getFile());
         }
       }
     }

◆ close()

template<class JKey_t >

virtual void JSUPPORT::JAutoTreeWriter< JKey_t >::close ( )

inlineoverridevirtual

Close file.

Reimplemented from JROOT::JRootOutputFile.

Definition at line 111 of file JAutoTreeWriter.hh.

     {
       // Write objects in memory.
  
       if (is_open()) {
         getFile()->Write();
       }
  
       // Detach TTree from TDirectory to avoid deletion of TTree.
  
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->second->SetDirectory(0);
       }
  
       // Close file.
       
       if (is_open()) {
         getFile()->Close();
       }
  
       reset();
  
       // Reset TTree for next run.
       
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->second->Reset();
       }
     }

◆ getKey() [2/3]

JNET::JTag JSUPPORT::JAutoTreeWriter< JNET::JTag >::getKey ( JLANG::JType< T > type )

Get key for given DAQ data type.

Parameters

type data type

Returns: map element

Definition at line 48 of file JDataWriter.cc.

   {
     return getTag<T>();
   }

◆ getKey() [3/3]

int JSUPPORT::JAutoTreeWriter< int >::getKey ( JLANG::JType< T > type )

Get key for given DAQ data type.

Parameters

type data type

Returns: map element

Definition at line 37 of file JRoot.cc.

   {
     return KM3NETDAQ::getDataType<T>();
   }

◆ getAutoElement()

template<class JKey_t , class JValue_t >

template<class T >

static value_type JTOOLS::JAutoMap< JKey_t, JValue_t >::getAutoElement ( JType< T > type )

staticinherited

Creation of a map element for given data type.

This method should be overloaded for the requested data types if the method insert() is used without argument.

Parameters

type data type

Returns: element

◆ insert() [2/5]

template<class JKey_t , class JValue_t >

template<class T , class JElement_t >

void JTOOLS::JAutoMap< JKey_t, JValue_t >::insert ( const JAutomate< JElement_t > & automate )

inlineinherited

Insert list of data types.

Parameters

automate type defined element

Definition at line 137 of file JAutoMap.hh.

     {
       insert(JType<T>(), automate);
     }

◆ insert() [3/5]

template<class JKey_t , class JValue_t >

template<class T , class JElement_t >

void JTOOLS::JAutoMap< JKey_t, JValue_t >::insert	(	JType< T >	type,
		const JAutomate< JElement_t > &	automate
	)

inlineprotectedinherited

Insertion of single data type.

Parameters

type	data type
automate	element automate by data type

Definition at line 150 of file JAutoMap.hh.

     {
       map_type::insert(automate.getElement(type));
     }

◆ insert() [4/5]

template<class JKey_t , class JValue_t >

template<class JHead_t , class JTail_t , class JElement_t >

void JTOOLS::JAutoMap< JKey_t, JValue_t >::insert	(	JType< JTypeList< JHead_t, JTail_t > >	typelist,
		const JAutomate< JElement_t > &	automate
	)

inlineprotectedinherited

Recursive insertion of data types.

Parameters

typelist	type list
automate	element automate by data type

Definition at line 164 of file JAutoMap.hh.

     {
       insert(JType<JHead_t>(), automate);
       insert(JType<JTail_t>(), automate);
     }

◆ insert() [5/5]

template<class JKey_t , class JValue_t >

template<class JElement_t >

void JTOOLS::JAutoMap< JKey_t, JValue_t >::insert	(	JType< JNullType >	type,
		const JAutomate< JElement_t > &	automate
	)

inlineprotectedinherited

Template specialisation to terminate insertion of data types.

Parameters

type	null type
automate	element automate by data type

Definition at line 179 of file JAutoMap.hh.

181 {}

◆ 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/5]

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/5]

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

virtual void JLANG::JPointer< JClass_t >::reset

inlineoverridevirtualinherited

Reset pointer.

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 84 of file JPointer.hh.

     { 
       this->__p = NULL;
     }

◆ reset() [3/5]

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

template<class T >

void JLANG::JPointer< JClass_t >::reset ( class T )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

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

◆ reset() [4/5]

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

◆ reset() [5/5]

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< JTypeList< JHead_t, JTail_t > >, JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JHead_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 >.

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:

JAutoTreeWriter.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

template<class JKey_t> class JSUPPORT::JAutoTreeWriter< JKey_t >

Member Typedef Documentation

◆ map_type

◆ value_type

◆ const_iterator

◆ iterator

◆ const_reverse_iterator

◆ reverse_iterator

◆ pointer_type

◆ memory_type

Constructor & Destructor Documentation

◆ JAutoTreeWriter() [1/2]

◆ JAutoTreeWriter() [2/2]

Member Function Documentation

◆ getKey() [1/3]

◆ insert() [1/5]

◆ open()

◆ close()

◆ getKey() [2/3]

◆ getKey() [3/3]

◆ getAutoElement()

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

◆ do_open()

◆ do_close()

◆ getFile()

◆ is_open()

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ reset() [1/5]

◆ reset() [2/5]

◆ reset() [3/5]

◆ reset() [4/5]

◆ reset() [5/5]

◆ 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

template<class JKey_t>
class JSUPPORT::JAutoTreeWriter< JKey_t >