next up previous contents
Next: Tabular-Data Column Definition Up: Structure of the SDDS Previous: Structure of the SDDS   Contents

Data Set Description

&description 
    STRING text = NULL
    STRING contents = NULL
&end

This optional command describes the data set in terms of two strings. The first, text, is an informal description that is intended principly for human consumption. The second, contents, is intended to formally specify the type of data stored in a data set. Most frequently, the contents field is used to record the name of the program that created or most recently modified the file.

Example:

&description
        text = "Twiss parameters for APS lattice",
        contents = "Twiss parameters"
&end

Note: In many cases it is best to use a string parameter for descriptive text instead of the description command. The reason is that the Toolkit programs will allow manipulation of a string parameter.



Robert Soliday 2014-01-28