Jpp
Public Member Functions | Protected Attributes | List of all members
JIO::JFileStreamWriter Class Reference

Binary buffered file output. More...

#include <JFileStreamIO.hh>

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

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...
 
bool operator! () const
 Negated status of this object. 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)
 
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...
 
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 & 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 72 of file JFileStreamIO.hh.

Constructor & Destructor Documentation

◆ JFileStreamWriter() [1/2]

JIO::JFileStreamWriter::JFileStreamWriter ( )
inline

Default constructor.

Definition at line 86 of file JFileStreamIO.hh.

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

◆ JFileStreamWriter() [2/2]

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

Constructor.

Parameters
file_namefile name
sizesize of internal buffer

Definition at line 98 of file JFileStreamIO.hh.

99  :
100  std::ofstream(),
101  JBufferedWriter(new JStreamWriter(static_cast<std::ofstream&>(*this)), size)
102  {
103  open(file_name);
104  }

Member Function Documentation

◆ open()

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

Open file.

Parameters
file_namefile name

Definition at line 112 of file JFileStreamIO.hh.

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

◆ close()

void JIO::JFileStreamWriter::close ( )
inline

Close file.

Definition at line 121 of file JFileStreamIO.hh.

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

◆ operator!() [1/2]

bool JLANG::JAbstractObjectStatus::operator!
inline

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  }

◆ operator<<() [1/30]

JWriter& JIO::JWriter::operator<<
inline

Write serialisable data object.

Parameters
objectserialisable data object
Returns
JWriter

Definition at line 142 of file JSerialisable.hh.

143  {
144  return object.write(*this);
145  }

◆ operator<<() [2/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 148 of file JSerialisable.hh.

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

◆ operator<<() [3/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 149 of file JSerialisable.hh.

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

◆ operator<<() [4/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 150 of file JSerialisable.hh.

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

◆ operator<<() [5/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 151 of file JSerialisable.hh.

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

◆ operator<<() [6/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 152 of file JSerialisable.hh.

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

◆ operator<<() [7/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 153 of file JSerialisable.hh.

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

◆ operator<<() [8/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 154 of file JSerialisable.hh.

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

◆ operator<<() [9/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 155 of file JSerialisable.hh.

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

◆ operator<<() [10/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 156 of file JSerialisable.hh.

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

◆ operator<<() [11/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 157 of file JSerialisable.hh.

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

◆ operator<<() [12/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 158 of file JSerialisable.hh.

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

◆ operator<<() [13/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 159 of file JSerialisable.hh.

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

◆ operator<<() [14/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 160 of file JSerialisable.hh.

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

◆ operator<<() [15/30]

JWriter& JIO::JWriter::operator<<
inline

Definition at line 161 of file JSerialisable.hh.

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

◆ getStatus()

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

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  }

◆ write()

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

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  }

◆ flush()

void JIO::JBufferedWriter::flush ( )
inlineinherited

Write internal data to output.

Definition at line 216 of file JBufferedIO.hh.

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

◆ operator<<() [16/30]

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

Write serialisable data object.

Parameters
objectserialisable data object
Returns
JWriter

Definition at line 142 of file JSerialisable.hh.

143  {
144  return object.write(*this);
145  }

◆ operator<<() [17/30]

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

Definition at line 148 of file JSerialisable.hh.

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

◆ operator<<() [18/30]

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

Definition at line 149 of file JSerialisable.hh.

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

◆ operator<<() [19/30]

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

Definition at line 150 of file JSerialisable.hh.

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

◆ operator<<() [20/30]

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

Definition at line 151 of file JSerialisable.hh.

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

◆ operator<<() [21/30]

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

Definition at line 152 of file JSerialisable.hh.

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

◆ operator<<() [22/30]

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

Definition at line 153 of file JSerialisable.hh.

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

◆ operator<<() [23/30]

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

Definition at line 154 of file JSerialisable.hh.

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

◆ operator<<() [24/30]

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

Definition at line 155 of file JSerialisable.hh.

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

◆ operator<<() [25/30]

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

Definition at line 156 of file JSerialisable.hh.

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

◆ operator<<() [26/30]

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

Definition at line 157 of file JSerialisable.hh.

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

◆ operator<<() [27/30]

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

Definition at line 158 of file JSerialisable.hh.

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

◆ operator<<() [28/30]

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

Definition at line 159 of file JSerialisable.hh.

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

◆ operator<<() [29/30]

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

Definition at line 160 of file JSerialisable.hh.

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

◆ operator<<() [30/30]

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

Definition at line 161 of file JSerialisable.hh.

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

◆ store() [1/2]

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

Write object.

Parameters
objectobject
Returns
this writer

Definition at line 170 of file JSerialisable.hh.

171  {
172  return object.write(*this);
173  }

◆ store() [2/2]

template<class T >
JWriter& JIO::JWriter::store ( const T &  object)
inlineinherited

Write object.

Parameters
objectobject
Returns
this writer

Definition at line 183 of file JSerialisable.hh.

184  {
185  return *this << object;
186  }

◆ operator bool()

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  }

◆ operator!() [2/2]

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  }

Member Data Documentation

◆ out

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

Definition at line 223 of file JBufferedIO.hh.

◆ buffer

char* JIO::JBufferedWriter::buffer
protectedinherited

internal buffer

Definition at line 225 of file JBufferedIO.hh.

◆ size

int JIO::JBufferedWriter::size
protectedinherited

size of internal buffer

Definition at line 226 of file JBufferedIO.hh.

◆ pos

int JIO::JBufferedWriter::pos
protectedinherited

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:
JIO::JStreamWriter
Binary output based on std::ostream.
Definition: JStreamIO.hh:81
JIO::JBufferedWriter::buffer
char * buffer
internal buffer
Definition: JBufferedIO.hh:225
JIO::JBufferedWriter::size
int size
size of internal buffer
Definition: JBufferedIO.hh:226
JIO::JBufferedWriter::write
virtual int write(const char *zbuf, int n)
Write byte array.
Definition: JBufferedIO.hh:188
JTOOLS::n
const int n
Definition: JPolint.hh:628
JLANG::JBinaryOutput::write
virtual int write(const char *buffer, const int length)=0
Write byte array.
JIO::JBufferedWriter::JBufferedWriter
JBufferedWriter(JWriter *__out, const int __size=1048576)
Constructor.
Definition: JBufferedIO.hh:149
JIO::JBufferedWriter::getStatus
virtual bool getStatus() const
Status of writer.
Definition: JBufferedIO.hh:175
JIO::JBufferedWriter::out
JLANG::JSinglePointer< JWriter > out
Definition: JBufferedIO.hh:223
JIO::JBufferedWriter::pos
int pos
pointer to end of buffered data
Definition: JBufferedIO.hh:227
JIO::JBufferedWriter::flush
void flush()
Write internal data to output.
Definition: JBufferedIO.hh:216
JIO::JFileStreamWriter::open
void open(const char *file_name)
Open file.
Definition: JFileStreamIO.hh:112
JLANG::JAbstractObjectStatus::getStatus
virtual bool getStatus() const =0
Get status of object.
Generated by   doxygen 1.8.16