Object(s) writing to binary file (i.e. .dat). More...

#include <JDAQFileWriter.hh>

Inheritance diagram for JSUPPORT::JDAQFileWriter< T >:

Public Member Functions
	JDAQFileWriter ()
	Default constructor. More...

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

virtual bool	is_open () const
	Check is file is open. More...

virtual void	close ()
	Close file. More...

virtual bool	getStatus () const override
	Status of writer. More...

virtual int	write (const char *buffer, const int length) override
	Write byte array. More...

JWriter &	operator<< (const JSerialisable &object)
	Write serialisable data object. More...

JWriter &	operator<< (const bool value)

JWriter &	operator<< (const char value)

JWriter &	operator<< (const unsigned char value)

JWriter &	operator<< (const short value)

JWriter &	operator<< (const unsigned short value)

JWriter &	operator<< (const int value)

JWriter &	operator<< (const unsigned int value)

JWriter &	operator<< (const long int value)

JWriter &	operator<< (const unsigned long int value)

JWriter &	operator<< (const long long int value)

JWriter &	operator<< (const unsigned long long int value)

JWriter &	operator<< (const float value)

JWriter &	operator<< (const double value)

JWriter &	operator<< (const long double value)

JWriter &	operator<< (const JLANG::JObjectID &value)

JWriter &	store (const JSerialisable &object)
	Write object. More...

template<class T >
JWriter &	store (const T &object)
	Write object. More...

	operator bool () const
	Type conversion operator. More...

bool	operator! () const
	Negated status of this object. More...

virtual bool	put (const T &object)=0
	Object output. 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...

Protected Attributes
std::ostream &	out

Static Protected Attributes
static bool	do_throw
	throw option More...

Detailed Description

template<class T>
class JSUPPORT::JDAQFileWriter< T >

Object(s) writing to binary file (i.e. .dat).

This class implements the JLANG::JAccessibleObjectOutput interface.

Definition at line 160 of file JDAQFileWriter.hh.

Constructor & Destructor Documentation

◆ JDAQFileWriter()

template<class T >

JSUPPORT::JDAQFileWriter< T >::JDAQFileWriter ( )

inline

Default constructor.

Definition at line 170 of file JDAQFileWriter.hh.

                      :
       JAccessibleBinaryOutputStream(),
       JStreamWriter(static_cast<std::ostream&>(*this)),
       JDAQWriter<T>(static_cast<JWriter&>     (*this))
     {}

Member Function Documentation

◆ open()

virtual void JLANG::JAccessibleBinaryOutputStream::open ( const char * file_name )

inlineoverridevirtualinherited

Open file.

Parameters

file_name file name

Reimplemented from JLANG::JAccessibleOutputStream.

Definition at line 92 of file JAccessibleBinaryStream.hh.

     {
       std::ofstream::open(file_name, std::ios::binary);
     }

◆ is_open()

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

inlinevirtualinherited

Check is file is open.

Returns: true if open; else false

Implements JLANG::JAccessible.

Definition at line 118 of file JAccessibleStream.hh.

     {
       return std::ofstream::is_open();
     }

◆ close()

virtual void JLANG::JAccessibleOutputStream::close ( )

inlinevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 142 of file JAccessibleStream.hh.

     {
       std::ofstream::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;
     }

◆ getStatus()

virtual bool JIO::JStreamWriter::getStatus ( ) const

inlineoverridevirtualinherited

Status of writer.

Returns: status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 100 of file JStreamIO.hh.

     { 
       return (bool) out; 
     }

◆ write()

virtual int JIO::JStreamWriter::write	(	const char *	buffer,
		const int	length
	)

inlineoverridevirtualinherited

Write byte array.

Parameters

buffer	pointer to byte array
length	number of bytes

Returns: number of bytes written

Implements JLANG::JBinaryOutput.

Definition at line 113 of file JStreamIO.hh.

     { 
       out.write(buffer, length); 
  
       return length;
     }

◆ operator<<() [1/16]

JWriter& JIO::JWriter::operator<< ( const JSerialisable & object )

inlineinherited

Write serialisable data object.

Parameters

object serialisable data object

Returns: JWriter

Definition at line 144 of file JSerialisable.hh.

     { 
       return object.write(*this); 
     }

◆ operator<<() [2/16]

JWriter& JIO::JWriter::operator<< ( const bool value )

inlineinherited

Definition at line 150 of file JSerialisable.hh.

150 { write((const char*) &value, sizeof(bool)); return *this; }

JLANG::JBinaryOutput::write

virtual int write(const char *buffer, const int length)=0

Write byte array.

◆ operator<<() [3/16]

JWriter& JIO::JWriter::operator<< ( const char value )

inlineinherited

Definition at line 151 of file JSerialisable.hh.

151 { write((const char*) &value, sizeof(char)); return *this; }

◆ operator<<() [4/16]

JWriter& JIO::JWriter::operator<< ( const unsigned char value )

inlineinherited

Definition at line 152 of file JSerialisable.hh.

152 { write((const char*) &value, sizeof(unsigned char)); return *this; }

◆ operator<<() [5/16]

JWriter& JIO::JWriter::operator<< ( const short value )

inlineinherited

Definition at line 153 of file JSerialisable.hh.

153 { write((const char*) &value, sizeof(short)); return *this; }

◆ operator<<() [6/16]

JWriter& JIO::JWriter::operator<< ( const unsigned short value )

inlineinherited

Definition at line 154 of file JSerialisable.hh.

154 { write((const char*) &value, sizeof(unsigned short)); return *this; }

◆ operator<<() [7/16]

JWriter& JIO::JWriter::operator<< ( const int value )

inlineinherited

Definition at line 155 of file JSerialisable.hh.

155 { write((const char*) &value, sizeof(int)); return *this; }

◆ operator<<() [8/16]

JWriter& JIO::JWriter::operator<< ( const unsigned int value )

inlineinherited

Definition at line 156 of file JSerialisable.hh.

156 { write((const char*) &value, sizeof(unsigned int)); return *this; }

◆ operator<<() [9/16]

JWriter& JIO::JWriter::operator<< ( const long int value )

inlineinherited

Definition at line 157 of file JSerialisable.hh.

157 { write((const char*) &value, sizeof(long int)); return *this; }

◆ operator<<() [10/16]

JWriter& JIO::JWriter::operator<< ( const unsigned long int value )

inlineinherited

Definition at line 158 of file JSerialisable.hh.

158 { write((const char*) &value, sizeof(unsigned long int)); return *this; }

◆ operator<<() [11/16]

JWriter& JIO::JWriter::operator<< ( const long long int value )

inlineinherited

Definition at line 159 of file JSerialisable.hh.

159 { write((const char*) &value, sizeof(long long int)); return *this; }

◆ operator<<() [12/16]

JWriter& JIO::JWriter::operator<< ( const unsigned long long int value )

inlineinherited

Definition at line 160 of file JSerialisable.hh.

160 { write((const char*) &value, sizeof(unsigned long long int)); return *this; }

◆ operator<<() [13/16]

JWriter& JIO::JWriter::operator<< ( const float value )

inlineinherited

Definition at line 161 of file JSerialisable.hh.

161 { write((const char*) &value, sizeof(float)); return *this; }

◆ operator<<() [14/16]

JWriter& JIO::JWriter::operator<< ( const double value )

inlineinherited

Definition at line 162 of file JSerialisable.hh.

162 { write((const char*) &value, sizeof(double)); return *this; }

◆ operator<<() [15/16]

JWriter& JIO::JWriter::operator<< ( const long double value )

inlineinherited

Definition at line 163 of file JSerialisable.hh.

163 { write((const char*) &value, sizeof(long double)); return *this; }

◆ operator<<() [16/16]

JWriter& JIO::JWriter::operator<< ( const JLANG::JObjectID & value )

inlineinherited

Definition at line 164 of file JSerialisable.hh.

164 { return (*this) << value.getID(); }

JLANG::JObjectID::getID

int getID() const

Get identifier.

Definition: JObjectID.hh:50

◆ store() [1/2]

JWriter& JIO::JWriter::store ( const JSerialisable & object )

inlineinherited

Write object.

Parameters

object object

Returns: this writer

Definition at line 173 of file JSerialisable.hh.

     {
       return object.write(*this);
     }

◆ store() [2/2]

template<class T >

JWriter& JIO::JWriter::store ( const T & object )

inlineinherited

Write object.

Parameters

object object

Returns: this writer

Definition at line 186 of file JSerialisable.hh.

     {
       return *this << object;
     }

◆ operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const

inlineinherited

Type conversion operator.

Returns: status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

     {
       return this->getStatus();
     }

◆ operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const

inlineinherited

Negated status of this object.

Returns: negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

     {
       return !(this->getStatus());
     }

◆ put()

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 JROOT::JTreeWriterObjectOutput< T >, JROOT::JSonObjectOutput< T >, JROOT::JRootStreamObjectOutput< T >, JROOT::JRootObjectOutput< T, false >, JNET::JControlHostObjectOutput< T >, JLANG::JStreamObjectOutput< T >, JLANG::JNullOutput< T >, JLANG::JAbstractObjectWriter< T >, JIO::JWriterObjectOutput< T >, JNET::JControlHostObjectOutput< JTail_t >, JLANG::JStreamObjectOutput< JTail_t >, JLANG::JNullOutput< JTail_t >, JLANG::JAbstractObjectWriter< JTail_t >, JNET::JControlHostObjectOutput< JHead_t >, JLANG::JStreamObjectOutput< JHead_t >, JLANG::JNullOutput< JHead_t >, JLANG::JAbstractObjectWriter< JHead_t >, JLANG::JObjectDemultiplexer< JBase_t, JTypeList< JHead_t, JTail_t > >, JLANG::JObjectDemultiplexer< JBase_t, JDerived_t >, JLANG::JObjectDemultiplexer< JBase_t, JTail_t >, and JLANG::JObjectDemultiplexer< JBase_t, JHead_t >.

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.

◆ out

std::ostream& JIO::JStreamWriter::out

protectedinherited

Definition at line 121 of file JStreamIO.hh.

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

JDAQFileWriter.hh

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<class T> class JSUPPORT::JDAQFileWriter< T >

Constructor & Destructor Documentation

◆ JDAQFileWriter()

Member Function Documentation

◆ open()

◆ is_open()

◆ close()

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ getStatus()

◆ write()

◆ operator<<() [1/16]

◆ operator<<() [2/16]

◆ operator<<() [3/16]

◆ operator<<() [4/16]

◆ operator<<() [5/16]

◆ operator<<() [6/16]

◆ operator<<() [7/16]

◆ operator<<() [8/16]

◆ operator<<() [9/16]

◆ operator<<() [10/16]

◆ operator<<() [11/16]

◆ operator<<() [12/16]

◆ operator<<() [13/16]

◆ operator<<() [14/16]

◆ operator<<() [15/16]

◆ operator<<() [16/16]

◆ store() [1/2]

◆ store() [2/2]

◆ operator bool()

◆ operator!()

◆ put()

Member Data Documentation

◆ do_throw

◆ out

template<class T>
class JSUPPORT::JDAQFileWriter< T >