17 #ifndef _GAZEBO_UTIL_LOGRECORD_HH_ 18 #define _GAZEBO_UTIL_LOGRECORD_HH_ 27 #define GZ_LOG_VERSION "1.0" 52 class LogRecordPrivate;
88 public:
bool Init(
const std::string &_subdir);
102 public:
void Add(
const std::string &_name,
const std::string &_filename,
103 std::function<
bool (std::ostringstream &)> _logCallback);
113 public:
bool Remove(
const std::string &_name);
119 public:
void Notify();
125 public:
void SetPaused(
const bool _paused);
136 public:
bool Paused()
const;
140 public:
double Period()
const;
144 public:
void SetPeriod(
const double _period);
148 public: std::string Filter()
const;
152 public:
void SetFilter(
const std::string &_filter);
157 public:
bool IsReadyToStart()
const;
166 public:
bool Running()
const;
175 public:
bool Start(
const std::string &_encoding=
"zlib",
176 const std::string &_path=
"");
187 public:
const std::string &Encoding()
const;
193 public: std::string GetFilename(
const std::string &_name =
"")
const 199 public: std::string Filename(
const std::string &_name =
"")
const;
205 public:
unsigned int GetFileSize(
const std::string &_name =
"")
const 211 public:
unsigned int FileSize(
const std::string &_name =
"")
const;
215 public:
void SetBasePath(
const std::string &_path);
224 public: std::string BasePath()
const;
245 public:
bool FirstUpdate()
const;
249 public:
void Write(
const bool _force =
false);
258 public:
unsigned int BufferSize()
const;
264 private:
void Update();
267 private:
void RunUpdate();
270 private:
void RunWrite();
273 private:
void ClearLogs();
276 private:
void PublishLogStatus();
280 private:
void OnLogControl(ConstLogControlPtr &_data);
285 private:
void Cleanup();
288 private:
void OnPause(
const bool _pause);
295 private: std::unique_ptr<LogRecordPrivate> dataPtr;
Forward declarations for the common classes.
Definition: Animation.hh:33
double period
Recording period.
Definition: LogRecord.hh:45
#define GAZEBO_DEPRECATED(version)
Definition: CommonTypes.hh:48
Singleton template class.
Definition: SingletonT.hh:33
std::string encoding
The type of encoding (txt, zlib, or bz2).
Definition: LogRecord.hh:38
addtogroup gazebo_util
Definition: LogRecord.hh:74
Log recording parameters.
Definition: LogRecord.hh:35
std::string filter
Log filter string.
Definition: LogRecord.hh:48
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
std::string path
Path in which to store log files.
Definition: LogRecord.hh:41
A Time class, can be used to hold wall- or sim-time.
Definition: Time.hh:44