JTemplateTreeReader object iterator. More...

#include <JTreeReaderObjectIterator.hh>

Inheritance diagram for JROOT::JTreeReaderAccessibleObjectIterator< T >:

Public Types
typedef JRewindableObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JTreeReaderAccessibleObjectIterator ()
	Default constructor.

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

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

virtual void	close () override
	Close file.

virtual void	rewind () override
	Rewind.

virtual bool	hasNext () override
	Check availability of next element.

virtual const pointer_type &	next () override
	Get next element.

virtual skip_type	skip (const skip_type ns) override
	Skip items.

counter_type	getCounter () const
	Get internal counter.

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

virtual const TDictionary *	getDictionary () override
	Get ROOT dictionary.

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.

virtual void	reset () override
	Reset pointer.

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

void	reset (JClass_t *p)
	Reset 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.

const JTreeParameters &	getTreeParameters () const
	Get TTree parameters.

const TString &	getTreeName () const
	Get TTree name.

const TString &	getTreeTitle () const
	Get TTree title.

const TString &	getBranchName () const
	Get TBranch name.

int	getCompressionLevel () const
	Get compression level.

void	setCompressionLevel (const int value)
	Set compression level.

int	getBasketSize () const
	Get basket size.

void	setBasketSize (int value)
	Set basket size.

int	getSplitLevel () const
	Get split level.

void	setSplitLevel (int value)
	Set split level.

Long64_t	getAutoFlush () const
	Get auto flush.

void	setAutoFlush (Long64_t value)
	Set auto flush.

void	setBranchAddress (TTree &tree)

void	release ()
	Release memory.

T *	getAddress () const
	Get address.

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.

Protected Attributes
counter_type	counter

JClass_t *	__p
	pointer to object

TString	treeName
	TTree name.

TString	treeTitle
	TTree title.

TString	branchName
	TBranch name.

int	compressionLevel
	TBranch compression level.

int	basketSize
	TBranch basket size.

int	splitLevel
	TBranch split level.

Long64_t	autoFlush
	TTree auto flush.

T *	address

Static Protected Attributes
static bool	do_throw
	throw option

Detailed Description

template<class T>
class JROOT::JTreeReaderAccessibleObjectIterator< T >

JTemplateTreeReader object iterator.

This class extends the JTreeReaderObjectIterator class and implements the JLANG::JAccessibleObjectIterator interface.

Definition at line 138 of file JTreeReaderObjectIterator.hh.

Member Typedef Documentation

◆ pointer_type

template<class T >

JRewindableObjectIterator<T>::pointer_type JROOT::JTreeReaderObjectIterator< T >::pointer_type

inherited

Definition at line 39 of file JTreeReaderObjectIterator.hh.

Constructor & Destructor Documentation

◆ JTreeReaderAccessibleObjectIterator()

template<class T >

JROOT::JTreeReaderAccessibleObjectIterator< T >::JTreeReaderAccessibleObjectIterator ( )

inline

Default constructor.

Definition at line 146 of file JTreeReaderObjectIterator.hh.

147 {}

Member Function Documentation

◆ is_open()

template<class T >

virtual bool JROOT::JTreeReaderAccessibleObjectIterator< T >::is_open ( ) const

inlineoverridevirtual

Check is file is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 155 of file JTreeReaderObjectIterator.hh.

    {
      if (this->is_valid()) {
 
        const TFile* file = this->get()->GetCurrentFile();
 
        return (file != NULL && file->IsOpen());
      }
 
      return false;
    }

◆ open()

template<class T >

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

inlineoverridevirtual

Open file.

Parameters

file_name file name

Implements JLANG::JAccessible.

Reimplemented in JROOT::JRootFileReader< T, true >.

Definition at line 173 of file JTreeReaderObjectIterator.hh.

    {
      TFile* file = TFile::Open(file_name);
 
      if (file != NULL) {
 
        if (!this->load(file)) {
 
          file->Close();
 
          delete file;
        }
      }
 
      this->rewind();
    }

◆ close()

template<class T >

virtual void JROOT::JTreeReaderAccessibleObjectIterator< T >::close ( )

inlineoverridevirtual

Close file.

Implements JLANG::JAccessible.

Definition at line 194 of file JTreeReaderObjectIterator.hh.

    {
      if (this->is_valid()) {
 
        TFile* file = this->get()->GetCurrentFile();
 
        if (file != NULL) {
 
          file->Close();
 
          delete file;
        }
      }
 
      this->reset();
    }

◆ rewind()

template<class T >

virtual void JROOT::JTreeReaderObjectIterator< T >::rewind ( )

inlineoverridevirtualinherited

Rewind.

Implements JLANG::JRewindable< T >.

Definition at line 56 of file JTreeReaderObjectIterator.hh.

    {
      counter = 0;
    }

◆ hasNext()

template<class T >

virtual bool JROOT::JTreeReaderObjectIterator< T >::hasNext ( )

inlineoverridevirtualinherited

Check availability of next element.

Returns: true if the iteration has more elements.

Implements JLANG::JObjectIterator< T >.

Definition at line 67 of file JTreeReaderObjectIterator.hh.

    {
      if (this->is_valid()) 
        return counter < this->get()->GetEntries();
      else
        return false;
    }

◆ next()

template<class T >

virtual const pointer_type & JROOT::JTreeReaderObjectIterator< T >::next ( )

inlineoverridevirtualinherited

Get next element.

Returns: pointer to element.

Implements JLANG::JObjectIterator< T >.

Definition at line 81 of file JTreeReaderObjectIterator.hh.

    {
      static pointer_type ps;
      
      if (hasNext()) {
 
        this->get()->GetEvent(counter++);
 
        ps.reset(this->getAddress());
 
      } else {
 
        ps.reset(NULL);
      }
 
      return ps;
    }

◆ skip()

template<class T >

virtual skip_type JROOT::JTreeReaderObjectIterator< T >::skip ( const skip_type ns )

inlineoverridevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns: number of items skipped

Reimplemented from JLANG::JObjectIterator< T >.

Definition at line 106 of file JTreeReaderObjectIterator.hh.

    {
      if (this->is_valid()) {
        return advance(counter, ns, this->get()->GetEntries());
      }
 
      return 0;
    }

◆ getCounter()

template<class T >

counter_type JROOT::JTreeReaderObjectIterator< T >::getCounter ( ) const

inlineinherited

Get internal counter.

Returns: counter

Definition at line 121 of file JTreeReaderObjectIterator.hh.

    {
      return counter;
    }

◆ load()

template<class T >

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

inlineoverridevirtualinherited

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->setBranchAddress(*(this->get()));
 
          return true;
        }
      }
 
      return false;
    }

◆ getDictionary()

template<class T >

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

inlineoverridevirtualinherited

Get ROOT dictionary.

Returns: dictionary.

Implements JROOT::JAbstractTreeReader.

Definition at line 108 of file JTreeReader.hh.

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

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

◆ reset() [1/3]

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

◆ reset() [2/3]

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

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

◆ getTreeParameters()

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

inlineinherited

Get TTree parameters.

Returns: TTree parameters

Definition at line 67 of file JTreeParameters.hh.

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

◆ getTreeName()

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

inlineinherited

Get TTree name.

Returns: TTree name

Definition at line 78 of file JTreeParameters.hh.

    {
      return treeName;
    }

◆ getTreeTitle()

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

inlineinherited

Get TTree title.

Returns: TTree title

Definition at line 89 of file JTreeParameters.hh.

    {
      return treeTitle;
    }

◆ getBranchName()

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

inlineinherited

Get TBranch name.

Returns: TBranch name

Definition at line 100 of file JTreeParameters.hh.

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

◆ getCompressionLevel()

int JROOT::JTreeParameters::getCompressionLevel ( ) const

inlineinherited

Get compression level.

Returns: compression level

Definition at line 111 of file JTreeParameters.hh.

    {
      return compressionLevel;
    }

◆ setCompressionLevel()

void JROOT::JTreeParameters::setCompressionLevel ( const int value )

inlineinherited

Set compression level.

Parameters

value compression level

Definition at line 122 of file JTreeParameters.hh.

    {
      compressionLevel = value;
    }

◆ getBasketSize()

int JROOT::JTreeParameters::getBasketSize ( ) const

inlineinherited

Get basket size.

Returns: basket size

Definition at line 133 of file JTreeParameters.hh.

    {
      return basketSize;
    }

◆ setBasketSize()

void JROOT::JTreeParameters::setBasketSize ( int value )

inlineinherited

Set basket size.

Parameters

value basket size

Definition at line 144 of file JTreeParameters.hh.

    {
      basketSize = value;
    }

◆ getSplitLevel()

int JROOT::JTreeParameters::getSplitLevel ( ) const

inlineinherited

Get split level.

Returns: split level

Definition at line 155 of file JTreeParameters.hh.

    {
      return splitLevel;
    }

◆ setSplitLevel()

void JROOT::JTreeParameters::setSplitLevel ( int value )

inlineinherited

Set split level.

Parameters

value split level

Definition at line 166 of file JTreeParameters.hh.

    {
      splitLevel = value;
    }

◆ getAutoFlush()

Long64_t JROOT::JTreeParameters::getAutoFlush ( ) const

inlineinherited

Get auto flush.

Returns: auto flush

Definition at line 177 of file JTreeParameters.hh.

    {
      return autoFlush;
    }

◆ setAutoFlush()

void JROOT::JTreeParameters::setAutoFlush ( Long64_t value )

inlineinherited

Set auto flush.

Parameters

value auto flush

Definition at line 188 of file JTreeParameters.hh.

    {
      autoFlush = value;
    }

◆ setBranchAddress()

template<typename T >

void JROOT::JTreeBranchAddresses< T >::setBranchAddress ( TTree & tree )

inlineinherited

Definition at line 53 of file JTreeBranchAddresses.hh.

  {
    TObjArray* branches = tree.GetListOfBranches();
    // single branch
    if (branches->GetEntries() == 1) {
      tree.SetBranchAddress(branches->First()->GetName(), &this->address);
      return;
    }
 
    // if more than one branch, check those are the data members of T
    TClass* t_class = TClass::GetClass<T>();
    if (t_class == nullptr) {
      THROW(JException, "Could not get class " << typeid(T).name());
    }
 
    auto branch_names = to_vector(tree.GetListOfBranches());
    auto all_member_names = to_vector(t_class->GetListOfRealData());
 
    std::vector<std::string> member_names;
 
    // remove TObject specific members
    std::copy_if(all_member_names.begin(), all_member_names.end(), std::back_inserter(member_names),
                 [](const std::string& member_name)
                 { return !JRoot::is_tobject_member(member_name.c_str()); });
 
    std::sort(branch_names.begin(), branch_names.end());
    std::sort(member_names.begin(), member_names.end());
 
    // all members must have a corresponding branch
    // (but more branches are allowed, we just don't handle them here)
    if (std::includes(branch_names.begin(), branch_names.end(), member_names.begin(),
                      member_names.end())) {
 
      this->address = new T;
 
      auto* base = reinterpret_cast<uint8_t*>(this->address);
 
      for (const auto& member_name : member_names) {
        auto* member = static_cast<TDataMember*>(t_class->GetDataMember(member_name.c_str()));
        tree.SetBranchAddress(member_name.c_str(),
                              reinterpret_cast<void*>(base + member->GetOffset()));
      }
      return;
    }
 
    // if we cannot configure the tree, try to give some relevant information
    // to the user who will have to deal with the exception...
    THROW(JException, "Members of type " << typeid(T).name() << "\n"
                                         << JEEP::JEEPZ() << member_names << "\nBranches in tree\n"
                                         << JEEP::JEEPZ() << branch_names);
  }

◆ release()

template<class T >

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

inlineinherited

Release memory.

Definition at line 54 of file JRootAddress.hh.

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

◆ getAddress()

template<class T >

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

inlineinherited

Get address.

Returns: address

Definition at line 70 of file JRootAddress.hh.

    {
      return address;
    }

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

Member Data Documentation

◆ counter

template<class T >

counter_type JROOT::JTreeReaderObjectIterator< T >::counter

protectedinherited

Definition at line 127 of file JTreeReaderObjectIterator.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.

◆ treeName

TString JROOT::JTreeParameters::treeName

protectedinherited

TTree name.

Definition at line 215 of file JTreeParameters.hh.

◆ treeTitle

TString JROOT::JTreeParameters::treeTitle

protectedinherited

TTree title.

Definition at line 216 of file JTreeParameters.hh.

◆ branchName

TString JROOT::JTreeParameters::branchName

protectedinherited

TBranch name.

Definition at line 217 of file JTreeParameters.hh.

◆ compressionLevel

int JROOT::JTreeParameters::compressionLevel

protectedinherited

TBranch compression level.

Definition at line 218 of file JTreeParameters.hh.

◆ basketSize

int JROOT::JTreeParameters::basketSize

protectedinherited

TBranch basket size.

Definition at line 219 of file JTreeParameters.hh.

◆ splitLevel

int JROOT::JTreeParameters::splitLevel

protectedinherited

TBranch split level.

Definition at line 220 of file JTreeParameters.hh.

◆ autoFlush

Long64_t JROOT::JTreeParameters::autoFlush

protectedinherited

TTree auto flush.

Definition at line 221 of file JTreeParameters.hh.

◆ address

template<class T >

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

protectedinherited

Definition at line 76 of file JRootAddress.hh.

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

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

JTreeReaderObjectIterator.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ pointer_type

Constructor & Destructor Documentation

◆ JTreeReaderAccessibleObjectIterator()

Member Function Documentation

◆ is_open()

◆ open()

◆ close()

◆ rewind()

◆ hasNext()

◆ next()

◆ skip()

◆ getCounter()

◆ load()

◆ getDictionary()

◆ get()

◆ set() [1/2]

◆ set() [2/2]

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

◆ getTreeParameters()

◆ getTreeName()

◆ getTreeTitle()

◆ getBranchName()

◆ getCompressionLevel()

◆ setCompressionLevel()

◆ getBasketSize()

◆ setBasketSize()

◆ getSplitLevel()

◆ setSplitLevel()

◆ getAutoFlush()

◆ setAutoFlush()

◆ setBranchAddress()

◆ release()

◆ getAddress()

◆ Throw() [1/2]

◆ Throw() [2/2]

Member Data Documentation

◆ counter

◆ __p

◆ treeName

◆ treeTitle

◆ branchName

◆ compressionLevel

◆ basketSize

◆ splitLevel

◆ autoFlush

◆ address

◆ do_throw