1. Title:
Document no:
Revision no:
Date:
Prepared by:
Reviewed by:
Approved by
Title: EPICSQt Requirement Specification
Document no: 11555
Revision no: 0.3
Date: 26 May 2008
Australian Synchrotron Company Limited
ABN 52 126 531 271
Prepared by: Name: Glenn Jackson
Title: Control System
Date: 23 May 2008
Reviewed by: Name: Andrew Rhyder
Title: Senior Control System
Date: 18 November 200
Approved by Name: Anthony Owen
Title: Control Systems Engineer
Date: 18 November 200
EPICSQt Requirement Specification
Australian Synchrotron Company Limited
Glenn Jackson
Control Systems Engineer
Andrew Rhyder
Control Systems Engineer
2009
Anthony Owen
Control Systems Engineer
2009

2. EPICSQt Requirement Specification
Revision History
Revision Date Prepared by
0 26/05/2008 Glenn Jackson
0.1 12/11/2009 Glenn Jackson
0.2 17/11/2009 Glenn Jackson
Prepared by Description
Glenn Jackson Initial draft
Glenn Jackson Preparation for CM
Glenn Jackson Updated for CM converted to docxUpdated for CM converted to docx

3. EPICSQt Requirement Specification
Table of Contents
1 Introduction................................
2 Purpose................................................................
3 Reference documents ................................
3.1 EPICS referenced documents
3.2 Qt referenced documents ................................
3.3 Australian Synchrotron referenced documents
4 Scope................................................................
5 Components................................
5.1 The Control System................................
5.2 The Build System ................................
5.3 Qt GUI Framework ................................
6 Control System Interface Requirements
6.1 EPICS ................................................................
7 Build System Interface Requirements
7.1 The Australian Synchrotron Formal Build System
7.2 Compatibility with standard Makefile requirements
8 Integrated Development Environment Requirements
8.1 Windows IDE Requirements
8.2 Linux IDE Requirements ................................
9 Operator Interface Requirements
9.1 Users of the Control System
10 Widgets ................................................................
10.1 Label................................................................
10.2 LineEdit ................................................................
10.3 PushButton ................................
10.4 Slider ................................................................
10.5 SpinBox................................................................
10.6 Shape ................................................................
10.7 GuiPushButton ................................
10.8 CmdPushButton ................................
10.9 ComboBox ................................
10.10 ASguiForm................................
List of Tables
Table 1 - Australian Synchrotron Qt Documentation
................................................................................................................................
................................................................................................
................................................................................................
ferenced documents................................................................................................
................................................................................................
Australian Synchrotron referenced documents ................................................................
................................................................................................
...............................................................................................................................
................................................................................................
................................................................................................
................................................................................................
Control System Interface Requirements................................................................
................................................................................................
Build System Interface Requirements................................................................
The Australian Synchrotron Formal Build System................................................................
Compatibility with standard Makefile requirements...............................................................
Integrated Development Environment Requirements.............................................................
................................................................................................
................................................................................................
Operator Interface Requirements .............................................................................................
Users of the Control System................................................................................................
................................................................................................
................................................................................................
................................................................................................
...............................................................................................................................
................................................................................................
................................................................................................
................................................................................................
................................................................................................
................................................................................................
................................................................................................................................
............................................................................................................................
Australian Synchrotron Qt Documentation..........................................................
................................4
......................................4
...............................................4
.................................. 4
........................................ 4
..................................... 4
..........................................5
...............................5
.................................................. 5
..................................................... 5
.................................................... 5
..................................................5
........................................ 5
......................................................5
................................. 5
............................... 5
.............................5
.................................... 5
.......................................... 5
.............................6
.................................... 6
......................................6
.......................................... 6
..................................... 6
............................... 6
......................................... 6
..................................... 6
........................................ 6
......................................................... 6
....................................................... 6
................................ 6
............................ 6
..........................4

4. EPICSQt Requirement Specification
1 Introduction
EPICSQt is a combination of the Experimental Physics and Industrial Control System (EPICS)
Channel Access (CA) API extended into the graphical QT framework using C++. It is designed for
rapid development of control system graphical interfaces.
The Qt/C++ Framework provides the Control System Engineers Team with a standard toolkit for
developing GUIs beyond the capabilities of EDM/MEDM for the Australian Synchrotron. It will provide
the team with the ability to write and maintain a single code base which can run
Windows and Linux platforms. It is also intended this will distribute the knowledge of developing GUIs
in Qt/C++ to everyone across the team. O
trained for writing a GUIs for the A
C++ for the Australian Synchrotron
training to develop GUIs for operators and scientists.
2 Purpose
The purpose of this document is t
Australian Synchrotron the Requirements Specification for producing supported GUI Applications
across all sub-systems of the Australian Synchrotron.
Requirements Specification Document at the Qt p
requirement specifications which may or may not exist at a facility
GUIs.
3 Reference documents
3.1 EPICS referenced documents
EPICS Record Reference Manual
http://www.aps.anl.gov/epics/base/R3
3.2 Qt referenced documents
Qt Application Development Framework
http://doc.trolltech.com/
3.3 Australian Synchrotron referenced documents
ASP-DOC-TEC-0003-01
The table below lists the documentation available for using the Qt Framework at the Australian
Synchrotron. The highlighted row
the available AS Qt documentation.
Document
Qt Requirements Specification
Qt Design Specification
Qt Installation Guide
Qt Developers Guide
API Reference Manual
Table
is a combination of the Experimental Physics and Industrial Control System (EPICS)
Channel Access (CA) API extended into the graphical QT framework using C++. It is designed for
rapid development of control system graphical interfaces.
rk provides the Control System Engineers Team with a standard toolkit for
developing GUIs beyond the capabilities of EDM/MEDM for the Australian Synchrotron. It will provide
the team with the ability to write and maintain a single code base which can run
Windows and Linux platforms. It is also intended this will distribute the knowledge of developing GUIs
to everyone across the team. Outcomes would be multiple control systems
for the Australian Synchrotron, a toolkit of EPICS awar
C++ for the Australian Synchrotron and the EPICS community, documentation for the controls team on
training to develop GUIs for operators and scientists.
The purpose of this document is to provide the Instrumentation and Control System Team
the Requirements Specification for producing supported GUI Applications
systems of the Australian Synchrotron. Although this document represents a
ecification Document at the Qt project level, it should still conform to a higher level of
requirement specifications which may or may not exist at a facility-wide level of Operator Interface
Reference documents
EPICS referenced documents
Record Reference Manual
http://www.aps.anl.gov/epics/base/R3-14/8-docs/CAref.html
Qt referenced documents
Qt Application Development Framework
http://doc.trolltech.com/
Australian Synchrotron referenced documents
ASP Choice of Control System Base.
The table below lists the documentation available for using the Qt Framework at the Australian
Synchrotron. The highlighted row indicates the current document and how this document relates to
the available AS Qt documentation.
CM Location Description
11555 Australian Synchrotron Qt GUI Requirements.
11556 Overview of the Qt-EPICS CA functionality.
11557 Installing Qt on Windows™ and Linux operating system.
11554 Developing Qt GUIs for use in the facility.
AS Doxygen Server Open-source code available for Qt
Table 1 - Australian Synchrotron Qt Documentation
is a combination of the Experimental Physics and Industrial Control System (EPICS)
Channel Access (CA) API extended into the graphical QT framework using C++. It is designed for
rk provides the Control System Engineers Team with a standard toolkit for
developing GUIs beyond the capabilities of EDM/MEDM for the Australian Synchrotron. It will provide
the team with the ability to write and maintain a single code base which can run natively in Mac,
Windows and Linux platforms. It is also intended this will distribute the knowledge of developing GUIs
control systems engineers
, a toolkit of EPICS aware widgets written in
and the EPICS community, documentation for the controls team on
tation and Control System Team of the
the Requirements Specification for producing supported GUI Applications
Although this document represents a
roject level, it should still conform to a higher level of
wide level of Operator Interface
The table below lists the documentation available for using the Qt Framework at the Australian
indicates the current document and how this document relates to
Description
Australian Synchrotron Qt GUI Requirements.
EPICS CA functionality.
Installing Qt on Windows™ and Linux operating system.
Developing Qt GUIs for use in the facility.
for Qt-EPICS CA API.

5. EPICSQt Requirement Specification
4 Scope
For the purposes of this document, the following scope restrictions apply:
The requirements specified in this document apply primarily to GUI development following the change
of ownership of the Australian Synchrotron to ASCo.
in the Instrumentation and Control System Requirement
specifically for Accelerator Control Room GUI Applic
5 Components
5.1 The Control System
Experimental Physics and Industrial Control Systems (EPICS)
Synchrotron as the facilities accele
5.2 The Build System
The Formal Software Build System as written by the Australian Synchrotron has been chosen as the
means of managing, building and deploying software acros
5.3 Qt GUI Framework
The Qt GUI Framework has been chosen by t
developing GUI applications across all Australian Synchrotron
6 Control System Interface Requirements
6.1 EPICS
GUIs shall be designed to operate within the context of the tools and facilities provided by the
Experimental Physics and Industrial Control System (EPICS) toolset.
7 Build System Interface Requirements
7.1 The Australian Synchrotron Formal Build System
GUIs shall be implemented
Formal Build System as used by the Australian Synchrotron.
7.2 Compatibility with standard Makefile requirements
A process shall exist for Developers of
project while allowing cross-platform builds to be maintained by the build system.
8 Integrated Development Environment Requirements
8.1 Windows IDE Requirements
Provide a standard framework for a developer of
Windows environment.
8.2 Linux IDE Requirements
Provide a standard framework for a
environment.
For the purposes of this document, the following scope restrictions apply:
The requirements specified in this document apply primarily to GUI development following the change
of ownership of the Australian Synchrotron to ASCo. Operator Interface (OPI) Requirements identified
Instrumentation and Control System Requirement Specification document were written
specifically for Accelerator Control Room GUI Applications.
Experimental Physics and Industrial Control Systems (EPICS) has been chosen
accelerator and beamline Control System Base.
The Formal Software Build System as written by the Australian Synchrotron has been chosen as the
means of managing, building and deploying software across all Australian Synchrotron IOC
The Qt GUI Framework has been chosen by the Australian Synchrotron as a supported technology for
developing GUI applications across all Australian Synchrotron supported OPI systems.
Control System Interface Requirements
igned to operate within the context of the tools and facilities provided by the
Experimental Physics and Industrial Control System (EPICS) toolset.
Build System Interface Requirements
The Australian Synchrotron Formal Build System
and built within the context of the tools and facilities provided by the
Formal Build System as used by the Australian Synchrotron.
Compatibility with standard Makefile requirements
Developers of GUI Applications to maintain a single code
platform builds to be maintained by the build system.
Integrated Development Environment Requirements
Windows IDE Requirements
standard framework for a developer of Qt GUIs to produce applications in a Microsoft
framework for a developer of Qt GUIs to produce applications in a Linux
The requirements specified in this document apply primarily to GUI development following the change
Operator Interface (OPI) Requirements identified
document were written
s been chosen by the Australian
The Formal Software Build System as written by the Australian Synchrotron has been chosen as the
s all Australian Synchrotron IOC systems.
supported technology for
systems.
igned to operate within the context of the tools and facilities provided by the
and built within the context of the tools and facilities provided by the
to maintain a single code-base for a given
produce applications in a Microsoft
produce applications in a Linux

6. EPICSQt Requirement Specification
9 Operator Interface Requirements
9.1 Users of the Control System
Provide a standard framework for a developer of
10 Widgets
10.1 Label
Provide a CA aware Label Widget inherited from the standard Qt Label Widget.
10.2 LineEdit
Provide a CA aware Line Edit Widget
10.3 PushButton
Provide a CA aware Push Button Widget
10.4 Slider
Provide a CA aware Slider Widget
10.5 SpinBox
Provide a CA aware Spin-box Widget
10.6 Shape
Provide a CA aware Shape Widget
10.7 GuiPushButton
Provide a push button, based on the standard Qt Push Button Widget, to open a new ASguiForm
Widget.
10.8 CmdPushButton
Provide a push button, based on the
command.
10.9 ComboBox
Provide a CA aware Combo-box Widget
10.10 ASguiForm
Provide a Form Widget, based
Operator Interface Requirements
Users of the Control System
standard framework for a developer of GUIs as an alternative to EDM/MEDM screens.
Provide a CA aware Label Widget inherited from the standard Qt Label Widget.
CA aware Line Edit Widget inherited from the standard Qt Line Edit Widget.
CA aware Push Button Widget inherited from the standard Qt PushButton Widget.
CA aware Slider Widget inherited from the standard Qt Slider Widget.
box Widget inherited from the standard Qt Spin-box Widget.
CA aware Shape Widget inherited from the standard Qt Shape Widget.
push button, based on the standard Qt Push Button Widget, to open a new ASguiForm
push button, based on the standard Qt Push Button Widget to run an operating system
box Widget will be based on the standard Qt Combo Box Widget.
based on the standard Qt Form widget to read in a Qt User Interface file.
GUIs as an alternative to EDM/MEDM screens.
Qt Line Edit Widget.
inherited from the standard Qt PushButton Widget.
box Widget.
inherited from the standard Qt Shape Widget.
push button, based on the standard Qt Push Button Widget, to open a new ASguiForm
to run an operating system
based on the standard Qt Combo Box Widget.
to read in a Qt User Interface file.