##

LogPlayWidget Class Reference

Widget which displays log playback options. More...

`#include <LogPlayWidget.hh>`

Inherits QWidget.

## Public Slots

void | OnCurrentTime ()
| Callback when the current time has been edited. More...
void | OnForward ()
| Jump to the end of the log file. More...
void | OnPause ()
| Pause simulation. More...
void | OnPlay ()
| Play simulation. More...
void | OnRewind ()
| Jump to the start of the log file. More...
void | OnSeek (const common::Time &_time)
| Jump to a given time in the log file. More...
void | OnStepBack ()
| Step simulation back. More...
void | OnStepForward ()
| Step simulation forward. More...

## Signals

void | HidePause ()
| Qt signal to hide the pause button. More...
void | HidePlay ()
| Qt signal to hide the play button. More...
void | SetCurrentDays (const QString &)
| Qt signal used to set the current day line edit. More...
void | SetCurrentHours (const QString &)
| Qt signal used to set the current hour line edit. More...
void | SetCurrentMinutes (const QString &)
| Qt signal used to set the current minute line edit. More...
void | SetCurrentSeconds (const QString &)
| Qt signal used to set the current second line edit. More...
void | SetCurrentTime (const common::Time &_time)
| Qt signal used to set the current time in the view. More...
void | SetEndTime (const common::Time &_time)
| Qt signal used to set the end time in the view. More...
void | SetEndTime (const QString &)
| Qt signal used to set the end time line edit. More...
void | SetStartTime (const common::Time &_time)
| Qt signal used to set the start time in the view. More...
void | ShowPause ()
| Qt signal to show the pause button. More...
void | ShowPlay ()
| Qt signal to show the play button. More...

## Public Member Functions

| LogPlayWidget (QWidget *_parent=0)
| Constructor. More...
virtual | ~LogPlayWidget ()
| Destructor. More...
void | EmitSetCurrentTime (const common::Time &_time)
| Emit signal to set current time. More...
void | EmitSetEndTime (const common::Time &_time)
| Emit signal to set end time. More...
void | EmitSetStartTime (const common::Time &_time)
| Emit signal to set start time. More...
bool | IsPaused () const
| Returns if the simulation is displayed as paused. More...
void | SetPaused (const bool _paused)
| Set whether to display the simulation as paused. More...

## Detailed Description

Widget which displays log playback options.

## Constructor & Destructor Documentation

## LogPlayWidget()

LogPlayWidget | ( | QWidget * | _parent = `0` | ) |

explicit

Constructor.

Parameters

  [in] | _parent | Parent widget, commonly a TimePanel.

## ~LogPlayWidget()

virtual ~LogPlayWidget | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## EmitSetCurrentTime()

void EmitSetCurrentTime | ( | const common::Time & | _time | ) |

Emit signal to set current time.

Parameters

  [in] | _time | Current time.

## EmitSetEndTime()

void EmitSetEndTime | ( | const common::Time & | _time | ) |

Emit signal to set end time.

Parameters

  [in] | _time | End time.

## EmitSetStartTime()

void EmitSetStartTime | ( | const common::Time & | _time | ) |

Emit signal to set start time.

Parameters

  [in] | _time | Start time.

## HidePause

void HidePause | ( |  | ) |

signal

Qt signal to hide the pause button.

## HidePlay

void HidePlay | ( |  | ) |

signal

Qt signal to hide the play button.

## IsPaused()

bool IsPaused | ( |  | ) | const

Returns if the simulation is displayed as paused.

Returns
  True if paused, false otherwise.

## OnCurrentTime

void OnCurrentTime | ( |  | ) |

slot

Callback when the current time has been edited.

## OnForward

void OnForward | ( |  | ) |

slot

Jump to the end of the log file.

## OnPause

void OnPause | ( |  | ) |

slot

Pause simulation.

## OnPlay

void OnPlay | ( |  | ) |

slot

Play simulation.

## OnRewind

void OnRewind | ( |  | ) |

slot

Jump to the start of the log file.

## OnSeek

void OnSeek | ( | const common::Time & | _time | ) |

slot

Jump to a given time in the log file.

Parameters

  [in] | _time | Desired time

## OnStepBack

void OnStepBack | ( |  | ) |

slot

Step simulation back.

## OnStepForward

void OnStepForward | ( |  | ) |

slot

Step simulation forward.

## SetCurrentDays

void SetCurrentDays | ( | const QString & |  | ) |

signal

Qt signal used to set the current day line edit.

Parameters

  [in] | _string | String representation of current day.

## SetCurrentHours

void SetCurrentHours | ( | const QString & |  | ) |

signal

Qt signal used to set the current hour line edit.

Parameters

  [in] | _string | String representation of current hour.

## SetCurrentMinutes

void SetCurrentMinutes | ( | const QString & |  | ) |

signal

Qt signal used to set the current minute line edit.

Parameters

  [in] | _string | String representation of current minute.

## SetCurrentSeconds

void SetCurrentSeconds | ( | const QString & |  | ) |

signal

Qt signal used to set the current second line edit.

Parameters

  [in] | _string | String representation of current second.

## SetCurrentTime

void SetCurrentTime | ( | const common::Time & | _time | ) |

signal

Qt signal used to set the current time in the view.

Parameters

  [in] | _time | Current time.

## SetEndTime [1/2]

void SetEndTime | ( | const common::Time & | _time | ) |

signal

Qt signal used to set the end time in the view.

Parameters

  [in] | _time | End time.

## SetEndTime [2/2]

void SetEndTime | ( | const QString & |  | ) |

signal

Qt signal used to set the end time line edit.

Parameters

  [in] | _string | String representation of current time.

## SetPaused()

void SetPaused | ( | const bool | _paused | ) |

Set whether to display the simulation as paused.

Parameters

  [in] | _p | True to display the simulation as paused. False indicates the simulation is running

## SetStartTime

void SetStartTime | ( | const common::Time & | _time | ) |

signal

Qt signal used to set the start time in the view.

Parameters

  [in] | _time | Start time.

## ShowPause

void ShowPause | ( |  | ) |

signal

Qt signal to show the pause button.

## ShowPlay

void ShowPlay | ( |  | ) |

signal

Qt signal to show the play button.

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

- LogPlayWidget.hh