Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
JIO::JBufferedWriter Class Reference

Buffered binary output. More...

#include <JBufferedIO.hh>

Inheritance diagram for JIO::JBufferedWriter:
JIO::JWriter JLANG::JBinaryOutput JLANG::JAbstractObjectStatus JIO::JFileStreamWriter

Public Member Functions

 JBufferedWriter (JWriter *__out, const int __size=1048576)
 Constructor. More...
 
 ~JBufferedWriter ()
 Destructor. More...
 
virtual bool getStatus () const
 Status of writer. More...
 
virtual int write (const char *zbuf, int n)
 Write byte array. More...
 
void flush ()
 Write internal data to output. More...
 
JWriteroperator<< (const JSerialisable &object)
 Write serialisable data object. More...
 
JWriteroperator<< (const bool &value)
 
JWriteroperator<< (const char &value)
 
JWriteroperator<< (const unsigned char &value)
 
JWriteroperator<< (const short &value)
 
JWriteroperator<< (const unsigned short &value)
 
JWriteroperator<< (const int &value)
 
JWriteroperator<< (const unsigned int &value)
 
JWriteroperator<< (const long int &value)
 
JWriteroperator<< (const long long int &value)
 
JWriteroperator<< (const unsigned long long int &value)
 
JWriteroperator<< (const float &value)
 
JWriteroperator<< (const double &value)
 
JWriteroperator<< (const long double &value)
 
JWriterstore (const JSerialisable &object)
 Write object. More...
 
template<class T >
JWriterstore (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< JWriterout
 
char * buffer
 internal buffer More...
 
int size
 size of internal buffer More...
 
int pos
 pointer to end of buffered data More...
 

Detailed Description

Buffered binary output.

This class implements the JWriter interface.

Definition at line 138 of file JBufferedIO.hh.

Constructor & Destructor Documentation

JIO::JBufferedWriter::JBufferedWriter ( JWriter __out,
const int  __size = 1048576 
)
inline

Constructor.

Note that this object owns the writer pointed to.

Parameters
__outpointer to writer
__sizesize of internal buffer

Definition at line 149 of file JBufferedIO.hh.

149  :
150  out(__out)
151  {
152  size = std::max(__size, 1024);
153  buffer = new char[size];
154 
155  pos = 0;
156  }
int pos
pointer to end of buffered data
Definition: JBufferedIO.hh:227
JLANG::JSinglePointer< JWriter > out
Definition: JBufferedIO.hh:223
int size
size of internal buffer
Definition: JBufferedIO.hh:226
char * buffer
internal buffer
Definition: JBufferedIO.hh:225
JIO::JBufferedWriter::~JBufferedWriter ( )
inline

Destructor.

Definition at line 162 of file JBufferedIO.hh.

163  {
164  flush();
165 
166  delete [] buffer;
167  }
char * buffer
internal buffer
Definition: JBufferedIO.hh:225
void flush()
Write internal data to output.
Definition: JBufferedIO.hh:216

Member Function Documentation

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

Status of writer.

Returns
status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 175 of file JBufferedIO.hh.

176  {
177  return (bool) *out;
178  }
JLANG::JSinglePointer< JWriter > out
Definition: JBufferedIO.hh:223
virtual int JIO::JBufferedWriter::write ( const char *  zbuf,
int  n 
)
inlinevirtual

Write byte array.

Parameters
zbufpointer to byte array
nnumber of bytes
Returns
number of bytes

Implements JLANG::JBinaryOutput.

Definition at line 188 of file JBufferedIO.hh.

189  {
190  for (int i = 0; i != n; ) {
191 
192  int m = n - i;
193 
194  if (m > size - pos) {
195 
196  flush();
197 
198  if (m > size - pos) {
199  m = size - pos;
200  }
201  }
202 
203  memcpy(buffer + pos, zbuf + i, m);
204 
205  i += m;
206  pos += m;
207  }
208 
209  return n;
210  }
int pos
pointer to end of buffered data
Definition: JBufferedIO.hh:227
int size
size of internal buffer
Definition: JBufferedIO.hh:226
char * buffer
internal buffer
Definition: JBufferedIO.hh:225
void flush()
Write internal data to output.
Definition: JBufferedIO.hh:216
void JIO::JBufferedWriter::flush ( )
inline

Write internal data to output.

Definition at line 216 of file JBufferedIO.hh.

217  {
218  pos -= out->write(buffer, pos);
219  }
int pos
pointer to end of buffered data
Definition: JBufferedIO.hh:227
JLANG::JSinglePointer< JWriter > out
Definition: JBufferedIO.hh:223
char * buffer
internal buffer
Definition: JBufferedIO.hh:225
JWriter& JIO::JWriter::operator<< ( const JSerialisable object)
inlineinherited

Write serialisable data object.

Parameters
objectserialisable data object
Returns
JWriter

Definition at line 141 of file JSerialisable.hh.

142  {
143  return object.write(*this);
144  }
JWriter& JIO::JWriter::operator<< ( const bool &  value)
inlineinherited

Definition at line 147 of file JSerialisable.hh.

147 { write((const char*) &value, sizeof(bool)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.
JWriter& JIO::JWriter::operator<< ( const char &  value)
inlineinherited

Definition at line 148 of file JSerialisable.hh.

148 { write((const char*) &value, sizeof(char)); return *this; }
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 149 of file JSerialisable.hh.

149 { write((const char*) &value, sizeof(unsigned char)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.
JWriter& JIO::JWriter::operator<< ( const short &  value)
inlineinherited

Definition at line 150 of file JSerialisable.hh.

150 { write((const char*) &value, sizeof(short)); return *this; }
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 151 of file JSerialisable.hh.

151 { write((const char*) &value, sizeof(unsigned short)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.
JWriter& JIO::JWriter::operator<< ( const int &  value)
inlineinherited

Definition at line 152 of file JSerialisable.hh.

152 { write((const char*) &value, sizeof(int)); return *this; }
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 153 of file JSerialisable.hh.

153 { write((const char*) &value, sizeof(unsigned int)); return *this; }
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 154 of file JSerialisable.hh.

154 { write((const char*) &value, sizeof(long int)); return *this; }
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 155 of file JSerialisable.hh.

155 { write((const char*) &value, sizeof(long long int)); return *this; }
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 156 of file JSerialisable.hh.

156 { write((const char*) &value, sizeof(unsigned long long int)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.
JWriter& JIO::JWriter::operator<< ( const float &  value)
inlineinherited

Definition at line 157 of file JSerialisable.hh.

157 { write((const char*) &value, sizeof(float)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.
JWriter& JIO::JWriter::operator<< ( const double &  value)
inlineinherited

Definition at line 158 of file JSerialisable.hh.

158 { write((const char*) &value, sizeof(double)); return *this; }
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 159 of file JSerialisable.hh.

159 { write((const char*) &value, sizeof(long double)); return *this; }
virtual int write(const char *buffer, const int length)=0
Write byte array.
JWriter& JIO::JWriter::store ( const JSerialisable object)
inlineinherited

Write object.

Parameters
objectobject
Returns
this writer

Definition at line 168 of file JSerialisable.hh.

169  {
170  return object.write(*this);
171  }
template<class T >
JWriter& JIO::JWriter::store ( const T &  object)
inlineinherited

Write object.

Parameters
objectobject
Returns
this writer

Definition at line 181 of file JSerialisable.hh.

182  {
183  return *this << object;
184  }
JLANG::JAbstractObjectStatus::operator bool ( ) const
inlineinherited

Type conversion operator.

Returns
status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

34  {
35  return this->getStatus();
36  }
virtual bool getStatus() const =0
Get status of object.
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.

45  {
46  return !(this->getStatus());
47  }
virtual bool getStatus() const =0
Get status of object.

Member Data Documentation

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

Definition at line 223 of file JBufferedIO.hh.

char* JIO::JBufferedWriter::buffer
protected

internal buffer

Definition at line 225 of file JBufferedIO.hh.

int JIO::JBufferedWriter::size
protected

size of internal buffer

Definition at line 226 of file JBufferedIO.hh.

int JIO::JBufferedWriter::pos
protected

pointer to end of buffered data

Definition at line 227 of file JBufferedIO.hh.


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