JIO Namespace Reference

Auxiliary classes and methods for binary I/O. More...

Classes
class	JBinaryFileReader
	Object reading from binary file (i.e. .jpp). More...
class	JBinaryFileReader< T, false >
	Template specialisation of JBinaryFileReader for unserialisable data types. More...
class	JBinaryFileReader< T, true >
	Template specialisation of JBinaryFileReader for serialisable data types. More...
class	JBinaryFileWriter
	Object(s) writing to binary file (i.e. .jpp). More...
class	JBinaryWriter
	Implementation of object output to binary file for single data type. More...
class	JBinaryWriter< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JBinaryWriter class. More...
class	JBinaryWriter< JTypeList< JHead_t, JTail_t > >
	Implementation of object output to binary file for multiple data types. More...
class	JBinaryWriterObjectOutput
	Auxiliary class for object writing to binary stream. More...
class	JBinaryWriterObjectOutput< T, false >
	Implementation of object output for binary stream incompatible data types. More...
class	JBinaryWriterObjectOutput< T, true >
	Implementation of object output for binary stream compatible data types. More...
class	JBufferedReader
	Buffered binary input. More...
class	JBufferedWriter
	Buffered binary output. More...
class	JByteArrayReader
	Byte array binary input. More...
class	JByteArrayWriter
	Byte array binary output. More...
class	JFileReader
	Binary input based on a file descriptor. More...
class	JFileStreamReader
	Binary buffered file input. More...
class	JFileStreamWriter
	Binary buffered file output. More...
class	JFileWriter
	Binary output based on a file descriptor. More...
struct	JObjectBinaryIO
	Auxiliary base class for storing and loading a single object to and from a binary file, respectively. More...
class	JReader
	Interface for binary input. More...
class	JReaderObjectIterator
	JReader object iterator. More...
class	JSerialisable
	Forward declaration of binary output. More...
class	JStreamReader
	Binary input based on std::istream. More...
class	JStreamWriter
	Binary output based on std::ostream. More...
class	JWriter
	Interface for binary output. More...
class	JWriterObjectOutput
	Implementation of object output using JIO::JWriter for single data type. More...
class	JWriterObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JWriterObjectOutput class. More...
class	JWriterObjectOutput< JTypeList< JHead_t, JTail_t > >
	Implementation of object output for multiple data types. More...

Functions
template<class T >
void	load (const char *file_name, T &object)
	Load object from input file.
template<class T >
void	store (const char *file_name, const T &object)
	Store object to output file.
JReader &	operator>> (JReader &in, std::string &object)
	Read template std::string from input.
JWriter &	operator<< (JWriter &out, const std::string &object)
	Write template std::string to output.
template<class JElement_t , class JAllocator_t >
JReader &	operator>> (JReader &in, std::vector< JElement_t, JAllocator_t > &object)
	Read template std::vector from input.
template<class JElement_t , class JAllocator_t >
JWriter &	operator<< (JWriter &out, const std::vector< JElement_t, JAllocator_t > &object)
	Write template std::vector to output.
template<class JElement_t , class JAllocator_t >
JReader &	operator>> (JReader &in, std::list< JElement_t, JAllocator_t > &object)
	Read template std::list from input.
template<class JElement_t , class JAllocator_t >
JWriter &	operator<< (JWriter &out, const std::list< JElement_t, JAllocator_t > &object)
	Write template std::list to output.
template<class JElement_t , class JComparator_t , class JAllocator_t >
JReader &	operator>> (JReader &in, std::set< JElement_t, JComparator_t, JAllocator_t > &object)
	Read template std::set from input.
template<class JElement_t , class JComparator_t , class JAllocator_t >
JWriter &	operator<< (JWriter &out, const std::set< JElement_t, JComparator_t, JAllocator_t > &object)
	Write template std::set to output.
template<class JElement_t , class JComparator_t , class JAllocator_t >
JReader &	operator>> (JReader &in, std::multiset< JElement_t, JComparator_t, JAllocator_t > &object)
	Read template std::multiset from input.
template<class JElement_t , class JComparator_t , class JAllocator_t >
JWriter &	operator<< (JWriter &out, const std::multiset< JElement_t, JComparator_t, JAllocator_t > &object)
	Write template std::multiset to output.
template<class JKey_t , class JValue_t >
JReader &	operator>> (JReader &in, std::pair< JKey_t, JValue_t > &object)
	Read template std::pair from input.
template<class JKey_t , class JValue_t >
JWriter &	operator<< (JWriter &out, const std::pair< JKey_t, JValue_t > &object)
	Write template std::pair to output.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
JReader &	operator>> (JReader &in, std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Read template std::map from input.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
JWriter &	operator<< (JWriter &out, const std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Write template std::map to output.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
JReader &	operator>> (JReader &in, std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Read template std::multimap from input.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
JWriter &	operator<< (JWriter &out, const std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Write template std::multimap to output.

Detailed Description

Auxiliary classes and methods for binary I/O.

Author

mdejong

Function Documentation

load()

template<class T >

void JIO::load ( const char * file_name, T & object )

inline

Load object from input file.

Parameters

file_name	file name
object	object to be read

Definition at line 30 of file JIOToolkit.hh.

  {
    JFileStreamReader in(file_name);
    
    if (!in) {
      THROW(JFileOpenException, "Error opening file " << file_name);
    }    
 
    in.load(object);
 
    if (!in) {
      THROW(JFileReadException, "Error reading file " << file_name);
    }
 
    in.close();
  }

store()

template<class T >

void JIO::store ( const char * file_name, const T & object )

inline

Store object to output file.

Parameters

file_name	file name
object	object to be written

Definition at line 55 of file JIOToolkit.hh.

  {
    JFileStreamWriter out(file_name);
 
    if (!out) {
      THROW(JFileOpenException, "Error opening file " << file_name);
    }    
 
    out.store(object);
    out.close();
  }

operator>>() [1/8]

JReader & JIO::operator>> ( JReader & in, std::string & object )

inline

Read template std::string from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 27 of file JSTDIO.hh.

  { 
    unsigned int n = 0;
 
    object.clear();
    
    in.read((char*) &n, sizeof(unsigned int));
    
    for (char c; n != 0; --n, object += c) {
      in.read(&c, sizeof(char));
    }
    
    return in; 
  }

operator<<() [1/8]

JWriter & JIO::operator<< ( JWriter & out, const std::string & object )

inline

Write template std::string to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 50 of file JSTDIO.hh.

  { 
    unsigned int n = object.size();
    
    out.write((const char*) &n, sizeof(unsigned int));
    out.write((const char*) object.c_str(), n);
    
    return out;
  }

operator>>() [2/8]

template<class JElement_t , class JAllocator_t >

JReader & JIO::operator>> ( JReader & in, std::vector< JElement_t, JAllocator_t > & object )

inline

Read template std::vector from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 69 of file JSTDIO.hh.

  {
    int n = 0;
 
    in >> n;
 
    object.resize(n);
    
    for (typename std::vector<JElement_t, JAllocator_t>::iterator i = object.begin(); i != object.end(); ++i) {
      in >> *i;
    }
    
    return in;
  }

operator<<() [2/8]

template<class JElement_t , class JAllocator_t >

JWriter & JIO::operator<< ( JWriter & out, const std::vector< JElement_t, JAllocator_t > & object )

inline

Write template std::vector to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 93 of file JSTDIO.hh.

  {
    int n = object.size();
    
    out << n;
    
    for (typename std::vector<JElement_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      out << *i;
    }
   
    return out;
  }

operator>>() [3/8]

template<class JElement_t , class JAllocator_t >

JReader & JIO::operator>> ( JReader & in, std::list< JElement_t, JAllocator_t > & object )

inline

Read template std::list from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 115 of file JSTDIO.hh.

  {
    int n = 0;
 
    in >> n;
 
    typename std::list<JElement_t, JAllocator_t>::value_type element;
    
    object.clear();
 
    for (int i = 0; i != n; ++i) {
      
      in >> element;
      
      object.push_back(element);
    }
    
    return in;
  }

operator<<() [3/8]

template<class JElement_t , class JAllocator_t >

JWriter & JIO::operator<< ( JWriter & out, const std::list< JElement_t, JAllocator_t > & object )

inline

Write template std::list to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 144 of file JSTDIO.hh.

  {
    int n = object.size();
    
    out << n;
    
    for (typename std::list<JElement_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      out << *i;
    }
   
    return out;
  }

operator>>() [4/8]

template<class JElement_t , class JComparator_t , class JAllocator_t >

JReader & JIO::operator>> ( JReader & in, std::set< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Read template std::set from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 166 of file JSTDIO.hh.

  {
    int n = 0;
    
    in >> n;
    
    typename std::set<JElement_t, JComparator_t, JAllocator_t>::value_type element;
    
    object.clear();
 
    for (int i = 0; i != n; ++i) {
      
      in >> element;
      
      object.insert(element);
    }
 
    return in;
  }

operator<<() [4/8]

template<class JElement_t , class JComparator_t , class JAllocator_t >

JWriter & JIO::operator<< ( JWriter & out, const std::set< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Write template std::set to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 195 of file JSTDIO.hh.

  {
    int n = object.size();
    
    out << n;
    
    for (typename std::set<JElement_t, JComparator_t,JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      out << *i;
    }
    
    return out;
  }

operator>>() [5/8]

template<class JElement_t , class JComparator_t , class JAllocator_t >

JReader & JIO::operator>> ( JReader & in, std::multiset< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Read template std::multiset from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 217 of file JSTDIO.hh.

  {
    int n = 0;
    
    in >> n;
    
    typename std::multiset<JElement_t, JComparator_t, JAllocator_t>::value_type element;
    
    object.clear();
 
    for (int i = 0; i != n; ++i) {
      
      in >> element;
      
      object.insert(element);
    }
 
    return in;
  }

operator<<() [5/8]

template<class JElement_t , class JComparator_t , class JAllocator_t >

JWriter & JIO::operator<< ( JWriter & out, const std::multiset< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Write template std::multiset to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 246 of file JSTDIO.hh.

  {
    int n = object.size();
    
    out << n;
    
    for (typename std::multiset<JElement_t, JComparator_t,JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      out << *i;
    }
    
    return out;
  }

operator>>() [6/8]

template<class JKey_t , class JValue_t >

JReader & JIO::operator>> ( JReader & in, std::pair< JKey_t, JValue_t > & object )

inline

Read template std::pair from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 268 of file JSTDIO.hh.

  {
    in >> object.first;
    in >> object.second;
 
    return in;
  }

operator<<() [6/8]

template<class JKey_t , class JValue_t >

JWriter & JIO::operator<< ( JWriter & out, const std::pair< JKey_t, JValue_t > & object )

inline

Write template std::pair to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 285 of file JSTDIO.hh.

  {
    out << object.first;
    out << object.second;
    
    return out;
  }

operator>>() [7/8]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

JReader & JIO::operator>> ( JReader & in, std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Read template std::map from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 302 of file JSTDIO.hh.

  {
    int n = 0;
    
    in >> n;
 
    typename std::map<JKey_t, JValue_t, JComparator_t, JAllocator_t>::key_type    key;  
    typename std::map<JKey_t, JValue_t, JComparator_t, JAllocator_t>::mapped_type value;      
 
    object.clear();
 
    for (int i = 0; i != n; ++i) {
      
      in >> key >> value;      
 
      object[key]=value;
    }
 
    return in;
  }

operator<<() [7/8]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

JWriter & JIO::operator<< ( JWriter & out, const std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Write template std::map to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 332 of file JSTDIO.hh.

  {
    int n = object.size();
    
    out << n;
    
    for (typename std::map<JKey_t, JValue_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      out << *i;
    }
    
    return out;
  }

operator>>() [8/8]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

JReader & JIO::operator>> ( JReader & in, std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Read template std::multimap from input.

Parameters

in	reader
object	object

Returns

reader

Definition at line 354 of file JSTDIO.hh.

  {
    int n = 0;
    
    in >> n;
 
    typename std::multimap<JKey_t, JValue_t, JComparator_t, JAllocator_t>::key_type    key;  
    typename std::multimap<JKey_t, JValue_t, JComparator_t, JAllocator_t>::mapped_type value;      
    
    object.clear();
 
    for (int i = 0; i != n; ++i) {
      
      in >> key >> value;      
 
      object[key]=value;
    }
 
    return in;
  }

operator<<() [8/8]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

JWriter & JIO::operator<< ( JWriter & out, const std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Write template std::multimap to output.

Parameters

out	writer
object	object

Returns

writer

Definition at line 384 of file JSTDIO.hh.

  {
    int n = object.size();
    
    out << n;
    
    for (typename std::multimap<JKey_t, JValue_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      out << *i;
    }
    
    return out;
  }