;+
; Project     :	SOLAR-B - EIS
;
; Name        :	EIS_study_detail__define
;
; Purpose     :	Generates structure EIS_study_detail.
;
; Explanation : When IDL encounters structure 'STRname', if structure not already defined
;               it looks for routine strname__define and compiles and calls routine to define
;               structure. NB under unix it looks for lower case flename.
;
;               This routine defines the structure :
;
;                 EIS_study_detail. Tags are :-
;                   study_identifier         : ULONG uniquely identifies the study to
;                                              the planning databases
;                   description              : STRING mnemonic for either science or engineering study
;                   start_time               : DOUBLE TAI start time of the command
;                                              in the OP store or GSE to run the first EIS
;                                              sequence associated with the study or
;                                              the expected time that the study will
;                                              start if the study is daisy-chained
;                                              to another study or the latest time
;                                              that the study will be used if neither
;                                              of the previous.
;                   time_tagged              : UINT flag indicating whether the study is
;                                              to be set off from the on-board OP store (1)
;                                              or not (0).
;                   duration                 : ULONG indicates the expected duration in
;                                              seconds of a single run through the study.
;                   data                     : ULONG the amount of data in bytes expected
;                                              from running the study.
;                   study_repeat_number      : UINT number of times to repeat the study (1-255).
;                                              NB An EIS sequence table can be repeated
;                                              but if a study spans more than one EIS
;                                              sequence it cannot be repeated a fixed
;                                              number of times (though can be repeated
;                                              indefinitely by daisy-chaining to itself).
;                   linked_study_identifier  : ULONG study identifier of the following
;                                              daisy-chained study. Should be zero if
;                                              no linked study.
;                   slit_slot                : structure of type EIS_CPT_mechanism_change.
;                   engineering              : UINT indicating : (0) science study, (1) engineering study, (2) orl engineering study.
;                   XRT_flare_control_flag   : UINT flag indicating whether study contains one or more XRT
;                                              flare responsive rasters.
;                   EIS_flare_control_flag   : UINT flag indicating whether study contains one or more flare
;                                              hunting rasters.
;                   EIS_event_control_flag   : UINT flag indicating whether study contains one or more event
;                                              hunting rasters.
;                   AEC_control_flag         : UINT flag indicating whether the study contains one or more
;                                              rasters using AEC.
;                   onboard                  : UINT flag indicating whether the study is to be kicked
;                                              off from the onboard OP store (1) or from the GSE (0).
;
; Use         :	<dummy = {EIS_study_detail}>
;
; Inputs      :	None.
;
; Opt. Inputs : None.
;
; Outputs     : Sets up structure definition.
;
; Opt. Outputs:	None.
;
; Keywords    : None,
;
; Calls       : None.
;
; Common      :	None.
;
; Restrictions:	None.
;
; Side effects:	None.
;
; Category    :	EIS_CPT.
;
; Prev. Hist. :	None.
;
; Written     :	Martin Carter RAL 03/08/04
;
; Modified    :	Version 0.1, 16/11/04, MKC
;                 Added description tag.
;               Version 0.2, 09/12/04, MKC
;                 Added slit_slot and coarse_mirror tags.
;               Version 0.3, 17/01/05, MKC
;                 Removed coarse_mirror tag.
;               Version 0.4, 01/03/05, MKC
;                 Add engineering study tag.
;               Version 0.5, 23/03/05, MKC
;                 Add onboard tag.
;               Version 0.6, 23/06/05, MKC
;                 Add event flags.
;                 Changed INT values to UINT.
;
; Version     :	0.6, 23/06/05
;-
;**********************************************************

PRO eis_study_detail__define

  dummy = {EIS_study_detail, $
           study_identifier        : 0UL, $
           description             : '', $
           start_time              : 0.0D0, $
           time_tagged             : 0U, $
           duration                : 0UL, $
           data                    : 0UL, $
           study_repeat_number     : 0U, $
           linked_study_identifier : 0UL, $
           slit_slot               : {eis_mechanism_change}, $
           engineering             : 0U, $
           XRT_flare_control_flag  : 0U, $
           EIS_flare_control_flag  : 0U, $
           EIS_event_control_flag  : 0U, $
           AEC_control_flag        : 0U, $
           onboard                 : 0U }

END