zd_ldb_seismic.hpp

/* zd_hds_useismic.hpp */
/* $Id:  $ */
#ifndef __zd_ldb_seismic_hpp
#define __zd_ldb_seismic_hpp

#include <vector>

#include <ldb/trset.h>
#include <ldb/trselect.h>

#include <zq4/zqb_header.hpp>
#include <zq4/zd_seismic_set.hpp>

#define ZDUS_EXTRA_HW_SIZE  8

namespace hds
{
  
  class ZdLdbSeismic : public ZdSeismicSet
  {
  public:
    
    struct SortOrder
    {
      int iHdrWord;     
      ZqbOrder eOrder;  
      bool bEnabled;    
    };
    

    ZdLdbSeismic(const char* szDocName = NULL);
       
    ZdLdbSeismic (const char* szProject, const char* szSeisFile,
          int nExtraHW = 0, const char* szDocName = NULL);
    
    ZdLdbSeismic (TrSet* pTS, int nExtraHW = 0, const char* szDocName = NULL);
    
    virtual ~ZdLdbSeismic();
        
    
    /*
     *  Basic information
     */
    
    virtual bool getCoordRange (double c[2]);
    
    virtual double averageCoordStep ();
    
    virtual const ZqbAbstrTrace& tracePar () const;
    
    virtual int traceCount () const;
    
    virtual void getAllTraceIds (TraceIdsV& viTraceIds) const;
    
    
    /*
     *  Coordinate based services (see ZdCoordObjStream)
     */

    virtual int coordCount () const;
    
    virtual int coordToTraceId (double fCoord,
                int iEnsIndex = 0);
    
    virtual void coordToTraceIds (double fCoord,
                 TraceIdsV& viTraceIds);
    
    virtual void getCoords (CoordsV& vfCoords);
    
    virtual double traceIdToCoord (int iTraceId,
                   int* piEnsIndex = NULL);
        
    /*
     *  Write-only access features
     */
    
    virtual bool modify ();
    
    virtual bool isModifiable () const;
    
    virtual bool setHeader (int id, const ZqbHeader& hdr);
    
    virtual bool setTrace (int id, const ZqbRealTrace& rtr);
    
    virtual bool setSamples (int id, const float* pSamples);
    
    
    /*
     *  Read-only access features
     */
    
    virtual const ZqbHeader* headerById (int id);
    
    virtual const float* samplesById (int id);
    
    virtual const ZqbRealTrace* traceById (int id);
    
    
    /*
     * Iterator methods.
     */

    virtual void setCustomCoord(int iCoordId);
    virtual int getCustomCoord() const;

    virtual void setFirstOrder (int iCoordHW,
                ZqbOrder eOrder = Z_O_ASCENT);
    virtual bool getFirstOrder (int &iCoordHW, ZqbOrder &eOrder) const;
    
    virtual void setSecondaryOrder (int iSecondaryHW,
                    ZqbOrder eOrder = Z_O_ASCENT);
    virtual bool getSecondaryOrder (int &iSecondaryHW, ZqbOrder &eOrder) const;

    virtual void setTertiaryOrder (int iTertiaryHW,
                   ZqbOrder eOrder = Z_O_ASCENT);
    virtual bool getTertiaryOrder (int &iTertiaryHW, ZqbOrder &eOrder) const;
    
    
    virtual void setCoordsSelection(const CoordSelectionVec &selCoords)
    {m_vSelectCoords = selCoords;}
    
    virtual const CoordSelectionVec& getCoordsSelection() const
    {return  m_vSelectCoords;}
    
    
    virtual void setInvisibleCoordinates(const CoordSelectionVec &unvisibleCoords)
    {m_vInvisibleCoords = unvisibleCoords;}
    
    virtual const CoordSelectionVec& getInvisibleCoordinates() const
    {return m_vInvisibleCoords;}    
    

    virtual void resetOrder();
    

    
    virtual bool goFirstCoord ();
    
    virtual bool goNextCoord ();
    
    virtual double coord ();
    
    virtual bool visibleCoord ();    

    virtual void* custom(int ens_index = 0,
             ZqbType* pRetType = NULL);
    
    virtual int ensembleLength ();
    
    virtual int maxEnsembleLength ();
    
    virtual const ZqbRealTrace& trace (int ens_index = 0); 
    
    virtual const ZqbHeader&    header (int ens_index = 0); 
    
    virtual int traceId (int ens_index = 0);
    
    int getFieldsCount() const {return TrFieldsCount;}
       
    
    /*
     *  Additional service
     */
    
    virtual void globalAmplInfo (double pfAmm[2]);
    
    virtual const char* coordMeaning () const;
    
    virtual const char* coordUnit () const;
    
    virtual const char* timeMeaning () const;
    
    virtual const char* timeUnit () const;
    
    virtual const ZqbHdrField* headerWordInfo(int hwId) const;

    
    /*
     *  General services
     */
    
    static void initialize (int nExtraHW = 0,
                const ZqbHdrField* pExtraHW = NULL,
                void (*InitExtraHW)(ZqbHeader&) = NULL);
    
    static ZqbType hwType (int hwId);
    
    static ZqbHdrField* hwInfo (int hwId);
    
    
    /*
     *  Local services
     */
    
    bool properOrder () const;
    
    void applyOrder ();
    
    virtual ZqbType coordTypeFromId(int coordId) const;
    

    const TrSet* getTrSetPtr() const {return m_pTS;}
    
  protected:
        
    void constructor ();
        
    TrSet *m_pTS;
        
    TrIndexTable m_it;
    
    ZqbAbstrTrace m_aTrace;
    
    ZqbRealTrace m_EmptyTrace;
    
    std::map<int, ZqbRealTrace*> m_mTraces;
            
    int m_iCurTrace;
    
    int m_nExtraHW;
    
    int m_iCustomCoordId;
    
    static void (*s_initExtraHW)(ZqbHeader&);
    
    UnitId m_eLengthUnitId;
    
    size_t m_CurrentTrsBufferSize;

    std::vector<SortOrder> m_vSortOrders;
    
    ZdCoordObjStream::CoordSelectionVec m_vSelectCoords;
    
    ZdCoordObjStream::CoordSelectionVec m_vInvisibleCoords; 
    
  private:
    
    ZqbRealTrace* make_trace_by_id(int id) const;
    
    void loadProjectAttr (const char* szProject);

    bool m_bIsTSOpened;
    
    static int s_iNameCounter;
    
    static const char *s_szOwnType;
  
    TrMtable *m_pTmpMT;
    
    bool m_bOwnTrSet;
  };
  
}; // hds namespace

#endif /* zd_ldb_seismic.hpp */