/* ---------------------------------------------------------------------- */ 
/* PulseTypes.h                                                           */ 
/* ---------------------------------------------------------------------- */ 
/*                                                                        */ 
/* (c) Copyright 1999 - 2005  EdgeTech,                                   */ 
/*                                                                        */ 
/* This file contains proprietary information, and trade secrets of       */ 
/* EdgeTech, and may not be disclosed or reproduced without the prior     */ 
/* written consent of EdgeTech.                                           */ 
/*                                                                        */ 
/* EdgeTech is not responsible for the consequences of the use or misuse  */ 
/* of this software, even if they result from defects in it.              */ 
/*                                                                        */ 
/* Defines the standard pulse types which can be returned to describe     */ 
/* pulses in the SonarMessagePingType structure in SonarMessages.         */ 
/* ---------------------------------------------------------------------- */ 

#ifndef __PULSETYPES_H__
#define __PULSETYPES_H__


/* --------------------------------------------------------------------- */ 
/* PulseTypesEnum                                                        */ 
/* --------------------------------------------------------------------- */ 

/* Offset for Standard Subbottom Pulses                                  */ 
#define FISH_SUBBOTTOM       (1)

/* Offset for Deepwater Subbottom Pulses                                 */ 
#define FISH_DWSUBBOTTOM    (16)

/* Offset for Standard Sidescan Pulses                                   */ 
#define FISH_SIDESCAN       (64)

/* Offset for Geoportable Pulses                                         */ 
#define FISH_GEO_SUBBOTTOM (240)


/* --------------------------------------------------------------------- */ 
/* FISH TYPES                                                            */ 
/* --------------------------------------------------------------------- */ 

typedef enum
{

  /* Standard 424 ( 4 kHz - 24 kHz)                                      */ 
  FISH_SB424 = FISH_SUBBOTTOM,

  /* Standard 216 ( 2 kHz - 16 kHz)                                      */ 
  FISH_SB216,

  /* Standard 512 ( 500 Hz - 12 kHz)                                     */ 
  FISH_SB512,


  /* Deep Water 424 ( 4 kHz - 24 kHz)                                    */ 
  FISH_DW424 = FISH_DWSUBBOTTOM,

  /* Deep Water 216 ( 2 kHz - 16 kHz)                                    */ 
  FISH_DW216,

  /* Deep Water 512 ( 500 Hz - 12 kHz)                                   */ 
  FISH_DW512,


  /* Geoportable 216                                                     */ 
  FISH_GEO216 = FISH_GEO_SUBBOTTOM,

  /* Geoportable 424                                                     */ 
  FISH_GEO424,


  /* Standard 75 kHz Size Scan                                           */ 
  FISH_SS75 = FISH_SIDESCAN,

  /* Standard 120 kHz Size Scan                                          */ 
  FISH_SS120,

  /* Standard 400 kHz Size Scan                                          */ 
  FISH_SS400,

  /* Standard 500 kHz Size Scan                                          */ 
  FISH_SS500,


} FishTypeEnum;


/* --------------------------------------------------------------------- */ 
/* PULSE TYPES                                                           */ 
/* --------------------------------------------------------------------- */ 

typedef enum
{

  /* Standard windowed pulse.                                            */ 
  PULSE_STANDARD = 1,

  /* Wideband windowed pulse.                                            */ 
  PULSE_WIDEBAND,

  /* Custom designed pulse                                               */ 
  PULSE_CUSTOM,

  /* Experimental Pulse                                                  */ 
  PULSE_EXPERIMENTAL,
 
} PulseTypesEnum;

#endif  /*__PULSETYPES_H__ */ 

/* --------------------------------------------------------------------- */ 
/*                           end PulseTypes.h                            */ 
/* --------------------------------------------------------------------- */