Jpp test-rotations-new
the software that should make you happy
Loading...
Searching...
No Matches
JSUPPORT::JFileScanner< T > Class Template Reference

Object reading from file. More...

#include <JFileScanner.hh>

Inheritance diagram for JSUPPORT::JFileScanner< T >:
JLANG::JAccessibleObjectReader< T > JLANG::JAccessibleObjectIterator< T > JLANG::JAbstractAccessibleObjectReader< T > JLANG::JSharedPointer< JAccessibleObjectIterator< T > > JLANG::JObjectIterator< T > JLANG::JAccessible JLANG::JAccessibleObjectIterator< T > JLANG::JAbstractObjectReader< T > JLANG::JSharedCounter JLANG::JStorage< JAccessibleObjectIterator< T >, JNew > JLANG::JThrow< JAccessible > JLANG::JObjectIterator< T > JLANG::JAccessible JLANG::JObjectIterator< T > JLANG::JPointer< JAccessibleObjectIterator< T > > JLANG::JNew< JAccessibleObjectIterator< T > > JLANG::JThrow< JAccessible > JLANG::JAbstractPointer< JAccessibleObjectIterator< T > > JLANG::JEquals< JAbstractPointer< JAccessibleObjectIterator< T > > >

Public Types

typedef JAccessibleObjectReader< T >::helper_type helper_type
 
typedef JObjectIterator< T >::pointer_type pointer_type
 
typedef JStorage< JAccessibleObjectIterator< T >, JNew > storage_type
 
typedef JNew< JAccessibleObjectIterator< T > > memory_type
 

Public Member Functions

 JFileScanner ()
 Default constructor.
 
 JFileScanner (const char *file_name)
 Constructor.
 
 ~JFileScanner ()
 Destructor.
 
virtual void open (const char *file_name) override
 Open file.
 
virtual void close () override
 Close device.
 
virtual JAccessibleObjectIterator< T > * getHelper () const override
 Get helper.
 
virtual bool hasNext () override
 Check availability of next element.
 
virtual const pointer_typenext () override
 Get next element.
 
virtual skip_type skip (const skip_type ns) override
 Skip items.
 
virtual bool is_open () const override
 Check is device is open.
 
const JSharedPointergetSharedPointer () const
 Get shared pointer.
 
JSharedPointergetSharedPointer ()
 Get shared pointer.
 
void setSharedPointer (const JSharedPointer &object)
 Set shared pointer.
 
virtual void reset () override
 Reset pointer.
 
void reset (const JPointer< T > &pointer)
 Reset pointer.
 
void reset (JAccessibleObjectIterator< T > *p)
 Reset pointer.
 
void set (const JPointer< T > &pointer)
 Set pointer.
 
void initialise ()
 Initialise counter.
 
void attach (const JSharedCounter &object)
 Attach this counter to given shared counter object.
 
bool detach ()
 Detach.
 
const int getCount ()
 Get count.
 
void recreate ()
 Recreate object in memory.
 
void create ()
 Create object in memory.
 
void create (const unsigned int size)
 Create array of objects in memory.
 
virtual JAccessibleObjectIterator< T > * get () const override
 Get pointer.
 
JAccessibleObjectIterator< T > *const & getReference () const
 Get rereference to internal pointer.
 
JAccessibleObjectIterator< T > *& getReference ()
 Get rereference to internal pointer.
 
virtual bool equals (const JAbstractPointer &object) const
 Equals.
 
bool is_valid () const
 Check validity of pointer.
 
JAccessibleObjectIterator< T > * operator-> () const
 Smart pointer operator.
 
 operator JAccessibleObjectIterator< T > * () const
 Type conversion operator.
 

Static Public Member Functions

static void release (JAccessibleObjectIterator< T > *p)
 Release memory.
 
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 Member Functions

void set (const JSharedPointer &object)
 Set pointer.
 
virtual void set (JAccessibleObjectIterator< T > *p) override
 Set pointer.
 
void release ()
 Release memory.
 

Protected Attributes

int * counter
 
JAccessibleObjectIterator< T > * __p
 pointer to object
 

Static Protected Attributes

static bool do_throw
 throw option
 

Private Attributes

pointer_type ps
 

Detailed Description

template<class T>
class JSUPPORT::JFileScanner< T >

Object reading from file.

This class implements the method open of the JLANG::JAccessible interface. The file format is derived from the file name extension.

Definition at line 37 of file JFileScanner.hh.

Member Typedef Documentation

◆ helper_type

template<class T >
JAccessibleObjectReader<T>::helper_type JSUPPORT::JFileScanner< T >::helper_type

Definition at line 42 of file JFileScanner.hh.

◆ pointer_type

template<class T >
JObjectIterator<T>::pointer_type JLANG::JAccessibleObjectReader< T >::pointer_type
inherited

Definition at line 98 of file JObjectReader.hh.

◆ storage_type

JStorage<JAccessibleObjectIterator< T >, JNew> JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::storage_type
inherited

Definition at line 35 of file JSharedPointer.hh.

◆ memory_type

JNew<JAccessibleObjectIterator< T >> JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >::memory_type
inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JFileScanner() [1/2]

template<class T >
JSUPPORT::JFileScanner< T >::JFileScanner ( )
inline

Default constructor.

Definition at line 47 of file JFileScanner.hh.

48 {}

◆ JFileScanner() [2/2]

template<class T >
JSUPPORT::JFileScanner< T >::JFileScanner ( const char * file_name)
inline

Constructor.

Parameters
file_namefile name

Definition at line 56 of file JFileScanner.hh.

57 {
58 open(file_name);
59 }
virtual void open(const char *file_name) override
Open file.

◆ ~JFileScanner()

template<class T >
JSUPPORT::JFileScanner< T >::~JFileScanner ( )
inline

Destructor.

Definition at line 65 of file JFileScanner.hh.

66 {
67 if (this->is_open()) {
68 this->close();
69 }
70 }
virtual void close() override
Close device.
virtual bool is_open() const override
Check is device is open.

Member Function Documentation

◆ open()

template<class T >
virtual void JSUPPORT::JFileScanner< T >::open ( const char * file_name)
inlineoverridevirtual

Open file.

Parameters
file_namefile name

Implements JLANG::JAccessible.

Definition at line 78 of file JFileScanner.hh.

79 {
80 using namespace std;
81 using namespace JPP;
82
83 JAccessible::Throw(true);
84
85 if (getProtocol(file_name) == ROOT_FILE_FORMAT)
86 this->reset(new JRootFileReader<T>());
87 else if (getFilenameExtension(file_name) == ROOT_FILE_FORMAT)
88 this->reset(new JRootFileReader<T>());
89 else if (getFilenameExtension(file_name) == DAQ_FILE_FORMAT)
90 this->reset(new JDAQFileReader<T>());
91 else if (getFilenameExtension(file_name) == JPP_FILE_FORMAT)
92 this->reset(new JBinaryFileReader<T>());
93 else if (getFilenameExtension(file_name) == MONTE_CARLO_FILE_FORMAT)
95 else if (getFilenameExtension(file_name) == GZIP_FILE_FORMAT)
97 else
98 this->Throw(JProtocolException(MAKE_STRING("Protocol not defined: " << file_name)));
99
100 if (this->is_valid()) {
101
102 this->get()->open(file_name);
103
104 if (!this->get()->is_open()) {
105 if (getFilenameExtension(file_name) != ROOT_FILE_FORMAT) {
106 JAccessible::Throw(JFileOpenException("File not opened."));
107 }
108 }
109 }
110 }
#define MAKE_STRING(A)
Make string.
Definition JPrint.hh:63
Object reading from binary file (i.e. .jpp).
Exception for opening of file.
virtual JAccessibleObjectIterator< T > * get() const override
Definition JPointer.hh:64
Protocol exception.
static void Throw(const bool option)
Definition JThrow.hh:37
DAQ object reading from binary file (i.e. .dat).
Template definition of Monte Carlo object reader for ASCII formatted file (i.e. '....
Template definition of Monte Carlo object reader for gzipped ASCII formatted file (i....
std::string getFilenameExtension(const std::string &file_name)
Get file name extension, i.e. part after last JEEP::FILENAME_SEPARATOR if any.
std::string getProtocol(const std::string &file_name)
Get protocol, i.e. part before first JEEP::PROTOCOL_SEPARATOR if any.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
static const char *const DAQ_FILE_FORMAT
file name extension DAQ binary format
static const char *const GZIP_FILE_FORMAT
file name extension gzip format
static const char *const JPP_FILE_FORMAT
file name extension Jpp binary format
static const char *const ROOT_FILE_FORMAT
file name extension ROOT format
static const char *const MONTE_CARLO_FILE_FORMAT
file name extension ASCII format

◆ close()

template<class T >
virtual void JSUPPORT::JFileScanner< T >::close ( )
inlineoverridevirtual

Close device.

Implements JLANG::JAccessible.

Definition at line 116 of file JFileScanner.hh.

117 {
118 if (this->is_valid()) {
119 this->get()->close();
120 this->reset();
121 }
122 }

◆ getHelper()

template<class T >
virtual JAccessibleObjectIterator< T > * JLANG::JAccessibleObjectReader< T >::getHelper ( ) const
inlineoverridevirtualinherited

Get helper.

Returns
helper

Implements JLANG::JAbstractAccessibleObjectReader< T >.

Definition at line 112 of file JObjectReader.hh.

113 {
114 return this->get();
115 }

◆ hasNext()

template<class T >
virtual bool JLANG::JAbstractObjectReader< T >::hasNext ( )
inlineoverridevirtualinherited

Check availability of next element.

Returns
true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 43 of file JAbstractObjectReader.hh.

44 {
45 return (this->getHelper() != NULL && this->getHelper()->hasNext());
46 }
virtual bool hasNext() override
Check availability of next element.
virtual JObjectIterator< T > * getHelper() const =0
Get helper.

◆ next()

template<class T >
virtual const pointer_type & JLANG::JAbstractObjectReader< T >::next ( )
inlineoverridevirtualinherited

Get next element.

Returns
pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 54 of file JAbstractObjectReader.hh.

55 {
56 if (this->getHelper() != NULL)
57 return this->getHelper()->next();
58 else
59 return ps;
60 }

◆ skip()

template<class T >
virtual skip_type JLANG::JAbstractObjectReader< T >::skip ( const skip_type ns)
inlineoverridevirtualinherited

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Reimplemented from JLANG::JObjectIterator< T >.

Definition at line 69 of file JAbstractObjectReader.hh.

70 {
71 if (this->getHelper() != NULL)
72 return this->getHelper()->skip(ns);
73 else
74 return 0;
75 }

◆ is_open()

template<class T >
virtual bool JLANG::JAbstractAccessibleObjectReader< T >::is_open ( ) const
inlineoverridevirtualinherited

Check is device is open.

Returns
true if open; else false

Implements JLANG::JAccessible.

Definition at line 137 of file JAbstractObjectReader.hh.

138 {
139 if (this->getHelper() != NULL)
140 return this->getHelper()->is_open();
141 else
142 return false;
143 }
virtual JAccessibleObjectIterator< T > * getHelper() const override=0
Get helper.

◆ getSharedPointer() [1/2]

const JSharedPointer & JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::getSharedPointer ( ) const
inlineinherited

Get shared pointer.

Returns
this shared pointer

Definition at line 95 of file JSharedPointer.hh.

96 {
97 return static_cast<const JSharedPointer&>(*this);
98 }

◆ getSharedPointer() [2/2]

JSharedPointer & JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::getSharedPointer ( )
inlineinherited

Get shared pointer.

Returns
this shared pointer

Definition at line 106 of file JSharedPointer.hh.

107 {
108 return static_cast<JSharedPointer&>(*this);
109 }

◆ setSharedPointer()

void JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::setSharedPointer ( const JSharedPointer< JAccessibleObjectIterator< T > > & object)
inlineinherited

Set shared pointer.

Parameters
objectshared pointer

Definition at line 117 of file JSharedPointer.hh.

118 {
119 if (this->get() != object.get()) {
120
121 this->reset();
122
123 if (object.is_valid()) {
124 this->set(object);
125 }
126 }
127 }

◆ reset() [1/3]

virtual void JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::reset ( )
inlineoverridevirtualinherited

Reset pointer.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero.

Reimplemented from JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >.

Definition at line 171 of file JSharedPointer.hh.

172 {
173 if (this->detach()) {
175 }
176
178 }
virtual void reset() override
Reset pointer.
Definition JPointer.hh:84
virtual void reset() override
Reset pointer.
Definition JStorage.hh:42

◆ reset() [2/3]

void JLANG::JPointer< JAccessibleObjectIterator< T > >::reset ( const JPointer< T > & pointer)
inlineinherited

Reset pointer.

Parameters
pointerpointer to object

Definition at line 35 of file JPointer.hh.

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

◆ reset() [3/3]

void JLANG::JAbstractPointer< JAccessibleObjectIterator< T > >::reset ( JAccessibleObjectIterator< 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 }

◆ set() [1/3]

void JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::set ( const JSharedPointer< JAccessibleObjectIterator< T > > & object)
inlineprotectedinherited

Set pointer.

The reference counter of the shared object pointed to is incremented by one.

Parameters
objectshared pointer

Definition at line 188 of file JSharedPointer.hh.

189 {
190 pointer_type::set(object.get());
191
192 this->attach(object);
193 }
virtual void set(JClass_t *p) override
Set pointer.
Definition JPointer.hh:75
void attach(const JSharedCounter &object)
Attach this counter to given shared counter object.

◆ set() [2/3]

virtual void JLANG::JSharedPointer< JAccessibleObjectIterator< T >, JNew >::set ( JAccessibleObjectIterator< T > * p)
inlineoverrideprotectedvirtualinherited

Set pointer.

The reference counter of the shared object pointed to is initialised to one.

Parameters
ppointer to derived class object

Reimplemented from JLANG::JPointer< JAccessibleObjectIterator< T > >.

Definition at line 202 of file JSharedPointer.hh.

203 {
205
206 this->initialise();
207 }
void initialise()
Initialise counter.

◆ set() [3/3]

void JLANG::JPointer< JAccessibleObjectIterator< 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 }

◆ initialise()

void JLANG::JSharedCounter::initialise ( )
inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

34 {
35 detach();
36
37 counter = new int(1);
38 }

◆ attach()

void JLANG::JSharedCounter::attach ( const JSharedCounter & object)
inlineinherited

Attach this counter to given shared counter object.

Parameters
objectshared counter

Definition at line 46 of file JSharedCounter.hh.

47 {
48 detach();
49
50 counter = object.counter;
51
52 if (counter != NULL) {
53 ++(*counter);
54 }
55 }

◆ detach()

bool JLANG::JSharedCounter::detach ( )
inlineinherited

Detach.

Returns
true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

64 {
65 if (counter != NULL) {
66
67 if (--(*counter) == 0) {
68
69 delete counter;
70
71 counter = NULL;
72
73 return true;
74 }
75
76 counter = NULL;
77 }
78
79 return false;
80 }

◆ getCount()

const int JLANG::JSharedCounter::getCount ( )
inlineinherited

Get count.

Returns
count

Definition at line 88 of file JSharedCounter.hh.

89 {
90 return (counter != NULL ? *counter : 0);
91 }

◆ recreate()

void JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >::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 }
static JAccessibleObjectIterator< T > * create()
Definition JMemory.hh:30

◆ create() [1/2]

void JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >::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 {
72 }

◆ create() [2/2]

void JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >::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]

void JLANG::JStorage< JAccessibleObjectIterator< T >, JNew >::release ( )
inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

92 {
93 memory_type::release(this->get());
94 }
static void release(JAccessibleObjectIterator< T > *p)
Definition JMemory.hh:41

◆ release() [2/2]

static void JLANG::JNew< JAccessibleObjectIterator< T > >::release ( JAccessibleObjectIterator< T > * p)
inlinestaticinherited

Release memory.

Parameters
ppointer to data

Definition at line 41 of file JMemory.hh.

42 {
43 delete p;
44 }

◆ get()

virtual JAccessibleObjectIterator< T > * JLANG::JPointer< JAccessibleObjectIterator< T > >::get ( ) const
inlineoverridevirtualinherited

Get pointer.

Returns
pointer to object

Implements JLANG::JAbstractPointer< JAccessibleObjectIterator< T > >.

Definition at line 64 of file JPointer.hh.

65 {
66 return this->__p;
67 }
JAccessibleObjectIterator< T > * __p
Definition JPointer.hh:136

◆ getReference() [1/2]

JAccessibleObjectIterator< T > *const & JLANG::JPointer< JAccessibleObjectIterator< 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]

JAccessibleObjectIterator< T > *& JLANG::JPointer< JAccessibleObjectIterator< 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()

virtual bool JLANG::JAbstractPointer< JAccessibleObjectIterator< T > >::equals ( const JAbstractPointer< JAccessibleObjectIterator< 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()

bool JLANG::JAbstractPointer< JAccessibleObjectIterator< 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->()

JAccessibleObjectIterator< T > * JLANG::JAbstractPointer< JAccessibleObjectIterator< 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.

◆ operator JAccessibleObjectIterator< T > *()

JLANG::JAbstractPointer< JAccessibleObjectIterator< T > >::operator JAccessibleObjectIterator< T > * ( ) const
inlineinherited

Type conversion operator.

Returns
pointer to object

Definition at line 126 of file JAbstractPointer.hh.

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

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

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

Member Data Documentation

◆ ps

template<class T >
pointer_type JLANG::JAbstractObjectReader< T >::ps
privateinherited

Definition at line 78 of file JAbstractObjectReader.hh.

◆ counter

int* JLANG::JSharedCounter::counter
protectedinherited

Definition at line 94 of file JSharedCounter.hh.

◆ __p

pointer to object

Definition at line 136 of file JPointer.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: