Go to the documentation of this file.
17 #ifndef _GAZEBO_UTIL_LOGPLAY_HH_
18 #define _GAZEBO_UTIL_LOGPLAY_HH_
61 public:
void Open(
const std::string &_logFile);
65 public:
bool IsOpen()
const;
70 public: std::string LogVersion()
const;
75 public: std::string GazeboVersion()
const;
80 public: uint32_t RandSeed()
const;
92 public: std::string Filename()
const;
96 public: std::string FullPathFilename()
const;
100 public: uintmax_t FileSize()
const;
104 public:
bool Step(std::string &_data);
108 public:
bool StepBack(std::string &_data);
113 public:
bool Step(
const int _step, std::string &_data);
124 public:
bool Rewind();
128 public:
bool Forward();
132 public:
unsigned int ChunkCount()
const;
138 public:
bool Chunk(
const unsigned int _index, std::string &_data)
const;
144 public: std::string Encoding()
const;
149 public: std::string Header()
const;
153 public: uint64_t InitialIterations()
const;
159 public:
bool HasIterations()
const;
162 private:
void ReadHeader();
166 private:
void ReadLogTimes();
172 private:
bool ReadIterations();
177 private:
bool NextChunk();
182 private:
bool PrevChunk();
186 private: std::unique_ptr<LogPlayPrivate> dataPtr;
std::string Encoding() const
Get the type of encoding used for current chunck in the open log file.
unsigned int ChunkCount() const
Get the number of chunks (steps) in the open log file.
void Open(const std::string &_logFile)
Open a log file for reading.
Forward declarations for the common classes.
Definition: Animation.hh:26
A Time class, can be used to hold wall- or sim-time. stored as sec and nano-sec.
Definition: Time.hh:44
Singleton template class.
Definition: SingletonT.hh:33
Definition: LogPlay.hh:47
std::string LogVersion() const
Get the log version number of the open log file.
std::string FullPathFilename() const
Get the full path of the log file.
bool IsOpen() const
Return true if a file is open.
std::string Header() const
Get the header that was read from a log file.
bool StepBack(std::string &_data)
Step through the open log file backwards.
bool Chunk(const unsigned int _index, std::string &_data) const
Get data for a particular chunk index.
std::string Filename() const
Get the name of the log file.
bool Forward()
Jump to the end of the log file.
uint64_t InitialIterations() const
Get the initial simulation iterations from a log file.
bool HasIterations() const
Return if the log file contains the <iterations> tag.
uintmax_t FileSize() const
Get the size of the log file.
common::Time LogEndTime() const
Get the log end time of the open log file.
bool Seek(const common::Time &_time)
Jump to the closest sample that has its simulation time lower than the time specified as a parameter.
bool Step(std::string &_data)
Step through the open log file.
bool Rewind()
Jump to the beginning of the log file.
common::Time LogStartTime() const
Get the log start time of the open log file.
std::string GazeboVersion() const
Get the Gazebo version number of the open log file.
uint32_t RandSeed() const
Get the random number seed of the open log file.