orca-robotics INTRODUCTION Overview Download and Install Documentation REPOSITORY Interfaces Drivers Libraries Utilities Software Map DEVELOPER Dashboard PEOPLE Contributors Users Project Download Mailing lists

hydroiceutil::LocalHistory Class Reference Writes component's run history to a local file. More... #include <localhistory.h> Inherits hydroutil::History, and hydroutil::Uncopyable. Inheritance diagram for hydroiceutil::LocalHistory: [legend]List of all members. Public Member Functions   LocalHistory (const hydroutil::Properties &props=hydroutil::Properties())   Constructor with optional properties. virtual void  set (const std::string &message)   Sets the contents of the history without modifying the message. virtual void  setWithStartSequence (const std::string &message)   Appends the message to the standard start sequence. virtual void  setWithFinishSequence (const std::string &message)   Appends the message to the standard finish sequence. virtual void  autoStart (bool force=false) virtual void  autoFinish (bool force=false) virtual void  flush ()   Write current contents to the storage medium and clear current history contents. 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}" If Enabled, tries to open the history file for writing. Throws hydroiceutil::Exception if fails to open the file. If not Enabled, does nothing. Member Function Documentation void LocalHistory::autoFinish (  bool  force = false  )  [virtual]   Sets the contents of the history to the standard finish sequence. If the history is non-empty, nothing will be written unless the force flag is set to TRUE. Implements hydroutil::History. void LocalHistory::autoStart (  bool  force = false  )  [virtual]   Sets the contents of the history to the standard start sequence. If the history is non-empty, nothing will be written unless the force flag is set to TRUE. Implements hydroutil::History. The documentation for this class was generated from the following files: localhistory.h localhistory.cpp

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)

---