Jpp  18.2.1-ARCA-DF-PATCH
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
JROOT::JRootFileReader< T, false > Class Template Referenceabstract

Tempate specialisation of JRootFileReader for TTree incompatible iteration. More...

#include <JRootFileReader.hh>

Inheritance diagram for JROOT::JRootFileReader< T, false >:
JLANG::JAccessibleObjectIterator< T > JLANG::JRewindableObjectIterator< T > JROOT::JRootInputFile JLANG::JObjectIterator< T > JLANG::JAccessible JLANG::JObjectIterator< T > JLANG::JRewindable< T > JROOT::JRootFile JLANG::JThrow< JAccessible > JLANG::JAccessible JLANG::JStorage< JClass_t, JMemory_t > JLANG::JThrow< JAccessible > JLANG::JPointer< JClass_t > JLANG::JAbstractPointer< JClass_t > JLANG::JEquals< JAbstractPointer< JClass_t > >

Public Types

typedef
JAccessibleObjectIterator< T >
::pointer_type 
pointer_type
 
typedef JMemory_t< JClass_t > memory_type
 

Public Member Functions

 JRootFileReader ()
 Default constructor. More...
 
 JRootFileReader (const char *file_name, const char *key=getName(JType< T >()))
 Constructor. More...
 
virtual void rewind () override
 Rewind. More...
 
virtual void open (const char *file_name) override
 Open file. More...
 
virtual bool hasNext () override
 Check availability of next element. More...
 
virtual const pointer_typenext () override
 Get next element. More...
 
virtual skip_type skip (const skip_type ns) override
 Skip items. More...
 
Short_t getCycle () const
 Get cycle number of last read object. More...
 
virtual skip_type skip (const skip_type ns)
 Skip items. More...
 
virtual bool is_open () const =0
 Check is device is open. More...
 
virtual void close ()=0
 Close device. More...
 
virtual void close () override
 Close file. 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...
 
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

static void Throw (const bool option)
 Enable/disable throw option. More...
 
static int Throw (const JException &error, const int value=-1)
 Throw exception or return error. More...
 

Protected Member Functions

void release ()
 Release memory. More...
 

Protected Attributes

Short_t cycleOld
 
Short_t cycleNew
 
T__p
 
TString name
 

Static Protected Attributes

static bool do_throw
 throw option More...
 

Detailed Description

template<class T>
class JROOT::JRootFileReader< T, false >

Tempate specialisation of JRootFileReader for TTree incompatible iteration.

The methods JROOT::actionAtFileOpen and JROOT::actionAtFileRead are called at opening of each file and reading of each object, respectively.

This class implements the JLANG::JAccessibleObjectIterator interface.

Definition at line 66 of file JRootFileReader.hh.

Member Typedef Documentation

Definition at line 73 of file JRootFileReader.hh.

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

template<class T >
JROOT::JRootFileReader< T, false >::JRootFileReader ( )
inline

Default constructor.

Definition at line 79 of file JRootFileReader.hh.

79  :
80  cycleOld(0),
81  cycleNew(1),
82  __p (NULL),
83  name(getName(JType<T>()))
84  {}
const char * getName()
Get ROOT name of given data type.
Definition: JRootToolkit.hh:60
template<class T >
JROOT::JRootFileReader< T, false >::JRootFileReader ( const char *  file_name,
const char *  key = getName(JType<T>()) 
)
inline

Constructor.

Parameters
file_namefile name
keykey of object to be read

Definition at line 93 of file JRootFileReader.hh.

94  :
95  cycleOld(0),
96  cycleNew(1),
97  __p (NULL),
98  name(key)
99  {
100  open(file_name);
101  }
virtual void open(const char *file_name) override
Open file.

Member Function Documentation

template<class T >
virtual void JROOT::JRootFileReader< T, false >::rewind ( )
inlineoverridevirtual

Rewind.

Implements JLANG::JRewindable< T >.

Definition at line 107 of file JRootFileReader.hh.

108  {
109  cycleOld = 0;
110  cycleNew = 1;
111  }
template<class T >
virtual void JROOT::JRootFileReader< T, false >::open ( const char *  file_name)
inlineoverridevirtual

Open file.

Parameters
file_namefile name

Reimplemented from JROOT::JRootInputFile.

Definition at line 119 of file JRootFileReader.hh.

120  {
121  JRootInputFile::open(file_name);
122 
123  actionAtFileOpen<T>(this->getFile());
124 
125  rewind();
126  }
virtual void open(const char *file_name) override
Open file.
Definition: JRootFile.hh:136
TFile * getFile() const
Get file.
Definition: JRootFile.hh:66
virtual void rewind() override
Rewind.
template<class T >
virtual bool JROOT::JRootFileReader< T, false >::hasNext ( )
inlineoverridevirtual

Check availability of next element.

Returns
true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 134 of file JRootFileReader.hh.

135  {
136  if (is_open()) {
137 
138  if (cycleOld != cycleNew) {
139 
140  TString key(name);
141 
142  key += ';';
143  key += cycleNew;
144 
145  cycleOld = cycleNew;
146  __p = NULL;
147 
148  getObject(getFile(), key, __p);
149 
150  actionAtFileRead<T>(__p);
151  }
152 
153  return (cycleOld == cycleNew && __p != NULL);
154  }
155 
156  return false;
157  }
void getObject(TFile *file, const TString &key, T *&ps)
Read object from ROOT file.
TFile * getFile() const
Get file.
Definition: JRootFile.hh:66
virtual bool is_open() const =0
Check is device is open.
template<class T >
virtual const pointer_type& JROOT::JRootFileReader< T, false >::next ( )
inlineoverridevirtual

Get next element.

Returns
pointer to element.

Implements JLANG::JObjectIterator< T >.

Definition at line 165 of file JRootFileReader.hh.

166  {
167  static pointer_type ps;
168 
169  if (hasNext()) {
170 
171  ++cycleNew;
172 
173  ps.reset(__p);
174 
175  } else {
176 
177  ps.reset(NULL);
178  }
179 
180  return ps;
181  }
virtual bool hasNext() override
Check availability of next element.
JAccessibleObjectIterator< T >::pointer_type pointer_type
template<class T >
virtual skip_type JROOT::JRootFileReader< T, false >::skip ( const skip_type  ns)
inlineoverridevirtual

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Definition at line 190 of file JRootFileReader.hh.

191  {
192  using namespace std;
193 
194  if (ns < (skip_type) cycleNew + (skip_type) numeric_limits<Short_t>::max())
195  cycleNew += (Short_t) ns;
196  else
197  cycleNew = numeric_limits<Short_t>::max();
198 
199  return cycleNew - cycleOld;
200  }
unsigned int skip_type
Type definition for number of objects to skip.
std::vector< size_t > ns
template<class T >
Short_t JROOT::JRootFileReader< T, false >::getCycle ( ) const
inline

Get cycle number of last read object.

Returns
cycle number

Definition at line 208 of file JRootFileReader.hh.

209  {
210  return cycleOld;
211  }
template<class T>
virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type  ns)
inlinevirtualinherited

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Reimplemented in JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, JLANG::JSTDObjectIterator< T >, JLANG::JAbstractObjectReader< T >, JLANG::JAbstractObjectReader< const event_type >, JLANG::JAbstractObjectReader< JNullType >, JLANG::JAbstractObjectReader< const T >, JLANG::JAbstractObjectReader< JTail_t >, JLANG::JAbstractObjectReader< JHead_t >, JLANG::JAbstractObjectReader< KM3NETDAQ::KM3NETDAQ::JDAQEvent >, and JLANG::JAbstractObjectReader< JDAQSummaryslice >.

Definition at line 90 of file JObjectIterator.hh.

91  {
92  skip_type i = 0;
93 
94  for ( ; i != ns && hasNext(); ++i) {
95  next();
96  }
97 
98  return i;
99  }
unsigned int skip_type
Type definition for number of objects to skip.
std::vector< size_t > ns
virtual const pointer_type & next()=0
Get next element.
virtual bool hasNext()=0
Check availability of next element.
virtual bool JLANG::JAccessible::is_open ( ) const
pure virtualinherited
virtual void JLANG::JAccessible::close ( )
pure virtualinherited
static void JLANG::JThrow< JAccessible >::Throw ( const bool  option)
inlinestaticinherited

Enable/disable throw option.

Parameters
optiontrue enable; false disable

Definition at line 37 of file JThrow.hh.

38  {
39  do_throw = option;
40  }
static bool do_throw
throw option
Definition: JThrow.hh:28
static int JLANG::JThrow< JAccessible >::Throw ( const JException error,
const int  value = -1 
)
inlinestaticinherited

Throw exception or return error.

Parameters
errorexception
valuereturn code
Returns
return code

Definition at line 50 of file JThrow.hh.

51  {
52  using namespace std;
53 
54  if (do_throw) {
55  throw error;
56  }
57 
58  cerr << error.what() << endl;
59 
60  return value;
61  }
virtual const char * what() const override
Get error message.
Definition: JException.hh:64
static bool do_throw
throw option
Definition: JThrow.hh:28
virtual void JROOT::JRootInputFile::close ( )
inlineoverridevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 145 of file JRootFile.hh.

146  {
147  do_close();
148  }
void do_close()
Close file.
Definition: JRootFile.hh:180
TFile* JROOT::JRootFile::getFile ( ) const
inlineinherited

Get file.

Returns
pointer to file

Definition at line 66 of file JRootFile.hh.

67  {
68  return get();
69  }
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.

78  {
79  return (getFile() != NULL && getFile()->IsOpen());
80  }
TFile * getFile() const
Get file.
Definition: JRootFile.hh:66
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< JAccessibleObjectIterator< KM3NETDAQ::KM3NETDAQ::JDAQEvent > >, JLANG::JSharedPointer< const TFormula >, JLANG::JSharedPointer< JObjectIterator< T > >, JLANG::JSharedPointer< JRewindableObjectIterator< const event_type > >, JLANG::JSharedPointer< JFIT::JMEstimator >, JLANG::JSharedPointer< JAbstractAutoPointer< JBase_t > >, JLANG::JSharedPointer< JEvtWeight >, JLANG::JSharedPointer< JTRIGGER::JDAQHitSelector >, JLANG::JSharedPointer< JAccessibleObjectIterator< JNullType > >, JLANG::JSharedPointer< match_type >, JLANG::JSharedPointer< JAccessibleObjectIterator< JDAQSummaryslice > >, JLANG::JSharedPointer< JDiffuseFlux >, JLANG::JSharedPointer< JEvtWeightFactor_t >, JLANG::JSharedPointer< JAccessibleObjectIterator< JTail_t > >, JLANG::JSharedPointer< JLOGGER::JLogger >, JLANG::JSharedPointer< JAccessibleObjectIterator< T > >, JLANG::JSharedPointer< JParserElementInterface >, JLANG::JSharedPointer< JExceptionHandler >, JLANG::JSharedPointer< JObjectOutput< JHead_t > >, JLANG::JSharedPointer< JOscProb >, JLANG::JSharedPointer< JAccessibleObjectIterator< JHead_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JTail_t > >, JLANG::JSharedPointer< JRewindableObjectIterator< JHead_t > >, JLANG::JSharedPointer< JObjectOutput< T > >, JLANG::JSharedPointer< JBase_t >, JLANG::JSharedPointer< JObjectOutput< JTail_t > >, JLANG::JSharedPointer< JPropertiesElementInterface >, JLANG::JSharedPointer< JTRIGGER::JMatch >, JLANG::JSharedPointer< JRewindableObjectIterator< const T > >, JLANG::JSharedPointer< JEvtWeightFactor >, JLANG::JSharedPointer< JRewindableObjectIterator< T > >, JLANG::JSharedPointer< JAccessibleObjectOutput< T > >, JLANG::JSharedPointer< JNET::JControlHost >, JLANG::JSharedPointer< JTOOLS::JMultiMapTransformer >, and JLANG::JSharedPointer< JRadiation >.

Definition at line 42 of file JStorage.hh.

43  {
44  if (this->is_valid()) {
45  this->release();
46  }
47 
49  }
bool is_valid() const
Check validity of pointer.
void release()
Release memory.
Definition: JStorage.hh:91
virtual void reset() override
Reset pointer.
Definition: JPointer.hh:84
template<class JClass_t>
template<class T >
void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > &  pointer)
inlineinherited

Reset pointer.

Parameters
pointerpointer to object

Definition at line 108 of file JPointer.hh.

109  {
110  this->reset(pointer.get());
111  }
virtual JClass_t * get() const override
Get pointer.
Definition: JPointer.hh:64
virtual void reset() override
Reset pointer.
Definition: JPointer.hh:84
template<class JClass_t>
void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t *  p)
inlineinherited

Reset pointer.

Parameters
ppointer to object

Definition at line 94 of file JAbstractPointer.hh.

95  {
96  if (this->get() != p) {
97 
98  this->reset();
99 
100  if (p != NULL) {
101  this->set(p);
102  }
103  }
104  }
virtual void reset()=0
Reset pointer.
virtual void set(JClass_t *p)=0
Set pointer.
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.

58  {
59  if (!this->is_valid()) {
60  this->set(memory_type::create());
61  }
62  }
bool is_valid() const
Check validity of pointer.
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
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.

70  {
71  this->reset(memory_type::create());
72  }
virtual void reset() override
Reset pointer.
Definition: JStorage.hh:42
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
sizenumber of elements

Definition at line 81 of file JStorage.hh.

82  {
83  this->reset(memory_type::create(size));
84  }
virtual void reset() override
Reset pointer.
Definition: JStorage.hh:42
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.

92  {
93  memory_type::release(this->get());
94  }
template<class JClass_t>
virtual JClass_t* JLANG::JPointer< JClass_t >::get ( ) const
inlineoverridevirtualinherited
template<class JClass_t>
virtual void JLANG::JPointer< JClass_t >::set ( JClass_t *  p)
inlineoverridevirtualinherited

Set pointer.

Parameters
ppointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

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

Definition at line 75 of file JPointer.hh.

76  {
77  this->__p = p;
78  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
template<class JClass_t>
template<class T >
void JLANG::JPointer< JClass_t >::set ( const JPointer< T > &  pointer)
inlineinherited

Set pointer.

Parameters
pointerpointer to object

Definition at line 96 of file JPointer.hh.

97  {
98  this->set(pointer.get());
99  }
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
virtual JClass_t * get() const override
Get pointer.
Definition: JPointer.hh:64
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.

120  {
121  return __p;
122  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
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.

131  {
132  return __p;
133  }
JClass_t * __p
pointer to object
Definition: JPointer.hh:136
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
objectabstract pointer
Returns
true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

51  {
52  return this->get() == object.get();
53  }
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.

84  {
85  return this->get() != NULL;
86  }
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.

113  {
114  if (!is_valid())
115  THROW(JNullPointerException, "JAbstractPointer::operator->()");
116  else
117  return this->get();
118  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
bool is_valid() const
Check validity of pointer.
Exception for null pointer operation.
Definition: JException.hh:232
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.

127  {
128  return this->get();
129  }

Member Data Documentation

template<class T >
Short_t JROOT::JRootFileReader< T, false >::cycleOld
protected

Definition at line 214 of file JRootFileReader.hh.

template<class T >
Short_t JROOT::JRootFileReader< T, false >::cycleNew
protected

Definition at line 215 of file JRootFileReader.hh.

template<class T >
T* JROOT::JRootFileReader< T, false >::__p
protected

Definition at line 216 of file JRootFileReader.hh.

template<class T >
TString JROOT::JRootFileReader< T, false >::name
protected

Definition at line 217 of file JRootFileReader.hh.

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: