Download XIA Handel library

1
Introduction
This document is still preliminary and intended only for outlining future software designs. Currently, Handel is
in an alpha state and in the midst of an active development cycle. If software is written using this specification,
the writer should expect to make changes to both calling structures and routine names in the near future to
fully conform to the final API. XIA will make every attempt to only change routines with minimal impact on
users, but we cannot guarantee anything at this time. Additionally, since progress is happening rapidly in this
phase of development, XIA will only be supporting the most recent version of Handel that has been released.
This document is intended to aid the data collection programmer in developing software that controls and
reads out data from all XIA x-ray and gamma ray processors. Handel utilizes the functions defined in the
XerXes library, which is provided free of charge from XIA, to build a higher level interface to the hardware,
requiring as little knowledge about the hardware as is reasonable by the end-user. This library is written in
ANSI C and should work on any platform that has a C compiler available, however the mechanism to
communicate with the hardware (e.g. SCSI or EPP drivers) is not guaranteed by XIA and may be left to the
end-user to implement.
The organization of this document is as follows: § 2 introduces some terms that are used throughout this
document; § 3 describes the calling conventions used by the routines that are included with the host software
release; § 4 describes the Handel routines. The final section, § 5, describes all of the files included in the Handel
software release.
If you encounter a bug with the library or have any questions, please contact XIA by sending an email to
[email protected] with the following information:
1)
2)
3)
4)
5)
6)
7)
8)
5
Your name
Your organization
XIA hardware being used
Version of the library
OS
Description of the problem
Steps to take to re-create the bug
Other relevant information