Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
QmitkXnatExperimentWidget Class Reference

Widget for displaying or editing XNAT experiment properties. More...

#include <QmitkXnatExperimentWidget.h>

Inheritance diagram for QmitkXnatExperimentWidget:
Collaboration diagram for QmitkXnatExperimentWidget:

Public Types

enum  Mode { INFO , CREATE }
 Operation mode for the experiment widget. More...
 

Public Member Functions

 QmitkXnatExperimentWidget (QWidget *parent=nullptr)
 Construct the widget in INFO mode. More...
 
 QmitkXnatExperimentWidget (Mode mode, QWidget *parent=nullptr)
 Construct the widget in the specified mode. More...
 
 ~QmitkXnatExperimentWidget () override
 Destructor. More...
 
void SetExperiment (ctkXnatExperiment *experiment)
 Populate the widget fields from the given experiment object. More...
 
ctkXnatExperiment * GetExperiment () const
 Retrieve the experiment object, optionally updated with user-entered values. More...
 

Protected Attributes

std::unique_ptr< Ui::QmitkXnatExperimentWidgetControls > m_Controls
 UI controls generated from the .ui form. More...
 

Detailed Description

Widget for displaying or editing XNAT experiment properties.

QmitkXnatExperimentWidget provides a form-based user interface for viewing or creating XNAT experiments. In INFO mode, the widget displays read-only experiment properties (label, modality, date, time, scanner) along with a breadcrumb showing the parent project and subject. In CREATE mode, the modality field becomes an XSI type selector with auto-completion for all standard XNAT experiment session types, and all fields are editable.

See also
QmitkXnatCreateObjectDialog, QmitkXnatSubjectWidget, QmitkXnatProjectWidget, ctkXnatExperiment

Definition at line 40 of file QmitkXnatExperimentWidget.h.

Member Enumeration Documentation

◆ Mode

Operation mode for the experiment widget.

Enumerator
INFO 

Display experiment properties in read-only mode.

CREATE 

Allow editing of experiment properties for creation.

Definition at line 48 of file QmitkXnatExperimentWidget.h.

Constructor & Destructor Documentation

◆ QmitkXnatExperimentWidget() [1/2]

QmitkXnatExperimentWidget::QmitkXnatExperimentWidget ( QWidget *  parent = nullptr)

Construct the widget in INFO mode.

Parameters
[in]parentOptional parent widget.

◆ QmitkXnatExperimentWidget() [2/2]

QmitkXnatExperimentWidget::QmitkXnatExperimentWidget ( Mode  mode,
QWidget *  parent = nullptr 
)

Construct the widget in the specified mode.

In CREATE mode, the modality field is replaced by an XSI type field with auto-completion for all supported XNAT experiment session types.

Parameters
[in]modeThe operation mode (INFO or CREATE).
[in]parentOptional parent widget.

◆ ~QmitkXnatExperimentWidget()

QmitkXnatExperimentWidget::~QmitkXnatExperimentWidget ( )
override

Destructor.

Member Function Documentation

◆ GetExperiment()

ctkXnatExperiment* QmitkXnatExperimentWidget::GetExperiment ( ) const

Retrieve the experiment object, optionally updated with user-entered values.

In CREATE mode, the returned experiment has its label, xsiType, date, time, and scanner properties updated from the widget's input fields. In INFO mode, the experiment is returned unchanged.

Returns
Pointer to the ctkXnatExperiment with current widget values applied.

◆ SetExperiment()

void QmitkXnatExperimentWidget::SetExperiment ( ctkXnatExperiment *  experiment)

Populate the widget fields from the given experiment object.

Sets the breadcrumb label, ID/label, modality, date, time, and scanner fields from the experiment's properties.

Parameters
[in]experimentThe XNAT experiment whose properties should be displayed.
Precondition
experiment must not be nullptr.

Member Data Documentation

◆ m_Controls

std::unique_ptr<Ui::QmitkXnatExperimentWidgetControls> QmitkXnatExperimentWidget::m_Controls
protected

UI controls generated from the .ui form.

Definition at line 100 of file QmitkXnatExperimentWidget.h.


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