RobWorkProject  24.5.15-
Public Member Functions | Protected Member Functions | List of all members
Archive Class Referenceabstract

archive interface for serializaion classes. More...

#include <Archive.hpp>

Inherited by InputArchive [virtual], and OutputArchive [virtual].

Public Member Functions

virtual ~Archive ()
 destructor
 
void open (const std::string &filename)
 open file for reading and writing More...
 
void open (std::iostream &stream)
 initialize archive for reading and/or writing to a stream More...
 
void open (std::ostream &ofs)
 open an output stream for writing
 
void open (std::istream &ifs)
 open an inputstream for reading
 
virtual bool isOpen ()=0
 test if this archive is openned for manipulation. If this is false then no storage will be performed. More...
 
virtual void close ()=0
 close the archive.
 
virtual void flush ()=0
 flush the archive. Anything stored in buffers will be flushed to the actual media that has been openned.
 

Protected Member Functions

virtual void doOpenArchive (const std::string &filename)=0
 open file for reading and writing More...
 
virtual void doOpenArchive (std::iostream &stream)=0
 initialize archive for reading and/or writing to a stream More...
 
virtual void doOpenInput (std::istream &ifs)=0
 open an inputstream for reading More...
 
virtual void doOpenOutput (std::ostream &ofs)=0
 open an output stream for writing More...
 

Detailed Description

archive interface for serializaion classes.

Member Function Documentation

◆ doOpenArchive() [1/2]

virtual void doOpenArchive ( const std::string &  filename)
protectedpure virtual

open file for reading and writing

Parameters
filename

Implemented in INIArchive, and BINArchive.

◆ doOpenArchive() [2/2]

virtual void doOpenArchive ( std::iostream &  stream)
protectedpure virtual

initialize archive for reading and/or writing to a stream

Parameters
stream[in] the stream

Implemented in INIArchive, and BINArchive.

◆ doOpenInput()

virtual void doOpenInput ( std::istream &  ifs)
protectedpure virtual

open an inputstream for reading

Implemented in INIArchive, and BINArchive.

◆ doOpenOutput()

virtual void doOpenOutput ( std::ostream &  ofs)
protectedpure virtual

open an output stream for writing

Implemented in INIArchive, and BINArchive.

◆ isOpen()

virtual bool isOpen ( )
pure virtual

test if this archive is openned for manipulation. If this is false then no storage will be performed.

Returns
true if Archive is ready for streaming

Implemented in INIArchive, and BINArchive.

◆ open() [1/2]

void open ( const std::string &  filename)
inline

open file for reading and writing

Parameters
filename

◆ open() [2/2]

void open ( std::iostream &  stream)
inline

initialize archive for reading and/or writing to a stream

Parameters
stream[in] the stream

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