SerUt  1.1.1 (development version)
Public Types | Public Member Functions | List of all members
serut::FileSerializer Class Reference

A serializer for writing to and reading from files. More...

#include <fileserializer.h>

Inheritance diagram for serut::FileSerializer:
Inheritance graph
[legend]
Collaboration diagram for serut::FileSerializer:
Collaboration graph
[legend]

Public Types

enum  OpenMode { ReadOnly , WriteOnly , ReadWrite }
 Specifies the mode in which a file can be opened. More...
 

Public Member Functions

bool open (const std::string &filename, OpenMode m)
 Open a file. More...
 
bool close ()
 Close a previously opened file. More...
 
- Public Member Functions inherited from serut::SerializationInterface
bool writeLongDouble (double x)
 Write a long double. More...
 
bool writeDouble (double x)
 Write a double. More...
 
bool writeFloat (float x)
 Write a float. More...
 
bool writeInt32 (int32_t x)
 Write a 32-bit integer. More...
 
bool writeLongDoubles (const long double *pX, size_t amount)
 Write an array of doubles. More...
 
bool writeDoubles (const double *pX, size_t amount)
 Write an array of doubles. More...
 
bool writeFloats (const float *pX, size_t amount)
 Write an array of floats. More...
 
bool writeInt32s (const int32_t *pX, size_t amount)
 Write an array of 32-bit integers. More...
 
bool writeLongDoubles (const std::vector< long double > &x)
 Write the long doubles stored in the vector. More...
 
bool writeDoubles (const std::vector< double > &x)
 Write the doubles stored in the vector. More...
 
bool writeFloats (const std::vector< float > &x)
 Write the floats stored in the vector. More...
 
bool writeInt32s (const std::vector< int32_t > &x)
 Write the 32-bit integers which are stored in the vector. More...
 
bool writeString (const std::string &x)
 Write a string. More...
 
bool readLongDouble (long double *pX)
 Read a long double. More...
 
bool readDouble (double *pX)
 Read a double. More...
 
bool readFloat (float *pX)
 Read a float. More...
 
bool readInt32 (int32_t *pX)
 Read a 32-bit integer. More...
 
bool readLongDoubles (long double *pX, size_t amount)
 Read an array of long doubles. More...
 
bool readDoubles (double *pX, size_t amount)
 Read an array of doubles. More...
 
bool readFloats (float *pX, size_t amount)
 Read an array of floats. More...
 
bool readInt32s (int32_t *pX, size_t amount)
 Read an array of 32-bit integers. More...
 
bool readLongDoubles (std::vector< long double > &x)
 Read a vector of long doubles (the current size of the vector specifies the amount). More...
 
bool readDoubles (std::vector< double > &x)
 Read a vector of doubles (the current size of the vector specifies the amount). More...
 
bool readFloats (std::vector< float > &x)
 Read a vector of floats (the current size of the vector specifies the amount). More...
 
bool readInt32s (std::vector< int32_t > &x)
 Read a vector of 32-bit integers (the current size of the vector specifies the amount). More...
 
bool readString (std::string &x)
 Read a string. More...
 

Detailed Description

Member Enumeration Documentation

◆ OpenMode

Enumerator
ReadOnly 

Read-only mode.

WriteOnly 

Write-only mode.

ReadWrite 

Both reading and writing.

Member Function Documentation

◆ close()

bool serut::FileSerializer::close ( )

◆ open()

bool serut::FileSerializer::open ( const std::string &  filename,
OpenMode  m 
)

Open a file.

Parameters
filenameThe name of the file to open
mThe mode in which the file should be opened.

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