JSUPPORT::JFileRecorder< T > Class Template Reference

Object writing to file. More...

#include <JFileRecorder.hh>

Inheritance diagram for JSUPPORT::JFileRecorder< T >:

Public Types
typedef std::shared_ptr< JAccessibleObjectOutput< T > >	helper_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) override
	Object output.
virtual bool	is_open () const override
	Check is device is open.
virtual void	close () override
	Close device.

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 Attributes
std::string	fileName

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 >

std::shared_ptr< JAccessibleObjectOutput<T> > JLANG::JAccessibleObjectWriter< T >::helper_type

inherited

Definition at line 65 of file JObjectWriter.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->get() != NULL) {
        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 79 of file JObjectWriter.hh.

    {
      return this->get();
    }

put()

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

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

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.

    {
      do_throw = option;
    }

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.

    {
      using namespace std;
      
      if (do_throw) {
        throw error;
      }
 
      cerr << error.what() << endl;
      
      return value;
    }

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.

---

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

• JFileRecorder.hh