christoph/fail
1
Fork 0
Code Releases Activity

ProtoStream: comments, FIXMEs

Browse Source 
git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1315 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
This commit is contained in:
hsc
2012-06-06 14:27:32 +00:00
parent 7573010685
commit 3284fba7d3
2 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
core/util/ProtoStream.hpp
View File

@ -25,8 +25,8 @@
/**
* \class ProtoOStream
*
* This class can be used to write messages in a file.
*
* This class can be used to sequentially write a large number of protocol
* buffer messages to a std::ostream.
*/
class ProtoOStream
{
@ -42,7 +42,7 @@ class ProtoOStream
/**
* Writes a message to a file.
* @param m The protobuf-message to be written.
* @return Returns true if data was written.
* @return Returns true on success.
*/
bool writeMessage(google::protobuf::Message* m);
};
@ -51,8 +51,8 @@ class ProtoOStream
/**
* \class ProtoIStream
*
* This class can be used to read messages sequentially from a file.
*
* This class can be used to read protocol buffer messages sequentially from a
* std::istream.
*/
class ProtoIStream
{
@ -69,14 +69,13 @@ class ProtoIStream
virtual ~ProtoIStream() {};
/**
* Resets the position of the get pointer. After that getNext
* delivers the first message again.
* reads the first message again.
*/
void reset();
/**
* Delivers the protobuf-messages sequentially from file.
* @param m The protobuf-message in which, the data should be
* written.
* @return Returns true if data was written to protobuf-message.
* Reads the next protobuf message from the input stream.
* @param m The output protobuf message.
* @return Returns true on success.
*/
bool getNext(google::protobuf::Message* m);
};