Binary buffered file output. More...

#include <JFileStreamIO.hh>

Inheritance diagram for JIO::JFileStreamWriter:

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

	JFileStreamWriter (const char *file_name, const int size=1048576)
	Constructor. More...

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

void	close ()
	Close file. More...

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

virtual int	write (const char *zbuf, int n) override
	Write byte array. More...

void	flush ()
	Write internal data to output. 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...

Protected Attributes
JLANG::JSinglePointer< JWriter >	out

char *	buffer
	internal buffer More...

int	size
	size of internal buffer More...

int	pos
	pointer to end of buffered data More...

Detailed Description

Binary buffered file output.

Definition at line 93 of file JFileStreamIO.hh.

Constructor & Destructor Documentation

JIO::JFileStreamWriter::JFileStreamWriter ( )

inline

Default constructor.

Definition at line 107 of file JFileStreamIO.hh.

                         :
       std::ofstream(),
       JBufferedWriter(new JStreamWriter(static_cast<std::ofstream&>(*this)))
     {}

JIO::JFileStreamWriter::JFileStreamWriter	(	const char *	file_name,
		const int	size = `1048576`
	)

inline

Constructor.

Parameters

file_name	file name
size	size of internal buffer

Definition at line 119 of file JFileStreamIO.hh.

                                                   :
       std::ofstream(),
       JBufferedWriter(new JStreamWriter(static_cast<std::ofstream&>(*this)), size)
     {
       open(file_name);
     }

Member Function Documentation

void JIO::JFileStreamWriter::open ( const char * file_name )

inline

Open file.

Parameters

file_name file name

Definition at line 133 of file JFileStreamIO.hh.

     {
       static_cast<std::ofstream*>(this)->open(file_name, std::ios::binary);
     }

void JIO::JFileStreamWriter::close ( )

inline

Close file.

Definition at line 142 of file JFileStreamIO.hh.

     {
       static_cast<JBufferedWriter*>(this)->flush();
       static_cast<std::ofstream*>  (this)->close();
     }

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

inlineoverridevirtualinherited

Status of writer.

Returns: status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 182 of file JBufferedIO.hh.

     { 
       return (bool) *out;
     }

virtual int JIO::JBufferedWriter::write	(	const char *	zbuf,
		int	n
	)

inlineoverridevirtualinherited

Write byte array.

Parameters

zbuf	pointer to byte array
n	number of bytes

Returns: number of bytes

Implements JLANG::JBinaryOutput.

Definition at line 195 of file JBufferedIO.hh.

     { 
       for (int i = 0; i != n; ) {
 
         int m = n - i;
 
         if (m > size - pos) {
 
           flush();
         
           if (m > size - pos) {
             m = size - pos;
           }
         }
 
         memcpy(buffer + pos, zbuf + i, m);
         
         i   += m;
         pos += m;
       }
 
       return n;
     }

void JIO::JBufferedWriter::flush ( )

inlineinherited

Write internal data to output.

Definition at line 223 of file JBufferedIO.hh.

     {
       pos -= out->write(buffer, pos); 
     }

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

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.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

JLANG::JBinaryOutput::write

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

Write byte array.

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

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

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

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

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

JLANG::JSinglePointer<JWriter> JIO::JBufferedWriter::out

protectedinherited

Definition at line 230 of file JBufferedIO.hh.

char* JIO::JBufferedWriter::buffer

protectedinherited

internal buffer

Definition at line 232 of file JBufferedIO.hh.

int JIO::JBufferedWriter::size

protectedinherited

size of internal buffer

Definition at line 233 of file JBufferedIO.hh.

int JIO::JBufferedWriter::pos

protectedinherited

pointer to end of buffered data

Definition at line 234 of file JBufferedIO.hh.

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

JFileStreamIO.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation