hydroiceutil::LocalHistory Class Reference

Writes component's run history to a local file. More...

#include <localhistory.h>

Inherits hydroutil::History, and hydroutil::Uncopyable.

List of all members.

Public Member Functions
	LocalHistory (const hydroutil::Properties &props=hydroutil::Properties())
	Constructor with optional properties.
virtual void	report (const std::string &message="")
	Writes a progress message.
virtual bool	isEnabled () const
	Is history enabled?
virtual int	autoSaveInterval () const
	Retruns auto-save interval [s].

---

Detailed Description

Writes component's run history to a local file.

Properties:

• "Enable" (bool)
  • Enables writing history to file.
  • Default: 0
• "Dir" (string)
  • If Path is not provided, specifies the directory where to store the history file with the default name.
  • Default: "./"
• "DefaultFilename" (string)
  • Default: "xxxx-history.txt"
• "Path" (string)
  • If given, specifies the full path to the history file.
  • Default: "${Dir}/${DefaultFilename}"
• "AutoSaveInterval" (int)
  • The mimimum interval between flushing history to file. The history will be written to file when a) setProgressMessage() is called, and b) the elapsed time since last write is greater than the AutoSaveInterval.
  • Units [sec]
  • Valid values: positive for auto save, negative to disable autosave.
  • Default: 60

If Enabled, tries to open the history file for writing. Throws hydroiceutil::Exception if fails to open the file.

If not Enabled, does nothing.

---

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

• localhistory.h
• localhistory.cpp