JROOT::JTreeReaderObjectIterator< T > Class Template Reference

JTreeReader object iterator. More...

#include <JTreeReaderObjectIterator.hh>

Inheritance diagram for JROOT::JTreeReaderObjectIterator< T >:

Public Types
typedef JRewindableObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JTreeReaderObjectIterator ()
	Default constructor. More...
virtual void	rewind () override
	Rewind. More...
virtual bool	hasNext () override
	Check availability of next element. More...
virtual const pointer_type &	next () override
	Get next element. More...
virtual skip_type	skip (const skip_type ns) override
	Skip items. More...
counter_type	getCounter () const
	Get internal counter. More...
virtual skip_type	skip (const skip_type ns)
	Skip items. 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	setBranchAddress (TTree &tree)
void	release ()
	Release memory. More...
T *	getAddress () const
	Get address. More...

Protected Attributes
counter_type	counter
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::JTreeReaderObjectIterator< T >

JTreeReader object iterator.

This class implements the JLANG::JRewindableObjectIterator interface.

Definition at line 33 of file JTreeReaderObjectIterator.hh.

Member Typedef Documentation

pointer_type

template<class T >

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

Definition at line 39 of file JTreeReaderObjectIterator.hh.

Constructor & Destructor Documentation

JTreeReaderObjectIterator()

template<class T >

JROOT::JTreeReaderObjectIterator< T >::JTreeReaderObjectIterator ( )

inline

Default constructor.

Definition at line 45 of file JTreeReaderObjectIterator.hh.

                                :
      JTreeReader<T>(getTreeParameters<T>()),
      counter(0)
    {
      gErrorIgnoreLevel = kError;
    }

Member Function Documentation

rewind()

template<class T >

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

inlineoverridevirtual

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

inlineoverridevirtual

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

inlineoverridevirtual

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() [1/2]

template<class T >

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

inlineoverridevirtual

Skip items.

Parameters

ns	number of items to skip

Returns

number of items skipped

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

inline

Get internal counter.

Returns

counter

Definition at line 121 of file JTreeReaderObjectIterator.hh.

    {
      return counter;
    }

skip() [2/2]

template<class T >

virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type  ns )

inlinevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns

number of items skipped

Reimplemented in JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, and JLANG::JAbstractObjectReader< T >.

Definition at line 90 of file JObjectIterator.hh.

    {
      skip_type i = 0;
 
      for ( ; i != ns && hasNext(); ++i) {
        next();
      }
 
      return i;
    }

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

reset() [1/3]

template<class JClass_t >

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

inlineoverridevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JStorage< JClass_t, JMemory_t >, JLANG::JStorage< TFile >, JLANG::JStorage< JClass_t, JNew >, JLANG::JStorage< JClass_t, JMemory_t >, JLANG::JStorage< TFile >, JLANG::JStorage< JClass_t, JNew >, JLANG::JSharedPointer< JClass_t, JMemory_t >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< const TFormula >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< match_type >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JExceptionHandler >, JLANG::JSharedPointer< JTRIGGER::JMatch >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, and JLANG::JSharedPointer< JRadiation >.

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 63 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 74 of file JTreeParameters.hh.

    {
      return treeName;
    }

getTreeTitle()

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

inlineinherited

Get TTree title.

Returns

TTree title

Definition at line 85 of file JTreeParameters.hh.

    {
      return treeTitle;
    }

getBranchName()

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

getCompressionLevel()

int JROOT::JTreeParameters::getCompressionLevel ( ) const

inlineinherited

Get compression level.

Returns

compression level

Definition at line 107 of file JTreeParameters.hh.

    {
      return compressionLevel;
    }

getBasketSize()

int JROOT::JTreeParameters::getBasketSize ( ) const

inlineinherited

Get basket size.

Returns

basket size

Definition at line 118 of file JTreeParameters.hh.

    {
      return basketSize;
    }

getSplitLevel()

int JROOT::JTreeParameters::getSplitLevel ( ) const

inlineinherited

Get split level.

Returns

split level

Definition at line 129 of file JTreeParameters.hh.

    {
      return splitLevel;
    }

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 !JRootClass::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 46 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 62 of file JRootAddress.hh.

    {
      return address;
    }

Member Data Documentation

counter

template<class T >

counter_type JROOT::JTreeReaderObjectIterator< T >::counter

protected

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 155 of file JTreeParameters.hh.

treeTitle

TString JROOT::JTreeParameters::treeTitle

protectedinherited

TTree title.

Definition at line 156 of file JTreeParameters.hh.

branchName

TString JROOT::JTreeParameters::branchName

protectedinherited

TBranch name.

Definition at line 157 of file JTreeParameters.hh.

compressionLevel

int JROOT::JTreeParameters::compressionLevel

protectedinherited

TBranch compression level.

Definition at line 158 of file JTreeParameters.hh.

basketSize

int JROOT::JTreeParameters::basketSize

protectedinherited

TBranch basket size.

Definition at line 159 of file JTreeParameters.hh.

splitLevel

int JROOT::JTreeParameters::splitLevel

protectedinherited

TBranch split level.

Definition at line 160 of file JTreeParameters.hh.

address

template<class T >

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

protectedinherited

Definition at line 68 of file JRootAddress.hh.

---

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

• JTreeReaderObjectIterator.hh