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

Binary output based on std::ostream. More...

#include <JStreamIO.hh>

Inheritance diagram for JIO::JStreamWriter:
JIO::JWriter JLANG::JBinaryOutput JLANG::JAbstractObjectStatus JIO::JBinaryFileWriter< JPhotonPath > JIO::JBinaryFileWriter< T > JSUPPORT::JDAQFileWriter< T > JMARKOV::JPhotonPathWriter

Public Member Functions

 JStreamWriter (std::ostream &__out)
 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 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

std::ostream & out
 

Detailed Description

Binary output based on std::ostream.

This class implements the JWriter interface.

Definition at line 81 of file JStreamIO.hh.

Constructor & Destructor Documentation

◆ JStreamWriter()

JIO::JStreamWriter::JStreamWriter ( std::ostream &  __out)
inline

Constructor.

Parameters
__outoutput stream

Definition at line 90 of file JStreamIO.hh.

90  :
91  out(__out)
92  {}

Member Function Documentation

◆ getStatus()

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

Status of writer.

Returns
status of this writer

Implements JLANG::JAbstractObjectStatus.

Definition at line 100 of file JStreamIO.hh.

101  {
102  return (bool) out;
103  }

◆ write()

virtual int JIO::JStreamWriter::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 113 of file JStreamIO.hh.

114  {
115  out.write(buffer, length);
116 
117  return length;
118  }

◆ operator<<() [1/14]

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  }

◆ operator<<() [2/14]

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

◆ operator<<() [3/14]

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

◆ operator<<() [4/14]

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

◆ operator<<() [5/14]

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

◆ operator<<() [6/14]

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

◆ operator<<() [7/14]

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

◆ operator<<() [8/14]

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

◆ operator<<() [9/14]

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

◆ operator<<() [10/14]

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

◆ operator<<() [11/14]

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

◆ operator<<() [12/14]

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

◆ operator<<() [13/14]

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

◆ operator<<() [14/14]

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

◆ store() [1/2]

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  }

◆ store() [2/2]

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  }

◆ 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

std::ostream& JIO::JStreamWriter::out
protected

Definition at line 121 of file JStreamIO.hh.


The documentation for this class was generated from the following file:
JIO::JStreamWriter::out
std::ostream & out
Definition: JStreamIO.hh:121
JLANG::JBinaryOutput::write
virtual int write(const char *buffer, const int length)=0
Write byte array.
JLANG::JAbstractObjectStatus::getStatus
virtual bool getStatus() const =0
Get status of object.