[u/mrichter/AliRoot.git] / GEANT321 / giopa / giopa.doc

*
* $Id$
*
* $Log$
* Revision 1.1.1.1  1995/10/24 10:21:16  cernlib
* Geant
*
*
#include "geant321/pilot.h"
#if defined(CERNLIB_DOC)
*CMZ :  3.21/02 29/03/94  15.41.20  by  S.Giani
*-- Author :
*
************************************************************************
*                                                                      *
*                       The I/O service routines                       *
*                       ------------------------                       *
*                                                                      *
*  The  I/O routines  permit  to  read and  write,  the GEANT3  data   *
* structures.   The  possibility  exists  to  write  and  read  data   *
* structures to/from  direct access  files, in machine  dependent or   *
* independent format  and to/from direct  access files.  All  I/O is   *
* done via the  ZEBRA I/O routines both for direct  access files (FZ   *
* package) and for direct access files (RZ package).                   *
*  Data can  be generated on one  type of machine, for  example full   *
* detector simulation,  and the data  produced can be analyzed  on a   *
* different machine.                                                   *
*  The data structures written to tape or disk can be read either in   *
* whole or in part.                                                    *
*                                                                      *
*                                                                      *
*                     Routines to perform I/O                          *
*                     -----------------------                          *
*                                                                      *
*       CALL GCLOSE(LUN, IER)                                          *
*                                                                      *
*   LUN       Logical unit number                                      *
*   IER       Error flag                                               *
*                                                                      *
*  Close sequential  FZ file open  with logical unit LUN.   If LUN=0   *
* close all  FZ files.  IER=1  if the file is  no FZ file  open with   *
* logical unit LUN is found, 0 otherwise.                              *
*                                                                      *
*      CALL GFIN(LUN,CHOBJ,NKEYS,IDVERS,CHOPT,IER)                     *
*                                                                      *
*   LUN       Logical unit number                                      *
*   CHOBJ     CHARACTER*4 array containing the data structures to be   *
*             read (DIGI,DRAW,HEAD,HITS,KINE,MATE,PART,ROTM,RUNG,      *
*             SETS,STAK,STAT,TMED,VERT,VOLU,JXYZ,SCAN). In addition    *
*             the following keywords are defined:                      *
*             INIT = DRAW,MATE,PART,ROTM,RUNG,SETS,TMED,VOLU,SCAN      *
*             KINE = KINE,VERT                                         *
*             TRIG = DIGI,HEAD,HITS,KINE,VERT,JXYZ                     *
*   NKEYS     Number of valid elements in the array CHOBJ              *
*   IDVERS    Version to be retrieved. If IDVERS=0 the first version   *
*             found will be retrieved.                                 *
*   CHOPT     Character option.                                        *
*   IER       Error flag. -1 if nothing has been read in. >0  in not   *
*             all the requested data structures have been read in.     *
*                                                                      *
*                                                                      *
*                                                                      *
*  Routine  to  read GEANT  object(s)  from    a  FZ file  The  data   *
* structures from disk are read in memory.                             *
*                                                                      *
*      CALL GFOUT(LUN,CHOBJ,NKEYS,IDVERS,CHOPT,IER)                    *
*                                                                      *
*  See above for  the parameters.  Routine to  write GEANT object(s)   *
* into a  FZ file  The data  structures are  written from  memory to   *
* disk.                                                                *
*                                                                      *
*      CALL GOPEN(LUN,LUNTYP,LEN,IER)                                  *
*                                                                      *
*   LUN       Logical unit                                             *
*   LUNTYP    CHARACTER variable specifying the format of the FZ       *
*             file. Possible options are I,O,A,X. See the FZ manual    *
*             for more information.                                    *
*   LEN       Logical record length of the FZ file.                    *
*   IER       Error flag. 0 if file has been open correctly.           *
*                                                                      *
*  Routine to open a FZ file for input or output.                      *
*                                                                      *
*      CALL GREND (LUN)                                                *
*                                                                      *
*    LUN      Logical unit                                             *
*                                                                      *
*  Routine to close the RZ direct access file opened with logical      *
* unit LUN.                                                            *
*                                                                      *
*      CALL GRFILE(LUN,CHFILE,CHOPTT)                                  *
*                                                                      *
*    LUN      Logical unit number                                      *
*    CHFILE   Name of the file to be open                              *
*    CHOPTT   Character option                                         *
*                                                                      *
*  Routine to open an  RZ file for input or output.   If option I is   *
* given, then  the INIT data structures  will be read from  the file   *
* and if the option O is given they will be written to the file.       *
*                                                                      *
*      CALL GRIN(CHOBJT,IDVERS,CHOPT)                                  *
*                                                                      *
*   CHOBJT    CHARACTER*4 variable with the name of the data           *
*             structure to be retrieved. See GFIN for more details.    *
*   IDVERS    Version of the data structure to be retrieved. If 0      *
*             the first found data structure will be retrieved.        *
*   CHOPT     Option variable                                          *
*                                                                      *
*  Routine  to  read  from  a  RZ  direct  access  file  GEANT  data   *
* structures.                                                          *
*                                                                      *
*      CALL GRLEAS(JBANK)                                              *
*                                                                      *
*   JBANK     Pointer to a data structure                              *
*                                                                      *
*  Routine to release unused space  in the data structure pointed to   *
* by JBANK.                                                            *
*                                                                      *
*      CALL GRMDIR(CHDIR,CHOPT)                                        *
*                                                                      *
*    CHDIR    Name of the directory                                    *
*    CHOPT    Character option                                         *
*                                                                      *
*  Routine to create a GEANT subdirectory in an RZ file.               *
*                                                                      *
*      CALL GROUT(CHOBJT,IDVERS,CHOPT)                                 *
*                                                                      *
*  Routine  to  write  to  a   RZ  direct  access  file  GEANT  data   *
* structures.  See GRIN for explanations on the parameters.            *
*                                                                      *
************************************************************************
#endif
Commit	Line	Data
fe4da5cc	1	*
	2	* $Id$
	3	*
	4	* $Log$
	5	* Revision 1.1.1.1 1995/10/24 10:21:16 cernlib
	6	* Geant
	7	*
	8	*
	9	#include "geant321/pilot.h"
	10	#if defined(CERNLIB_DOC)
	11	*CMZ : 3.21/02 29/03/94 15.41.20 by S.Giani
	12	*-- Author :
	13	*
	14	************************************************************************
	15	* *
	16	* The I/O service routines *
	17	* ------------------------ *
	18	* *
	19	* The I/O routines permit to read and write, the GEANT3 data *
	20	* structures. The possibility exists to write and read data *
	21	* structures to/from direct access files, in machine dependent or *
	22	* independent format and to/from direct access files. All I/O is *
	23	* done via the ZEBRA I/O routines both for direct access files (FZ *
	24	* package) and for direct access files (RZ package). *
	25	* Data can be generated on one type of machine, for example full *
	26	* detector simulation, and the data produced can be analyzed on a *
	27	* different machine. *
	28	* The data structures written to tape or disk can be read either in *
	29	* whole or in part. *
	30	* *
	31	* *
	32	* Routines to perform I/O *
	33	* ----------------------- *
	34	* *
	35	* CALL GCLOSE(LUN, IER) *
	36	* *
	37	* LUN Logical unit number *
	38	* IER Error flag *
	39	* *
	40	* Close sequential FZ file open with logical unit LUN. If LUN=0 *
	41	* close all FZ files. IER=1 if the file is no FZ file open with *
	42	* logical unit LUN is found, 0 otherwise. *
	43	* *
	44	* CALL GFIN(LUN,CHOBJ,NKEYS,IDVERS,CHOPT,IER) *
	45	* *
	46	* LUN Logical unit number *
	47	* CHOBJ CHARACTER4 array containing the data structures to be
	48	* read (DIGI,DRAW,HEAD,HITS,KINE,MATE,PART,ROTM,RUNG, *
	49	* SETS,STAK,STAT,TMED,VERT,VOLU,JXYZ,SCAN). In addition *
	50	* the following keywords are defined: *
	51	* INIT = DRAW,MATE,PART,ROTM,RUNG,SETS,TMED,VOLU,SCAN *
	52	* KINE = KINE,VERT *
	53	* TRIG = DIGI,HEAD,HITS,KINE,VERT,JXYZ *
	54	* NKEYS Number of valid elements in the array CHOBJ *
	55	* IDVERS Version to be retrieved. If IDVERS=0 the first version *
	56	* found will be retrieved. *
	57	* CHOPT Character option. *
	58	* IER Error flag. -1 if nothing has been read in. >0 in not *
	59	* all the requested data structures have been read in. *
	60	* *
	61	* *
	62	* *
	63	* Routine to read GEANT object(s) from a FZ file The data *
	64	* structures from disk are read in memory. *
65	* *
66	* CALL GFOUT(LUN,CHOBJ,NKEYS,IDVERS,CHOPT,IER) *
67	* *
68	* See above for the parameters. Routine to write GEANT object(s) *
69	* into a FZ file The data structures are written from memory to *
70	* disk. *
71	* *
72	* CALL GOPEN(LUN,LUNTYP,LEN,IER) *
73	* *
74	* LUN Logical unit *
75	* LUNTYP CHARACTER variable specifying the format of the FZ *
76	* file. Possible options are I,O,A,X. See the FZ manual *
77	* for more information. *
78	* LEN Logical record length of the FZ file. *
79	* IER Error flag. 0 if file has been open correctly. *
80	* *
81	* Routine to open a FZ file for input or output. *
82	* *
83	* CALL GREND (LUN) *
84	* *
85	* LUN Logical unit *
86	* *
87	* Routine to close the RZ direct access file opened with logical *
88	* unit LUN. *
89	* *
90	* CALL GRFILE(LUN,CHFILE,CHOPTT) *
91	* *
92	* LUN Logical unit number *
93	* CHFILE Name of the file to be open *
94	* CHOPTT Character option *
95	* *
96	* Routine to open an RZ file for input or output. If option I is *
97	* given, then the INIT data structures will be read from the file *
98	* and if the option O is given they will be written to the file. *
99	* *
100	* CALL GRIN(CHOBJT,IDVERS,CHOPT) *
101	* *
102	* CHOBJT CHARACTER4 variable with the name of the data
103	* structure to be retrieved. See GFIN for more details. *
104	* IDVERS Version of the data structure to be retrieved. If 0 *
105	* the first found data structure will be retrieved. *
106	* CHOPT Option variable *
107	* *
108	* Routine to read from a RZ direct access file GEANT data *
109	* structures. *
110	* *
111	* CALL GRLEAS(JBANK) *
112	* *
113	* JBANK Pointer to a data structure *
114	* *
115	* Routine to release unused space in the data structure pointed to *
116	* by JBANK. *
117	* *
118	* CALL GRMDIR(CHDIR,CHOPT) *
119	* *
120	* CHDIR Name of the directory *
121	* CHOPT Character option *
122	* *
123	* Routine to create a GEANT subdirectory in an RZ file. *
124	* *
125	* CALL GROUT(CHOBJT,IDVERS,CHOPT) *
126	* *
127	* Routine to write to a RZ direct access file GEANT data *
128	* structures. See GRIN for explanations on the parameters. *
129	* *
130	************************************************************************
131	#endif