CERN home page CERN home page Consult pages Consult pages Writeups at CERN Writeups at CERN Garfield pages Garfield pages Help Help This page This page Table of contents Keyword index

dataset


format

Each member in a Garfield library has a name and a type, neither of which needs to be unique.

The member name is usually specified by the user and is only required if a dataset contains several members of the same type, e.g. two cell descriptions.

The type is chosen by Garfield and is used to ensure that e.g. the cell description reading routine doesn't attempt to read a signal. Thus, you may give the cell and track descriptions associated with a single chamber the same member name, and you can therefore use nearly identical GET statements in the cell, gas and signal sections.

In addition to the name and a type, a remark string can be attached to a member. This string is chosen by the user and is meant to make identification of the member easier.

Garfield libraries are on most computers variable record length sequential files to the operating system. On IBM, the datasets are opened with a fixed record length of 133.

The first record is a line of length 133 which is only there to make sure the operating system doesn't reduce the record length between successive accesses. This record is written automatically when a new file is opened.

Each member starts with a header record formatted as follows:

Character Contents
1 a percent sign (%) to indicate the start of a member
2 a blank, changed to 'X' if the member is deleted
3-10 the string "Created "
11-18 day (dd/mm/yy) on which the member was written
19-22 the string " at "
23-30 time (hh.mm.ss) at which the member was written
31 is blank
32-39 member name
40 is blank
41-48 type of the member
49 is blank
50-80 remark (char 51-79) surrounded by double quotes


type

The type given to a member is chosen by the program according to the following scheme:

Type Description Main user
ARRIVAL Output of the ARRIVAL instruction User
CELL Compact format cell description Internal
ISOCHRON Equal time contours (isochrones) User
GAS Compact format gas description Internal
GRAPHCOL Colour table Internal
GRAPHREP Representation table Internal
HIST Histograms Both
MATRIX Matrices Internal
MINIMUM Output from the MINIMISE instruction User
OUTPUT General output User
SIGNAL Signals User
TRACK Prepared tracks Internal
TRANSLAT Input translation table Internal
XTPLOT Output from the XT-PLOT instruction User

Types marked "User" are intended for use by the user and can freely be modified. Types marked "Internal" are not meant to be of use to the user, and should also not be modified.


DEFAULT

Is very similar to Vax/VMS SET DEFAULT command: it enables setting defaults for any component of Vax/VMS file names (node, disk, directory, file name, file type and version number) and of VM/CMS file names (file name, file type and file mode).

This command can not be issued from within a dataset subsection.

Format:

% DEFAULT file_specification

Examples:

% DEF
% DEF 'VAXODIE::'
%default .GARFLIB

The first example shows the current default, the second tells Garfield that it should try to find the files on the node called VAXODIE (note the quotes, the colons are separators and would be discarded without the quotes). The last example ensures that the libraries to be read and written have extension GARFLIB.


DELETE

Marks a member in a dataset for removal. Removing members physically from a dataset is done by PURGE . RECOVER will undo a %DELETE. Both the member and the type may be wildcards (a * matches every string).

Format:

%DELETE dsname member [type]

DUMP-HELP-FILE

Prints the complete contents of the help file, this command does not exist on Vax computers.

Beware ... this command will generate a huge amount of output !


EXIT

Leaves a dataset subsection. You enter a dataset subsection by typing only a % sign with further arguments. Within such a section, no other subsections may be entered, neither may you leave the calling section from within the subsection.

Format:

EXIT

INDEX

Produces a directory listing of members in a dataset.

The member and type, if you give them at all, may be wildcards, i.e. a * matches any number of every character. Only the members that match both will be in the list.

Also the INQUIRE_MEMBER procedure can be used to determine whether a member exists in a dataset.

Format:

%INDEX dsname [member] [type]

LIST

Types the contents of some member to the output. You may optionally request listing of only one type of member, note however that both the member and the type may be of the wildcard type (a * matches any string).

Format:

%LIST dsname [member] [type]

PACK-HELP-FILE

Packs the readable help file into a direct access file which is used by the on-line help utility. There should be no need to execute this command at CERN. Elsewhere, it has to be executed only once when a new release of the help file is distributed.

The VMS help utility is used on Vax computers. This instruction will therefore create a help library rather than a direct access dataset on such devices.

Before this command is executed, one has to ensure that the readable (or raw) help file is available. It is distributed as:

CMS
GARFIELD RAWHELP
Apollo, Cray, Sun
help_raw$garfield
Vax
GARFIELD.HLP (accessed as HELP_RAW$GARFIELD)

This command is not executed if a direct access help file exists when the command is entered, except on Vax where a new version of the library is generated.


PURGE

This instruction removes deleted members from a dataset. No recovery is possible unless you made a backup yourself. Member and type may not be specified.

Format:

%PURGE dsname

RECOVER

Recovers deleted members from a dataset that has not yet been purged. Both the member and the type may be of the wildcard type (a * matches every string).

Format:

%RECOVER dsname member [type]

Go to the top level, to dataset, to the topic index or to the table of contents.

Formatted on 0103-05-16 at 14:05.