TrHdrGen.H

/* TrHdrGen.H */
/* $Id: TrHdrGen.H,v 1.8 2007/07/08 17:22:15 vlad Exp $ */
#ifndef __TrHdrGen_H
#define __TrHdrGen_H


#include <mix/Types.h>
#include <ldb/trset.h>


typedef struct
{
  char      name_well[17];
  double    x_well, y_well;
  double    alt_well;
  double    h_rotor;
  double    datum;

}   WellInfo;


/***********************************************************************
 * Trace header generator.
 */

class TrHdrGen
{
public:

  /* - by existent modification (TEMPLMOD) */
  TrHdrGen (const char* project, const char* nmod);

  /* - by passport in pointed project (PROJECT) */
  /*TrHdrGen (const char* project);*/

  /* - by free-form parameters (FREEFORM) */
  /*TrHdrGen ();*/

  /* Destructor */
  virtual   ~TrHdrGen ();

  /*
   * AUXILIARY ALLOCATION SERVICE
   */

  /* allocate memory for header */
  TrHeader* allocate_header_buffer ();

  /* allocate memory for trace body */
  float*    allocate_body_buffer ();

  /*
   * TRACE GENERATION PROCESS
   */

  /* return sampling rate in target modification (ms) */
  float     get_sampling_rate ();

  /* return samples count in target modification */
  int       get_samples_count ();

  /* return traces count in target modification */
  int       get_traces_count ();

  /* return pointer at template modification table */
  TrMtable* mod_table ();

  /* start of trace headers generation */
  void for_all_traces (int iSP = 0);
  void for_all_depths (int iSP = 0);

  /* go to the next trace and return:
     TRUE  - there are other traces;
     FALSE - no traces left */
  Logic go_next_trace ();

  /* return condition of completeness of the trace generation process:
     TRUE  - there are other traces;
     FALSE - no traces left */
  Logic not_all_traces ();

  /* get unique trace id number */
  int       get_trace_id ();

  /* get current header specification */
  TrHeader* get_header ();

  /* get current header specification */
  TrHeader* get_header (TrHeader* buf);

  /* get header specification for given identification parameters:
     NMGL, COMP and HCAB or return NULL if not found */
  void  get_op_header (TrHeader* pHdr, int iNMGL, float fHcab, char cComp);

  /* Fill well description structure for with data set.  Return TRUE
     on success and FALSE if well information is not reliable. */
  Logic     get_well_info (WellInfo& winfo);

  /* return number of encountered shot points in the seismic */
  int       get_number_of_sp ();

  /* return header (as container for SP-related information and
     geometry) for SP with given index (0 to number of SP - 1) */
  TrHeader* get_sp_header (int iSP);


  /*
   * SETTING PARAMETERS OF TRACE GENERATION PROCESS
   */

private:

  /*
   * TEMPLMOD
   */

  /* index of current trace */
  int       index;

  /* template modification */
  TrSet     templ_mod;

  /* prepare list of shot points */
  void      prepare_it_sp ();

  /* index table for shot points */
  TrIndexTable  it_sp;

  /* cached header with SP information */
  TrHeader  *sp_hdr;
  

};


#endif /* TrHdrGen.H */