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

Binary output based on a file descriptor. More...

#include <JFileIO.hh>

Inheritance diagram for JIO::JFileWriter:
JIO::JWriter JLANG::JBinaryOutput JLANG::JAbstractObjectStatus

Public Member Functions

 JFileWriter (const JFile &file)
 Constructor. More...
 
virtual bool getStatus () const
 Status of writer. More...
 
virtual int write (const char *buffer, const int length)
 Write byte array. 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 unsigned 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

JFile out
 

Detailed Description

Binary output based on a file descriptor.

This class implements the JWriter interface.

Definition at line 72 of file JFileIO.hh.

Constructor & Destructor Documentation

◆ JFileWriter()

JIO::JFileWriter::JFileWriter ( const JFile file)
inline

Constructor.

Parameters
filefile

Definition at line 81 of file JFileIO.hh.

81  :
82  out(file)
83  {}

Member Function Documentation

◆ getStatus()

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

Status of writer.

Returns
status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 91 of file JFileIO.hh.

92  {
93  return out.good();
94  }

◆ write()

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

Write byte array.

Parameters
bufferpointer to byte array
lengthnumber of bytes
Returns
number of bytes written

Implements JLANG::JBinaryOutput.

Definition at line 104 of file JFileIO.hh.

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

◆ operator<<() [1/15]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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!()

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

JFile JIO::JFileWriter::out
protected

Definition at line 110 of file JFileIO.hh.


The documentation for this class was generated from the following file:
JLANG::JFile::good
virtual bool good() const
Check status.
Definition: JFile.hh:124
JIO::JFileWriter::out
JFile out
Definition: JFileIO.hh:110
JLANG::JBinaryOutput::write
virtual int write(const char *buffer, const int length)=0
Write byte array.
JLANG::JFile::write
virtual int write(const char *buffer, const int length)
Write data to file.
Definition: JFile.hh:87
JLANG::JAbstractObjectStatus::getStatus
virtual bool getStatus() const =0
Get status of object.