XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


dal (dal-1.198) [xmmsas_20211130_0941-20.0.0]

API Overview

F90 applications must use the module dal, to gain access to the DAL API.

The DAL is concerned with dataset access. A dataset is accessed with the function:

where,

The code extract, shown below, is a typical example of how to use the dataSet() function:

program test
  use dal

  type(DataSetT) set                    ! Declare a dataset handle.

  set = dataSet( "myset", CREATE )      ! Create a dataset called "myset", with
                                        ! the High Memory Mode. A handle of
                                        ! the newly created dataset is returned
                                        ! and assigned to the variable set.

  ! ........................................
  !
  ! Do some operations on the dataset, using
  ! the handle set.
  !
  ! ........................................

  call release( set )                  ! Close the dataset.

end program

The dataset() function returns a handle to a dataset. This handle is used to specify the dataset in subsequent operations. The handle itself is opaque, in that its contents may not be accessed to perform dataset operations. The idea is to think of the handle as being an abstract object called a dataset.

The release function is used to close the dataset (the handle of the dataset is passed as a parameter). The behaviour of the release is dependent on the access mode which was used to access the dataset.

Most DAL procedures(functions and subroutines) require a handle as one of the arguments and/or returns a handle value. In many cases a procedure has been overloaded to operate on objects of different types. These have been provided in the form on interfaces. For example, the release interface operates on datasets, blocks, arrays, tables and columns.



Subsections
XMM-Newton SOC -- 2021-11-30