Auxiliary class for template TTree reading. More...

#include <JTreeReader.hh>

Inheritance diagram for JROOT::JTreeReader< T >:

Public Member Functions
	JTreeReader (const JTreeParameters &parameters=JROOT::getTreeParameters< T >())
	Constructor. More...

virtual bool	load (TFile *file) override
	Load TTree from given file. More...

virtual const TDictionary *	getDictionary () override
	Get ROOT dictionary. 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...

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

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

const JTreeParameters &	getTreeParameters () const
	Get TTree parameters. More...

const TString &	getTreeName () const
	Get TTree name. More...

const TString &	getTreeTitle () const
	Get TTree title. More...

const TString &	getBranchName () const
	Get TBranch name. More...

int	getCompressionLevel () const
	Get compression level. More...

int	getBasketSize () const
	Get basket size. More...

int	getSplitLevel () const
	Get split level. More...

void	release ()
	Release memory. More...

T *	getAddress () const
	Get address. More...

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

TString	treeName
	TTree name. More...

TString	treeTitle
	TTree title. More...

TString	branchName
	TBranch name. More...

int	compressionLevel
	TBranch compression level. More...

int	basketSize
	TBranch basket size. More...

int	splitLevel
	TBranch split level. More...

T *	address

Detailed Description

template<class T>
class JROOT::JTreeReader< T >

Auxiliary class for template TTree reading.

Definition at line 57 of file JTreeReader.hh.

Constructor & Destructor Documentation

template<class T >

JROOT::JTreeReader< T >::JTreeReader ( const JTreeParameters & parameters = JROOT::getTreeParameters<T>() )

inline

Constructor.

Note that the default TTree parameters are obtained using method JROOT::getTreeParameters.

Parameters

parameters parameters of TTree

Definition at line 70 of file JTreeReader.hh.

                                                                                  :
       JTreeParameters(parameters)
     {}

Member Function Documentation

template<class T >

virtual bool JROOT::JTreeReader< T >::load ( TFile * file )

inlineoverridevirtual

Load TTree from given file.

This methods releases the pending memory allocated from previous data reading.

Parameters

file	pointer to file

Returns: true when TTree correctly loaded; else false

Implements JROOT::JAbstractTreeReader.

Definition at line 83 of file JTreeReader.hh.

     {
       this->release();
 
       if (file != NULL) {
 
         this->set(dynamic_cast<TTree*>(file->Get(this->getTreeName())));
       
         if (this->is_valid()) {
 
           this->get()->SetBranchAddress(this->getBranchName(), &this->address);
 
           return true;
         }
       }
 
       return false;
     }

template<class T >

virtual const TDictionary* JROOT::JTreeReader< T >::getDictionary ( )

inlineoverridevirtual

Get ROOT dictionary.

Returns: dictionary.

Implements JROOT::JAbstractTreeReader.

Definition at line 108 of file JTreeReader.hh.

     {
       return TDictionary::GetDictionary(T::Class_Name());
     }

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

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>

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

inlineoverridevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< JClass_t >.

Definition at line 84 of file JPointer.hh.

     { 
       this->__p = NULL;
     }

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>

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

const JTreeParameters& JROOT::JTreeParameters::getTreeParameters ( ) const

inlineinherited

Get TTree parameters.

Returns: TTree parameters

Definition at line 63 of file JTreeParameters.hh.

     {
       return static_cast<const JTreeParameters&>(*this);
     }

const TString& JROOT::JTreeParameters::getTreeName ( ) const

inlineinherited

Get TTree name.

Returns: TTree name

Definition at line 74 of file JTreeParameters.hh.

     {
       return treeName;
     }

const TString& JROOT::JTreeParameters::getTreeTitle ( ) const

inlineinherited

Get TTree title.

Returns: TTree title

Definition at line 85 of file JTreeParameters.hh.

     {
       return treeTitle;
     }

const TString& JROOT::JTreeParameters::getBranchName ( ) const

inlineinherited

Get TBranch name.

Returns: TBranch name

Definition at line 96 of file JTreeParameters.hh.

     {
       return (branchName != "" ? branchName : treeName);
     }

int JROOT::JTreeParameters::getCompressionLevel ( ) const

inlineinherited

Get compression level.

Returns: compression level

Definition at line 107 of file JTreeParameters.hh.

     {
       return compressionLevel;
     }

int JROOT::JTreeParameters::getBasketSize ( ) const

inlineinherited

Get basket size.

Returns: basket size

Definition at line 118 of file JTreeParameters.hh.

     {
       return basketSize;
     }

int JROOT::JTreeParameters::getSplitLevel ( ) const

inlineinherited

Get split level.

Returns: split level

Definition at line 129 of file JTreeParameters.hh.

     {
       return splitLevel;
     }

template<class T>

void JROOT::JRootAddress< T >::release ( )

inlineinherited

Release memory.

Definition at line 42 of file JRootAddress.hh.

     {
       if (address != NULL) {
 
         delete address;
 
         address = NULL;
       }
     }

template<class T>

T* JROOT::JRootAddress< T >::getAddress ( ) const

inlineinherited

Get address.

Returns: address

Definition at line 58 of file JRootAddress.hh.

     {
       return address;
     }

Member Data Documentation

template<class JClass_t>

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

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

TString JROOT::JTreeParameters::treeName

protectedinherited

TTree name.

Definition at line 155 of file JTreeParameters.hh.

TString JROOT::JTreeParameters::treeTitle

protectedinherited

TTree title.

Definition at line 156 of file JTreeParameters.hh.

TString JROOT::JTreeParameters::branchName

protectedinherited

TBranch name.

Definition at line 157 of file JTreeParameters.hh.

int JROOT::JTreeParameters::compressionLevel

protectedinherited

TBranch compression level.

Definition at line 158 of file JTreeParameters.hh.

int JROOT::JTreeParameters::basketSize

protectedinherited

TBranch basket size.

Definition at line 159 of file JTreeParameters.hh.

int JROOT::JTreeParameters::splitLevel

protectedinherited

TBranch split level.

Definition at line 160 of file JTreeParameters.hh.

template<class T>

T* JROOT::JRootAddress< T >::address

protectedinherited

Definition at line 64 of file JRootAddress.hh.

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

JTreeReader.hh

Public Member Functions

Protected Attributes

Detailed Description

template<class T> class JROOT::JTreeReader< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class JROOT::JTreeReader< T >