stfio::StdoutProgressInfo Class Reference

StdoutProgressInfo class. More...

#include <stfio.h>

Inheritance diagram for stfio::StdoutProgressInfo:

Collaboration diagram for stfio::StdoutProgressInfo:

List of all members.

Public Member Functions
	StdoutProgressInfo (const std::string &title, const std::string &message, int maximum, bool verbose)
bool	Update (int value, const std::string &newmsg="", bool *skip=NULL)
	Updates the progress info.

---

Detailed Description

StdoutProgressInfo class.

Example of a ProgressInfo that prints to stdout

Definition at line 127 of file stfio.h.

---

Member Function Documentation

bool stfio::StdoutProgressInfo::Update	(	int	value,
		const std::string &	newmsg = "",
		bool *	skip = NULL
	)		[virtual]

Updates the progress info.

Parameters:

value	New value of the progress meter
newmsg	New message for the info text
skip	This is set to true if the user has chosen to skip the operation

Returns:

True unless the operation was cancelled.

Implements stfio::ProgressInfo.

---

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

• /git/stimfit/src/libstfio/stfio.h