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

#include <JBinaryFileWriter.hh>

Inheritance diagram for JIO::JBinaryFileWriter< T >:

Public Member Functions
	JBinaryFileWriter ()
	Default constructor.

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

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

virtual void	open (const char *file_name)=0
	Open device.

virtual void	close ()=0
	Close device.

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

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

virtual void	close ()
	Close file.

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
virtual bool	getStatus () const override
	Status of writer.

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

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

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 &	operator<< (const JLANG::JStatus &value)

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

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

	operator bool () const
	Type conversion operator.

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

Protected Attributes
std::ostream &	out

Static Protected Attributes
static bool	do_throw
	throw option

Detailed Description

template<class T>
class JIO::JBinaryFileWriter< T >

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

This class implements the JLANG::JAccessibleObjectOutput interface.

Definition at line 153 of file JBinaryFileWriter.hh.

Constructor & Destructor Documentation

◆ JBinaryFileWriter()

template<class T >

JIO::JBinaryFileWriter< T >::JBinaryFileWriter ( )

inline

Default constructor.

Definition at line 163 of file JBinaryFileWriter.hh.

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

Member Function Documentation

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

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

◆ open() [1/2]

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

pure virtualinherited

Open device.

Parameters

file_name file name

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::JAccessibleBinaryInputStream, JLANG::JAccessibleBinaryOutputStream, JLANG::JGZFileReader< T >, JLANG::JGZFileWriter< T >, JROOT::JRootInputFile, JROOT::JRootOutputFile, JROOT::JRootFileReader< T, false >, JROOT::JRootFileReader< T, true >, JROOT::JRootFileWriter< T >, JROOT::JTreeReaderAccessibleObjectIterator< T >, JSUPPORT::JAutoTreeWriter< JKey_t >, JSUPPORT::JAutoTreeWriter< JNET::JTag >, JSUPPORT::JFileRecorder< T >, 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() [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 >.

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

◆ open() [2/2]

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

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

virtual void JLANG::JAccessibleOutputStream::close ( )

inlinevirtualinherited

Close file.

Implements JLANG::JAccessible.

Definition at line 142 of file JAccessibleStream.hh.

    {
      std::ofstream::close();
    }

◆ 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/17]

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

inlineinherited

Write serialisable data object.

Parameters

object serialisable data object

Returns: JWriter

Definition at line 146 of file JSerialisable.hh.

    { 
      return object.write(*this); 
    }

◆ operator<<() [2/17]

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

inlineinherited

Definition at line 152 of file JSerialisable.hh.

152{ 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/17]

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

inlineinherited

Definition at line 153 of file JSerialisable.hh.

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

◆ operator<<() [4/17]

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

inlineinherited

Definition at line 154 of file JSerialisable.hh.

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

◆ operator<<() [5/17]

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

inlineinherited

Definition at line 155 of file JSerialisable.hh.

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

◆ operator<<() [6/17]

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

inlineinherited

Definition at line 156 of file JSerialisable.hh.

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

◆ operator<<() [7/17]

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

inlineinherited

Definition at line 157 of file JSerialisable.hh.

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

◆ operator<<() [8/17]

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

inlineinherited

Definition at line 158 of file JSerialisable.hh.

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

◆ operator<<() [9/17]

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

inlineinherited

Definition at line 159 of file JSerialisable.hh.

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

◆ operator<<() [10/17]

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

inlineinherited

Definition at line 160 of file JSerialisable.hh.

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

◆ operator<<() [11/17]

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

inlineinherited

Definition at line 161 of file JSerialisable.hh.

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

◆ operator<<() [12/17]

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

inlineinherited

Definition at line 162 of file JSerialisable.hh.

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

◆ operator<<() [13/17]

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

inlineinherited

Definition at line 163 of file JSerialisable.hh.

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

◆ operator<<() [14/17]

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

inlineinherited

Definition at line 164 of file JSerialisable.hh.

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

◆ operator<<() [15/17]

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

inlineinherited

Definition at line 165 of file JSerialisable.hh.

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

◆ operator<<() [16/17]

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

inlineinherited

Definition at line 166 of file JSerialisable.hh.

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

JLANG::JObjectID::getID

int getID() const

Get identifier.

Definition JObjectID.hh:50

◆ operator<<() [17/17]

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

inlineinherited

Definition at line 167 of file JSerialisable.hh.

167{ return (*this) << value.getStatus<JLANG::JStatus::status_type>(); }

JOSCPROB::JOscProbInterpolator

Template definition of a multi-dimensional oscillation probability interpolation table.

Definition JOscProbInterpolator.hh:71

JLANG::JStatus::getStatus

status_type getStatus(const JType< status_type > &type) const

Get status.

Definition JStatus.hh:60

◆ store() [1/2]

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

inlineinherited

Write object.

Parameters

object object

Returns: this writer

Definition at line 176 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 189 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());
    }

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:

JBinaryFileWriter.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JBinaryFileWriter()

Member Function Documentation

◆ put()

◆ is_open() [1/2]

◆ open() [1/2]

◆ close() [1/2]

◆ Throw() [1/2]

◆ Throw() [2/2]

◆ open() [2/2]

◆ is_open() [2/2]

◆ close() [2/2]

◆ getStatus()

◆ write()

◆ operator<<() [1/17]

◆ operator<<() [2/17]

◆ operator<<() [3/17]

◆ operator<<() [4/17]

◆ operator<<() [5/17]

◆ operator<<() [6/17]

◆ operator<<() [7/17]

◆ operator<<() [8/17]

◆ operator<<() [9/17]

◆ operator<<() [10/17]

◆ operator<<() [11/17]

◆ operator<<() [12/17]

◆ operator<<() [13/17]

◆ operator<<() [14/17]

◆ operator<<() [15/17]

◆ operator<<() [16/17]

◆ operator<<() [17/17]

◆ store() [1/2]

◆ store() [2/2]

◆ operator bool()

◆ operator!()

Member Data Documentation

◆ do_throw

◆ out