;+
; Project     :	SOLAR-B - EIS
;
; Name        :	EIS_CPT_CHECK_EIS_FLARE_PARAMETERS
;
; Purpose     :	Checks the EIS flare parameters are valid.
;
; Explanation : Checks the EIS flare parameters are valid.
;
; Use         :	< result = eis_cpt_eis_flare_parameters ( eis_flare_parameters) >
;
; Inputs      : EIS_flare_parameters : STRUCTURE of type EIS_flare_parameters.
;
; Opt. Inputs : None.
;
; Outputs     : result   : status flag
;                       0 : if checks failed.
;                       1 : checks OK.
;
; Opt. Outputs:	None.
;
; Keywords    : None.
;
; Calls       : None.
;
; Common      :	None.
;
; Restrictions:	None.
;
; Side effects:	None.
;
; Category    :	EIS_CPT.
;
; Prev. Hist. :	None.
;
; Written     :	Martin Carter RAL 22/06/05
;
; Modified    :	Version 0.0, 22/06/05, MKC
;
; Version     :	Version 0.0, 22/06/05
;-
;**********************************************************

FUNCTION eis_cpt_check_eis_flare_parameters, EIS_flare_parameters

  ; left_repointing          : INT flag indicating whether to add (1) or subtract (0)
  ;                            to fine mirror position. Must be set to 0.

  IF EIS_flare_parameters.left_repointing NE 0 THEN BEGIN

    eis_cpt_message, 'INVALID EIS FLARE PARAMETER : LEFT_REPOINTING'

    GOTO, error

  ENDIF

  ; right_repointing         : INT flag indicating whether to add (1) or subtract (0)
  ;                            to fine mirror position. Must be set to 1.

  IF EIS_flare_parameters.right_repointing NE 1 THEN BEGIN

    eis_cpt_message, 'INVALID EIS FLARE PARAMETER : RIGHT_REPOINTING'

    GOTO, error

  ENDIF

  ; EIS_P_Size               : INT 100* EIS pixel size in arcseconds, range 1-255.

  IF EIS_flare_parameters.EIS_P_Size EQ 0 OR $
     EIS_flare_parameters.EIS_P_Size GT 255 THEN BEGIN

    eis_cpt_message, 'INVALID EIS FLARE PARAMETER : EIS_P_SIZE'

    GOTO, error

  ENDIF

  ; return OK flag

  RETURN, 1

error :

  ; issue routine name

  MESSAGE, 'ERROR', /INFORMATIONAL

  ; return error flag

  RETURN, 0

END