Object writing to file. More...

#include <JFileRecorder.hh>

Inheritance diagram for JSUPPORT::JFileRecorder< T >:

Public Types
typedef JSharedPointer< JAccessibleObjectOutput< T > >	helper_type

typedef JPointer< JAccessibleObjectOutput< T > >	pointer_type

typedef JStorage< JAccessibleObjectOutput< T >, JNew >	storage_type

typedef JMemory_t< JClass_t >	memory_type

Public Member Functions
	JFileRecorder ()
	Default constructor.

	JFileRecorder (const char *file_name)
	Constructor.

const std::string &	getFilename () const
	Get file name.

const void	setFilename (const std::string &file_name)
	Set file name.

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

void	open ()
	Open file.

virtual JAccessibleObjectOutput< T > *	getHelper () const override
	Get helper.

virtual bool	put (const T &object)=0
	Object output.

virtual bool	put (const T &object) override
	Object output.

virtual bool	is_open () const =0
	Check is device is open.

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

virtual void	close ()=0
	Close device.

virtual void	close () override
	Close device.

const JSharedPointer &	getSharedPointer () const
	Get shared pointer.

JSharedPointer &	getSharedPointer ()
	Get shared pointer.

void	setSharedPointer (const JSharedPointer &object)
	Set shared 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.

virtual void	set (JClass_t *p) override
	Set pointer.

template<class T >
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 JClass_t *	get () const override
	Get 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.

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 Member Functions
void	set (const JSharedPointer &object)
	Set pointer.

virtual void	set (JAccessibleObjectOutput< T > *p) override
	Set pointer.

void	release ()
	Release memory.

Protected Attributes
std::string	fileName

int *	counter

JClass_t *	__p
	pointer to object

Static Protected Attributes
static bool	do_throw
	throw option

Friends
std::istream &	operator>> (std::istream &in, JFileRecorder &recorder)
	Read file recorder from input.

std::ostream &	operator<< (std::ostream &out, const JFileRecorder &recorder)
	Write file recorder to output.

Detailed Description

template<class T>
class JSUPPORT::JFileRecorder< T >

Object writing to file.

This class implements the method open of the JLANG::JAccessible interface. The file format is derived from the file name extension. The method open can be called to open a file after reading the file name.

Definition at line 42 of file JFileRecorder.hh.

Member Typedef Documentation

◆ helper_type

template<class T >

typedef JSharedPointer< JAccessibleObjectOutput<T> > JLANG::JAccessibleObjectWriter< T >::helper_type

inherited

Definition at line 64 of file JObjectWriter.hh.

◆ pointer_type

typedef JPointer<JAccessibleObjectOutput< T > > JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::pointer_type

inherited

Definition at line 34 of file JSharedPointer.hh.

◆ storage_type

typedef JStorage<JAccessibleObjectOutput< T > , JNew > JLANG::JSharedPointer< JAccessibleObjectOutput< T > , JNew >::storage_type

inherited

Definition at line 35 of file JSharedPointer.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

◆ JFileRecorder() [1/2]

template<class T >

JSUPPORT::JFileRecorder< T >::JFileRecorder ( )

inline

Default constructor.

Definition at line 49 of file JFileRecorder.hh.

                    :
      JAccessibleObjectWriter<T>(),
      fileName("")
    {}

◆ JFileRecorder() [2/2]

template<class T >

JSUPPORT::JFileRecorder< T >::JFileRecorder ( const char * file_name )

inline

Constructor.

Parameters

file_name file name

Definition at line 60 of file JFileRecorder.hh.

                                         :
      JAccessibleObjectWriter<T>(),
      fileName(file_name)
    {}

Member Function Documentation

◆ getFilename()

template<class T >

const std::string & JSUPPORT::JFileRecorder< T >::getFilename ( ) const

inline

Get file name.

Returns: file name

Definition at line 71 of file JFileRecorder.hh.

    {
      return fileName;
    }

◆ setFilename()

template<class T >

const void JSUPPORT::JFileRecorder< T >::setFilename ( const std::string & file_name )

inline

Set file name.

Parameters

file_name file name

Definition at line 82 of file JFileRecorder.hh.

    {
      fileName = file_name;
    }

◆ open() [1/2]

template<class T >

virtual void JSUPPORT::JFileRecorder< T >::open ( const char * file_name )

inlineoverridevirtual

Open file.

Parameters

file_name file name

Implements JLANG::JAccessible.

Definition at line 93 of file JFileRecorder.hh.

    {
      fileName = file_name;
 
      open();
    }

◆ open() [2/2]

template<class T >

void JSUPPORT::JFileRecorder< T >::open ( )

inline

Open file.

Definition at line 104 of file JFileRecorder.hh.

    {
      using namespace JPP;
 
      this->reset();
 
      if        (isROOTFile(fileName.c_str())) {
        
        this->reset(new JRootFileWriter<T>());
 
      } else if (isDAQFile(fileName.c_str())) {
 
        this->reset(new JDAQFileWriter<T>());
 
      } else if (isJppFile(fileName.c_str())) {
 
        this->reset(new JBinaryFileWriter<T>());
 
      } else if (isMonteCarloFile(fileName.c_str())) {
 
        this->reset(new JMonteCarloFileWriter<T>());
 
      } else if (fileName.empty() || fileName == "/dev/null") {
 
        this->reset(new JNullAccessibleOutput<T>());
 
      } else {
 
        THROW(JProtocolException, "Protocol not defined: " << fileName);
      }
 
      if (this->is_valid()) {
        this->get()->open(fileName.c_str());
      }
 
      if (!this->get()->is_open()) {
        THROW(JFileOpenException, "Error opening file: " << fileName);
      }
    }

◆ getHelper()

template<class T >

virtual JAccessibleObjectOutput< T > * JLANG::JAccessibleObjectWriter< T >::getHelper ( ) const

inlineoverridevirtualinherited

Get helper.

Returns: helper

Implements JLANG::JAbstractAccessibleObjectWriter< T >.

Definition at line 78 of file JObjectWriter.hh.

    {
      return this->get();
    }

◆ put() [1/2]

template<class T >

virtual bool JLANG::JObjectOutput< T >::put ( const T & object )

pure virtualinherited

Object output.

Parameters

object object

Returns: true if OK; else false

Implemented in JLANG::JObjectDemultiplexer< JBase_t, JDerived_t >, JLANG::JObjectDemultiplexer< JBase_t, JHead_t >, JLANG::JObjectDemultiplexer< JBase_t, JTail_t >, JLANG::JObjectDemultiplexer< JBase_t, JTypeList< JHead_t, JTail_t > >, JIO::JWriterObjectOutput< T >, JLANG::JAbstractObjectWriter< T >, JLANG::JNullOutput< T >, JLANG::JStreamObjectOutput< T >, JNET::JControlHostObjectOutput< T >, JROOT::JRootObjectOutput< T, false >, JROOT::JRootStreamObjectOutput< T >, JROOT::JSonObjectOutput< T >, and JROOT::JTreeWriterObjectOutput< T >.

◆ put() [2/2]

template<class T >

virtual bool JLANG::JAbstractObjectWriter< T >::put ( const T & object )

inlineoverridevirtualinherited

Object output.

Parameters

object object

Returns: true if OK; else false

Implements JLANG::JObjectOutput< T >.

Definition at line 43 of file JAbstractObjectWriter.hh.

    {
      return (this->getHelper() != NULL && this->getHelper()->put(object));
    }

◆ is_open() [1/2]

virtual bool JLANG::JAccessible::is_open ( ) const

pure virtualinherited

Check is device is open.

Returns: true if open; else false

Implemented in JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JNullAccess, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JROOT::JRootFile, and JROOT::JTreeReaderAccessibleObjectIterator< T >.

◆ is_open() [2/2]

template<class T >

virtual bool JLANG::JAbstractAccessibleObjectWriter< T >::is_open ( ) const

inlineoverridevirtualinherited

Check is device is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 102 of file JAbstractObjectWriter.hh.

    {
      if (this->getHelper() != NULL)
        return this->getHelper()->is_open();
      else
        return false;
    }

◆ close() [1/2]

virtual void JLANG::JAccessible::close ( )

pure virtualinherited

Close device.

Implemented in JLANG::JAccessibleInputStream, JLANG::JAccessibleOutputStream, JLANG::JAbstractAccessibleObjectReader< T >, JLANG::JAbstractAccessibleObjectReader< JDAQSummaryslice >, JLANG::JAbstractAccessibleObjectReader< JHead_t >, JLANG::JAbstractAccessibleObjectReader< JTail_t >, JLANG::JAbstractAccessibleObjectReader< KM3NETDAQ::JDAQEvent >, JLANG::JAbstractAccessibleObjectWriter< T >, JLANG::JNullAccess, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JROOT::JRootInputFile, JROOT::JRootOutputFile, JROOT::JTreeReaderAccessibleObjectIterator< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JFileScanner< T >, JSUPPORT::JFileScanner< JDAQSummaryslice >, JSUPPORT::JFileScanner< JHead_t >, JSUPPORT::JFileScanner< JTail_t >, JSUPPORT::JFileScanner< KM3NETDAQ::JDAQEvent >, JSUPPORT::JTreeRecorder< T >, and JSUPPORT::JTreeRecorder< JDAQTimesliceTypes_t >.

◆ close() [2/2]

template<class T >

virtual void JLANG::JAbstractAccessibleObjectWriter< T >::close ( )

inlineoverridevirtualinherited

Close device.

Implements JLANG::JAccessible.

Definition at line 127 of file JAbstractObjectWriter.hh.

    {
      if (this->getHelper() != NULL) {
        this->getHelper()->close();
      }
    }

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

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

◆ getSharedPointer() [1/2]

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

inlineinherited

Get shared pointer.

Returns: this shared pointer

Definition at line 95 of file JSharedPointer.hh.

◆ getSharedPointer() [2/2]

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

inlineinherited

Get shared pointer.

Returns: this shared pointer

Definition at line 106 of file JSharedPointer.hh.

◆ setSharedPointer()

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

inlineinherited

Set shared pointer.

Parameters

object shared pointer

Definition at line 117 of file JSharedPointer.hh.

◆ reset() [1/3]

virtual void JLANG::JSharedPointer< JAccessibleObjectOutput< 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< JClass_t, JMemory_t >.

Definition at line 171 of file JSharedPointer.hh.

◆ reset() [2/3]

template<class JClass_t , template< class > class JMemory_t = JNew>

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

◆ set() [1/4]

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

inlineprotectedinherited

Set pointer.

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

Parameters

object shared pointer

Definition at line 188 of file JSharedPointer.hh.

◆ set() [2/4]

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

inlineoverrideprotectedvirtualinherited

Set pointer.

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

Parameters

p	pointer to derived class object

Definition at line 202 of file JSharedPointer.hh.

◆ set() [3/4]

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

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

◆ initialise()

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();
 
      counter = new int(1);
    }

◆ attach()

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

inlineinherited

Attach this counter to given shared counter object.

Parameters

object shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();
 
      counter = object.counter;
 
      if (counter != NULL) {
        ++(*counter);
      }
    }

◆ detach()

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns: true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {
 
        if (--(*counter) == 0) {
 
          delete counter;
 
          counter = NULL;
 
          return true;
        }
 
        counter = NULL;
      }
 
      return false;
    }

◆ getCount()

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns: count

Definition at line 88 of file JSharedCounter.hh.

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

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

    {
      if (!this->is_valid()) {
        this->set(memory_type::create());
      }
    }

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

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

◆ 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

size	number of elements

Definition at line 81 of file JStorage.hh.

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

◆ release()

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.

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

◆ 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< T >, and JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >.

Definition at line 64 of file JPointer.hh.

    {
      return this->__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();
    }

Friends And Related Symbol Documentation

◆ operator>>

template<class T >

std::istream & operator>>	(	std::istream &	in,
		JFileRecorder< T > &	recorder )

friend

Read file recorder from input.

Parameters

in	input stream
recorder	JFileRecorder

Returns: input stream

Definition at line 152 of file JFileRecorder.hh.

    {
      in >> recorder.fileName;
 
      return in;
    }

◆ operator<<

template<class T >

std::ostream & operator<<	(	std::ostream &	out,
		const JFileRecorder< T > &	recorder )

friend

Write file recorder to output.

Parameters

out	output stream
recorder	JFileRecorder

Returns: output stream

Definition at line 167 of file JFileRecorder.hh.

    {
      out << recorder.fileName;
 
      return out;
    }

Member Data Documentation

◆ fileName

template<class T >

std::string JSUPPORT::JFileRecorder< T >::fileName

protected

Definition at line 175 of file JFileRecorder.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.

◆ counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.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:

JFileRecorder.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ helper_type

◆ pointer_type

◆ storage_type

◆ memory_type

Constructor & Destructor Documentation

◆ JFileRecorder() [1/2]

◆ JFileRecorder() [2/2]

Member Function Documentation

◆ getFilename()

◆ setFilename()

◆ open() [1/2]

◆ open() [2/2]

◆ getHelper()

◆ put() [1/2]

◆ put() [2/2]

◆ is_open() [1/2]

◆ is_open() [2/2]

◆ close() [1/2]

◆ close() [2/2]

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ getSharedPointer() [1/2]

◆ getSharedPointer() [2/2]

◆ setSharedPointer()

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ initialise()

◆ attach()

◆ detach()

◆ getCount()

◆ recreate()

◆ create() [1/2]

◆ create() [2/2]

◆ release()

◆ get()

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator JClass_t *()

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ fileName

◆ do_throw

◆ counter

◆ __p