All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::common::LogPlay Class Reference

#include <LogPlay.hh>

Inheritance diagram for gazebo::common::LogPlay:
Inheritance graph
[legend]

Public Member Functions

bool IsOpen () const
 Return true if a file is open.
 
void Open (const std::string &_logFile)
 Open a log file for reading.
 
bool Step (std::string &_data)
 Step through the open log file.
 

Additional Inherited Members

- Static Public Member Functions inherited from SingletonT< T >
static T * Instance ()
 Get an instance of the singleton.
 
- Protected Member Functions inherited from SingletonT< T >
 SingletonT ()
 Constructor.
 
virtual ~SingletonT ()
 Destructor.
 

Member Function Documentation

bool gazebo::common::LogPlay::IsOpen ( ) const

Return true if a file is open.

Returns
True if a log file is open.
void gazebo::common::LogPlay::Open ( const std::string &  _logFile)

Open a log file for reading.

Open a log file that was previously recorded.

Parameters
[in]_logFileThe file to load
Exceptions
Exception
bool gazebo::common::LogPlay::Step ( std::string &  _data)

Step through the open log file.

Parameters
[out]_dataData from next entry in the log file.

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