QmitkUpdateTimerWidget Class Reference

QmitkUpdateTimerWidget. More...

#include <QmitkUpdateTimerWidget.h>

Inheritance diagram for QmitkUpdateTimerWidget:

Collaboration diagram for QmitkUpdateTimerWidget:

Public Types
enum	WidgetButtons { StartButton, StopButton }

Public Slots
void	EnableWidget ()
void	DisableWidget ()

Signals
void	Started ()
void	Stopped ()

Public Member Functions
	QmitkUpdateTimerWidget (QWidget *parent)
	default constructor More...
	~QmitkUpdateTimerWidget () override
	default destructor More...
unsigned int	GetTimerInterval ()
	This method returns the timer's timeout interval in msec. More...
void	SetTimerInterval (unsigned int msec)
	This method sets the timer's timeout interval in msec. More...
void	StartTimer ()
	This method starts the timer if it is not already active. More...
void	StopTimer ()
	This method stops the timer if it is active at the moment. More...
QTimer *	GetUpdateTimer ()
	This method returns this object's timer. More...
void	SetPurposeLabelText (QString text)
	This method sets the given QString for the purpose of this update timer e.g. if "Navigation" is given, the start and stop button will be labeled "Start Navigation" and "Stop Navigation". Furthermore the purpose description is used for the timer status label: "Navigation started ... " in this case. More...
void	HideFramerateSettings (bool hidden)
	This method hides the framerate settings spinbox and her labels in the view. More...
void	SetIcon (WidgetButtons button, const QIcon &icon)
	This method sets the icon for a specific button of the widget. More...

Protected Slots
void	OnStartTimer ()
	This method is called when the start button is pressed. It starts the timer using StartTimer(). More...
void	OnStopTimer ()
	This method is called when the stop button is pressed. It stops the timer using StopTimer(). More...
void	OnChangeTimerInterval (int interval)
	This method is called when the value in the spinbox is changed. It updates the timer interval using SetTimerInterval( ). More...

Protected Member Functions
void	CreateConnections ()
void	CreateQtPartControl (QWidget *parent)

Protected Attributes
Ui::QmitkUpdateTimerWidgetControls *	m_Controls
	gui widgets More...

Detailed Description

QmitkUpdateTimerWidget.

Widget for setting up and controlling an update timer in an IGT-Pipeline.

Definition at line 26 of file QmitkUpdateTimerWidget.h.

Member Enumeration Documentation

WidgetButtons

enum QmitkUpdateTimerWidget::WidgetButtons

Enumerator
StartButton
StopButton

Definition at line 32 of file QmitkUpdateTimerWidget.h.

Constructor & Destructor Documentation

QmitkUpdateTimerWidget()

QmitkUpdateTimerWidget::QmitkUpdateTimerWidget

(

QWidget *

parent

)

default constructor

Definition at line 25 of file QmitkUpdateTimerWidget.cpp.

References CreateQtPartControl(), DEFAULTUPDATEVALUE, DisableWidget(), m_Controls, MAXIMUMUPDATEVALUE, MINIMUMUPDATEVALUE, and UPDATEVALUESTEP.

~QmitkUpdateTimerWidget()

QmitkUpdateTimerWidget::~QmitkUpdateTimerWidget ( )

override

default destructor

Definition at line 40 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

Member Function Documentation

CreateConnections()

void QmitkUpdateTimerWidget::CreateConnections ( )

protected

Definition at line 60 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, OnChangeTimerInterval(), OnStartTimer(), and OnStopTimer().

Referenced by CreateQtPartControl().

CreateQtPartControl()

void QmitkUpdateTimerWidget::CreateQtPartControl ( QWidget *  parent )

protected

Definition at line 48 of file QmitkUpdateTimerWidget.cpp.

References CreateConnections(), and m_Controls.

Referenced by QmitkUpdateTimerWidget().

DisableWidget

void QmitkUpdateTimerWidget::DisableWidget ( )

slot

Definition at line 162 of file QmitkUpdateTimerWidget.cpp.

References StopTimer().

Referenced by QmitkUpdateTimerWidget().

EnableWidget

void QmitkUpdateTimerWidget::EnableWidget ( )

slot

Definition at line 157 of file QmitkUpdateTimerWidget.cpp.

GetTimerInterval()

unsigned int QmitkUpdateTimerWidget::GetTimerInterval

(

)

This method returns the timer's timeout interval in msec.

Definition at line 67 of file QmitkUpdateTimerWidget.cpp.

Referenced by SetPurposeLabelText().

GetUpdateTimer()

QTimer * QmitkUpdateTimerWidget::GetUpdateTimer

(

)

This method returns this object's timer.

Definition at line 112 of file QmitkUpdateTimerWidget.cpp.

HideFramerateSettings()

void QmitkUpdateTimerWidget::HideFramerateSettings

(

bool

hidden

)

This method hides the framerate settings spinbox and her labels in the view.

Definition at line 149 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

OnChangeTimerInterval

void QmitkUpdateTimerWidget::OnChangeTimerInterval ( int  interval )

protectedslot

This method is called when the value in the spinbox is changed. It updates the timer interval using SetTimerInterval( ).

Definition at line 72 of file QmitkUpdateTimerWidget.cpp.

References SetTimerInterval().

Referenced by CreateConnections().

OnStartTimer

void QmitkUpdateTimerWidget::OnStartTimer ( )

protectedslot

This method is called when the start button is pressed. It starts the timer using StartTimer().

Definition at line 117 of file QmitkUpdateTimerWidget.cpp.

References StartTimer().

Referenced by CreateConnections().

OnStopTimer

void QmitkUpdateTimerWidget::OnStopTimer ( )

protectedslot

This method is called when the stop button is pressed. It stops the timer using StopTimer().

Definition at line 122 of file QmitkUpdateTimerWidget.cpp.

References StopTimer().

Referenced by CreateConnections().

SetIcon()

void QmitkUpdateTimerWidget::SetIcon	(	WidgetButtons	button,
		const QIcon &	icon
	)

This method sets the icon for a specific button of the widget.

Definition at line 170 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, StartButton, and StopButton.

SetPurposeLabelText()

void QmitkUpdateTimerWidget::SetPurposeLabelText

(

QString

text

)

This method sets the given QString for the purpose of this update timer e.g. if "Navigation" is given, the start and stop button will be labeled "Start Navigation" and "Stop Navigation". Furthermore the purpose description is used for the timer status label: "Navigation started ... " in this case.

Definition at line 128 of file QmitkUpdateTimerWidget.cpp.

References GetTimerInterval(), m_Controls, max(), and min().

SetTimerInterval()

void QmitkUpdateTimerWidget::SetTimerInterval

(

unsigned int

msec

)

This method sets the timer's timeout interval in msec.

Definition at line 78 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

Referenced by OnChangeTimerInterval().

Started

void QmitkUpdateTimerWidget::Started ( )

signal

Referenced by StartTimer().

StartTimer()

void QmitkUpdateTimerWidget::StartTimer

(

)

This method starts the timer if it is not already active.

Definition at line 84 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, and Started().

Referenced by OnStartTimer().

Stopped

void QmitkUpdateTimerWidget::Stopped ( )

signal

Referenced by StopTimer().

StopTimer()

void QmitkUpdateTimerWidget::StopTimer

(

)

This method stops the timer if it is active at the moment.

Definition at line 98 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, and Stopped().

Referenced by DisableWidget(), and OnStopTimer().

Member Data Documentation

m_Controls

Ui::QmitkUpdateTimerWidgetControls* QmitkUpdateTimerWidget::m_Controls

protected

gui widgets

Definition at line 120 of file QmitkUpdateTimerWidget.h.

Referenced by CreateConnections(), CreateQtPartControl(), HideFramerateSettings(), QmitkUpdateTimerWidget(), SetIcon(), SetPurposeLabelText(), SetTimerInterval(), StartTimer(), StopTimer(), and ~QmitkUpdateTimerWidget().

---

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

• QmitkUpdateTimerWidget.h
• QmitkUpdateTimerWidget.cpp