LCM
List of all members | Public Member Functions
lcm::LogFile Class Reference

Read and write LCM log files. More...

#include <lcm/lcm-cpp.hpp>

Public Member Functions

 LogFile (const std::string &path, const std::string &mode)
 
 ~LogFile ()
 
bool good () const
 
const LogEventreadNextEvent ()
 
int seekToTimestamp (int64_t timestamp)
 
int writeEvent (LogEvent *event)
 
FILE * getFilePtr ()
 retrives the underlying FILE* wrapped by this class. More...
 

Detailed Description

Read and write LCM log files.

This class is the C++ counterpart for lcm_eventlog_t.

See also
lcm_eventlog_t

Constructor & Destructor Documentation

lcm::LogFile::LogFile ( const std::string &  path,
const std::string &  mode 
)
inline

Constructor. Opens the specified log file for reading or writing.

Parameters
paththe file to open
mode"r" (read mode) or "w" (write mode)
See also
lcm_eventlog_create()
lcm::LogFile::~LogFile ( )
inline

Destructor. Closes the log file.

Member Function Documentation

FILE * lcm::LogFile::getFilePtr ( )
inline

retrives the underlying FILE* wrapped by this class.

This method should be used carefully and sparingly. An example use-case is borrowing to tweak the behavior of the I/O. Calls of interest include fflush(), fileno(), setvbuf(), etc It is a bad idea to attempt reading or writing on the raw FILE*

Returns
the FILE* wrapped by this object.
bool lcm::LogFile::good ( ) const
inline
Returns
true if the log file is ready for reading/writing.
const LogEvent * lcm::LogFile::readNextEvent ( )
inline

Reads the next event in the log file. Valid in read mode only.

The LogFile class manages the memory of the read event. The returned event is valid until the next call to this method.

Returns
the next event, or NULL if the end of the log file has been reached.
int lcm::LogFile::seekToTimestamp ( int64_t  timestamp)
inline

Seek close to the specified timestamp in the log file. Valid in read mode only.

Parameters
timestampthe desired seek point in the log file.
Returns
0 on success, -1 on error.
See also
lcm_eventlog_seek_to_timestamp()
int lcm::LogFile::writeEvent ( LogEvent event)
inline

Writes an event to the log file. Valid in write mode only.

Parameters
eventthe event to write. The timestamp, channel, datalen, and data fields should be filled in. The eventnum field will be automatically filled in.
Returns
0 on success, -1 on error.
See also
lcm_eventlog_write_event()

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