Constructor Detail

• Log

  public Log​(String path,
             String mode)
      throws IOException

  Opens a log file for reading or writing.

  Parameters:

  path - the filename to open

  mode - Specifies the access mode, must be one of "r", "rw", "rws", or "rwd". See RandomAccessFile for more detail.

  Throws:

  IOException

Method Detail

• getPath

  public String getPath()

  Retrieves the path to the log file.

  Returns:

  the path to the log file

• flush

  public void flush()
             throws IOException

  Flush any unwritten data to the underlying file descriptor.

  Throws:

  IOException

• readNext

  public Log.Event readNext()
                     throws IOException

  Reads the next event in the log file

  Throws:

  EOFException - if the end of the file has been reached.

  IOException

• getPositionFraction

  public double getPositionFraction()
                             throws IOException

  Throws:

  IOException

• seekPositionFraction

  public void seekPositionFraction​(double frac)
                            throws IOException

  Seek to a position in the log file, specified by a fraction.

  Parameters:

  frac - a number in the range [0, 1)

  Throws:

  IOException

• write

  public void write​(Log.Event e)
             throws IOException

  Writes an event to the log file. The user is responsible for filling in the eventNumber field, which should be sequentially increasing integers starting with 0.

  Throws:

  IOException

• write

  public void write​(long utime,
                    String channel,
                    LCMEncodable msg)
             throws IOException

  A convenience method for write. It internally manages the eventNumber field, and so calls to this method should not be mixed with calls to the other write methods.

  Throws:

  IOException

• close

  public void close()
             throws IOException

  Closes the log file and releases and system resources used by it.

  Throws:

  IOException