zd_seismic_set.hpp

/* zd_seismic_set.hpp */
/* $Id: zd_seismic_set.hpp 20080 2009-12-15 15:57:52Z vlad $ */
#ifndef __zd_seismic_set_hpp
#define __zd_seismic_set_hpp

#include "zqb_real_trace.hpp"
#include "zd_seismic_file.hpp"


class ZdSeismicSet : public ZdSeismicFile
{
public:

  typedef std::vector<int>  TraceIdsV;
  
  typedef std::vector<double>   CoordsV;
  

  ZdSeismicSet (const char* szDocName = NULL);


  virtual int       traceCount () const = 0;

  virtual void      getAllTraceIds (TraceIdsV& viTraceIds) const = 0;


  /*
   *  Coordinate based services (see ZdCoordObjStream)
   */

  virtual int       coordCount () const = 0;

  virtual void      setCoordPrecision (double fPrec);
  
  virtual double    getCoordPrecision () const;
  
  virtual int       coordToTraceId (double fCoord,
                    int iEnsIndex = 0) = 0;
  
  virtual void      coordToTraceIds (double fCoord,
                     TraceIdsV& viTraceIds) = 0;
  
  virtual void      getCoords (CoordsV& vfCoords) = 0;
  
  virtual double    traceIdToCoord (int iTraceId,
                    int* piEnsIndex = NULL) = 0;
 

  virtual void resetOrder() {;}
  
  virtual void applyOrder () {;}
  
  /*
   *  Write-only access features
   */

  virtual bool      setHeader (int id, const ZqbHeader& hdr) = 0;

  virtual bool      setTrace (int id, const ZqbRealTrace& rtr) = 0;
  
  virtual bool      setSamples (int id, const float* pSamples) = 0;

  virtual bool          removeTrace(int /*id*/) 
  {return false;}
    
  virtual bool          appendTrace(int /*id*/, const ZqbRealTrace& /*rtr*/) 
  {return false;}

  
  /*
   *  Read-only access features
   */
  
  virtual const ZqbHeader*  headerById (int id) = 0;

  virtual bool          headerById (int id, ZqbHeader& hdr);

  virtual const float*      samplesById (int id) = 0;

  virtual bool          samplesById (int id, float* pSamples);

  virtual const ZqbRealTrace*   traceById (int id) = 0;

  virtual bool          traceById (int id, ZqbRealTrace& rtr);


  /*
   *  Run-time type identification facility
   */

  virtual bool  compatibleType (const char* szType) const;


  /*
   * Time and coord axis meaning. 
   */
  
  virtual const char*       coordMeaning () const {return "Coord";}
  
  virtual const char*       coordUnit () const {return "";}
  
  virtual const char*       timeMeaning () const {return "Time";}
  
  virtual const char*       timeUnit () const {return "ms";}
  
private:

  double        m_fCoordPrec;

  static int        s_iNameCounter;

  static const char     *s_szOwnType;

};


#endif /* zd_seismic_set.hpp */