Jpp  master_rocky
the software that should make you happy
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | List of all members
JROOT::JRootOutputFile Class Reference

ROOT output file. More...

#include <JRootFile.hh>

Inheritance diagram for JROOT::JRootOutputFile:
JROOT::JRootFile JLANG::JAccessible JLANG::JStorage< JClass_t, JMemory_t > JLANG::JThrow< JAccessible > JLANG::JPointer< JClass_t > JLANG::JNew< JClass_t > JLANG::JAbstractPointer< JClass_t > JLANG::JEquals< JAbstractPointer< JClass_t > > JSUPPORT::JAutoTreeWriter< JNET::JTag > JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t > JROOT::JRootFileWriter< T > JSUPPORT::JAutoTreeWriter< JKey_t > JSUPPORT::JTreeRecorder< T > KM3NETDAQ::JDataFilter::JCircularBuffer_t

Public Types

typedef JPointer< JClass_t > pointer_type
 
typedef JMemory_t< JClass_t > memory_type
 

Public Member Functions

 JRootOutputFile ()
 Default constructor. More...
 
 JRootOutputFile (const char *file_name)
 Constructor. More...
 
 ~JRootOutputFile ()
 Destructor. More...
 
virtual void open (const char *file_name) override
 Open file. 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...
 
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

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

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

ROOT output file.

This class implements the methods open() and close() of the JLANG::JAccessible interface.

Definition at line 196 of file JRootFile.hh.

Member Typedef Documentation

◆ 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

◆ JRootOutputFile() [1/2]

JROOT::JRootOutputFile::JRootOutputFile ( )
inline

Default constructor.

Definition at line 203 of file JRootFile.hh.

203  :
204  JRootFile()
205  {}
JROOT::JRootFile::JRootFile
JRootFile()
Default constructor.
Definition: JRootFile.hh:54

◆ JRootOutputFile() [2/2]

JROOT::JRootOutputFile::JRootOutputFile ( const char *  file_name)
inline

Constructor.

Parameters
file_namefile name

Definition at line 213 of file JRootFile.hh.

213  :
214  JRootFile()
215  {
216  do_open(file_name);
217  }
JROOT::JRootOutputFile::do_open
void do_open(const char *file_name)
Open file.
Definition: JRootFile.hh:260

◆ ~JRootOutputFile()

JROOT::JRootOutputFile::~JRootOutputFile ( )
inline

Destructor.

The destructor writes and closes the file if it is still open.

Definition at line 225 of file JRootFile.hh.

226  {
227  do_close();
228  }
JROOT::JRootOutputFile::do_close
void do_close()
Close file.
Definition: JRootFile.hh:274

Member Function Documentation

◆ open()

virtual void JROOT::JRootOutputFile::open ( const char *  file_name)
inlineoverridevirtual

Open file.

The file is not opened when a file exists with the given name.

Parameters
file_namefile name

Implements JLANG::JAccessible.

Reimplemented in JSUPPORT::JTreeRecorder< T >, JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, and JROOT::JRootFileWriter< T >.

Definition at line 237 of file JRootFile.hh.

238  {
239  do_open(file_name);
240  }

◆ close()

virtual void JROOT::JRootOutputFile::close ( )
inlineoverridevirtual

Close file.

This method calls the TFile::Write method before closing the file.

Implements JLANG::JAccessible.

Reimplemented in JSUPPORT::JTreeRecorder< T >, JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >, JSUPPORT::JAutoTreeWriter< JKey_t >, and JSUPPORT::JAutoTreeWriter< JNET::JTag >.

Definition at line 247 of file JRootFile.hh.

248  {
249  do_close();
250  }

◆ do_open()

void JROOT::JRootOutputFile::do_open ( const char *  file_name)
inlineprivate

Open file.

The file is not opened when a file exists with the given name.

Parameters
file_namefile name

Definition at line 260 of file JRootFile.hh.

261  {
262  set(TFile::Open(file_name, "CREATE"));
263 
264  if (!is_open()) {
265  Throw(MAKE_EXCEPTION(JFileOpenException, "Error opening file " << file_name));
266  }
267  }
MAKE_EXCEPTION
#define MAKE_EXCEPTION(JException_t, A)
Make exception.
Definition: JException.hh:703
JLANG::JPointer::set
virtual void set(JClass_t *p) override
Set pointer.
Definition: JPointer.hh:75
JLANG::JThrow< JAccessible >::Throw
static void Throw(const bool option)
Enable/disable throw option.
Definition: JThrow.hh:37
JROOT::JRootFile::is_open
virtual bool is_open() const override
Check is file is open.
Definition: JRootFile.hh:77

◆ do_close()

void JROOT::JRootOutputFile::do_close ( )
inlineprivate

Close file.

This method calls the TFile::Write method before closing the file.

Definition at line 274 of file JRootFile.hh.

275  {
276  if (getFile() != NULL && getFile()->IsOpen()) {
277  getFile()->Write();
278  getFile()->Close();
279  }
280 
281  reset();
282  }
JLANG::JStorage::reset
virtual void reset() override
Reset pointer.
Definition: JStorage.hh:42
JROOT::JRootFile::getFile
TFile * getFile() const
Get file.
Definition: JRootFile.hh:66

◆ getFile()

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  }
JLANG::JPointer::get
virtual JClass_t * get() const override
Get pointer.
Definition: JPointer.hh:64

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

78  {
79  return (getFile() != NULL && getFile()->IsOpen());
80  }

◆ Throw() [1/2]

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  }
JLANG::JThrow< JAccessible >::do_throw
static bool do_throw
throw option
Definition: JThrow.hh:28

◆ Throw() [2/2]

static int JLANG::JThrow< JAccessible >::Throw ( const JException_t &  error,
const int  value = -1 
)
inlinestaticinherited

Throw exception or return error.

Parameters
errorexception
valuereturn code
Returns
return code

Definition at line 51 of file JThrow.hh.

52  {
53  using namespace std;
54 
55  if (do_throw) {
56  throw error;
57  }
58 
59  cerr << error.what() << endl;
60 
61  return value;
62  }
std
Definition: JSTDTypes.hh:14

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

Reimplemented in 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 42 of file JStorage.hh.

43  {
44  if (this->is_valid()) {
45  this->release();
46  }
47 
48  pointer_type::reset();
49  }
JLANG::JAbstractPointer::is_valid
bool is_valid() const
Check validity of pointer.
Definition: JAbstractPointer.hh:83
JLANG::JPointer::reset
virtual void reset() override
Reset pointer.
Definition: JPointer.hh:84
JLANG::JStorage::release
void release()
Release memory.
Definition: JStorage.hh:91

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

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

85  {
86  this->__p = NULL;
87  }
JLANG::JPointer::__p
JClass_t * __p
pointer to object
Definition: JPointer.hh:136

◆ 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
pointerpointer to object

Definition at line 108 of file JPointer.hh.

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

◆ reset() [4/5]

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  }

◆ reset() [5/5]

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  }
JLANG::JAbstractPointer::set
virtual void set(JClass_t *p)=0
Set pointer.
JLANG::JAbstractPointer::reset
virtual void reset()=0
Reset pointer.
JLANG::JAbstractPointer::get
virtual JClass_t * get() const =0
Get pointer.

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

58  {
59  if (!this->is_valid()) {
60  this->set(memory_type::create());
61  }
62  }

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

70  {
71  this->reset(memory_type::create());
72  }

◆ 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
sizenumber of elements

Definition at line 81 of file JStorage.hh.

82  {
83  this->reset(memory_type::create(size));
84  }

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

92  {
93  memory_type::release(this->get());
94  }

◆ release() [2/2]

template<class JClass_t >
static void JLANG::JNew< JClass_t >::release ( JClass_t *  p)
inlinestaticinherited

Release memory.

Parameters
ppointer to data

Definition at line 41 of file JMemory.hh.

42  {
43  delete p;
44  }

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

65  {
66  return this->__p;
67  }

◆ set() [1/2]

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

Definition at line 75 of file JPointer.hh.

76  {
77  this->__p = p;
78  }

◆ set() [2/2]

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  }

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

120  {
121  return __p;
122  }

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

131  {
132  return __p;
133  }

◆ 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
objectabstract pointer
Returns
true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

51  {
52  return this->get() == object.get();
53  }

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

84  {
85  return this->get() != NULL;
86  }

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

113  {
114  if (!is_valid())
115  THROW(JNullPointerException, "JAbstractPointer::operator->()");
116  else
117  return this->get();
118  }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
JLANG::JNullPointerException
Exception for null pointer operation.
Definition: JException.hh:234

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

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

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:
Generated by doxygen 1.9.1