hds::db::ZdSeismic Class Reference

#include <hds_db_zd_seismic.hpp>

Inheritance diagram for hds::db::ZdSeismic:

Public Member Functions
	ZdSeismic (const char *szDocName=NULL)
virtual	~ZdSeismic ()
hds::db::ErrCode	init (db::Seismic *pseis_db)
virtual const ZqbAbstrTrace &	tracePar () const
virtual int	traceCount () const
virtual void	getAllTraceIds (TraceIdsV &viTraceIds) const
virtual const ZqbRealTrace &	trace (int ens_index=0)
virtual const ZqbHeader &	header (int ens_index=0)
virtual int	getFieldsCount () const
virtual const ZqbHdrField *	headerWordInfo (int hwId) const
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)
virtual bool	getCoordRange (double c[2])
virtual double	averageCoordStep ()
virtual int	maxEnsembleLength ()
virtual bool	goFirstCoord ()
virtual bool	goNextCoord ()
virtual double	coord ()
virtual int	ensembleLength ()
virtual bool	setHeader (int id, const ZqbHeader &hdr)
virtual bool	setTrace (int id, const ZqbRealTrace &rtr)
virtual bool	setSamples (int id, const float *pSamples)
virtual const ZqbHeader *	headerById (int id)
virtual const float *	samplesById (int id)
virtual const ZqbRealTrace *	traceById (int id)
virtual int	traceId (int ens_index=0)
virtual void	setCustomCoord (int iCoordId)
virtual int	getCustomCoord () const
virtual void *	custom (int ens_index, ZqbType *pRetType)
virtual const char *	coordMeaning () const
virtual const char *	coordUnit () const
virtual ZqbType	coordTypeFromId (int coordId) 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)
virtual const CoordSelectionVec &	getCoordsSelection () const
virtual void	applyOrder ()
virtual void	resetOrder ()
Public Member Functions inherited from ZdSeismicSet
	ZdSeismicSet (const char *szDocName=NULL)
virtual void	setCoordPrecision (double fPrec)
virtual double	getCoordPrecision () const
virtual bool	headerById (int id, ZqbHeader &hdr)
virtual bool	samplesById (int id, float *pSamples)
virtual bool	traceById (int id, ZqbRealTrace &rtr)
virtual bool	compatibleType (const char *szType) const
	ZdSeismicSet (const char *szDocName=NULL)
virtual void	setCoordPrecision (double fPrec)
virtual double	getCoordPrecision () const
virtual bool	removeTrace (int)
virtual bool	appendTrace (int, const ZqbRealTrace &)
virtual bool	headerById (int id, ZqbHeader &hdr)
virtual bool	samplesById (int id, float *pSamples)
virtual bool	traceById (int id, ZqbRealTrace &rtr)
virtual bool	compatibleType (const char *szType) const
virtual const char *	timeMeaning () const
virtual const char *	timeUnit () const
Public Member Functions inherited from ZdSeismicFile
	ZdSeismicFile (const char *szDocName=NULL)
virtual bool	modify ()
virtual bool	isModifiable () const
virtual bool	setSamples (const float *pSamples, int ens_index=0)
virtual bool	setHeader (const ZqbHeader &hdr, int ens_index=0)
virtual bool	setTrace (const ZqbRealTrace &rtr, int ens_index=0)
virtual void	globalAmplInfo (double pfAmm[2])
	ZdSeismicFile (const char *szDocName=NULL)
virtual const ZqbHeader *	defHeaderPar () const
virtual bool	modify ()
virtual bool	isModifiable () const
virtual bool	setSamples (const float *pSamples, int ens_index=0)
virtual bool	setHeader (const ZqbHeader &hdr, int ens_index=0)
virtual bool	setTrace (const ZqbRealTrace &rtr, int ens_index=0)
virtual double	customCoord ()
virtual void	globalAmplInfo (double pfAmm[2])
Public Member Functions inherited from ZdCoordObjStream
	ZdCoordObjStream (const char *szDocName=NULL)
virtual void	setCustomCoord (int iCoordId, ZqbOrder eOrder=Z_O_ASCENT)
	ZdCoordObjStream (const char *szDocName=NULL)
virtual void	setInvisibleCoordinates (const CoordSelectionVec &unvisibleCoords)
virtual const CoordSelectionVec &	getInvisibleCoordinates () const
virtual bool	visibleCoord ()
Public Member Functions inherited from ZdDocument
	ZdDocument (const char *szName=NULL)
virtual	~ZdDocument ()
virtual void	updateViews ()
virtual bool	isChanged ()
virtual void	setChanges ()
virtual void	resetChanges ()
	ZdDocument (const char *szName=NULL)
virtual	~ZdDocument ()
virtual void	updateViews ()
virtual bool	isChanged ()
virtual void	setChanges ()
virtual void	resetChanges ()
Public Member Functions inherited from ZqbAutoName
	ZqbAutoName (int *pCounter, const char *szRoot, const char *szCustomName=NULL)
virtual	~ZqbAutoName ()
	ZqbAutoName (int *pCounter, const char *szRoot, const char *szCustomName=NULL)
virtual	~ZqbAutoName ()
Public Member Functions inherited from ZqbName
	ZqbName (const char *szRoot, const char *szCustomName=NULL)
	ZqbName (const ZqbName &name)
virtual	~ZqbName ()
ZqbName &	operator= (const ZqbName &name)
virtual const char *	getName () const
virtual const char *	getType () const
bool	hasName (const char *szString) const
	ZqbName (const char *szRoot, const char *szCustomName=NULL)
	ZqbName (const ZqbName &name)
virtual	~ZqbName ()
ZqbName &	operator= (const ZqbName &name)
virtual const char *	getName () const
virtual const char *	getType () const
bool	hasName (const char *szString) const

Protected Attributes
hds::db::Seismic *	mp_seis_db
Protected Attributes inherited from ZdDocument
ZqbViewVector	m_Views
Protected Attributes inherited from ZqbName
char *	m_szName
char *	m_szRoot

Additional Inherited Members
Public Types inherited from ZdSeismicSet
typedef std::vector< int >	TraceIdsV
typedef std::vector< double >	CoordsV
typedef std::vector< int >	TraceIdsV
typedef std::vector< double >	CoordsV
Public Types inherited from ZdCoordObjStream
typedef std::vector < CoordSelection >	CoordSelectionVec

Detailed Description

Seismic document connected to database.

Constructor & Destructor Documentation

hds::db::ZdSeismic::ZdSeismic

(

const char *

szDocName = NULL

)

Create empty seismic document.

virtual hds::db::ZdSeismic::~ZdSeismic ( )

virtual

Destructor.

Member Function Documentation

virtual void hds::db::ZdSeismic::applyOrder ( )

virtual

Called to apply order changes but before iterations started.

Reimplemented from ZdSeismicSet.

virtual double hds::db::ZdSeismic::averageCoordStep ( )

virtual

Get average primary coordinate step between objects.

Implements ZdCoordObjStream.

virtual double hds::db::ZdSeismic::coord ( )

virtual

Get current coordinate in case of previous go???Coord()

succeeded.

Implements ZdCoordObjStream.

virtual int hds::db::ZdSeismic::coordCount ( ) const

virtual

Returns number of different coordinates.

Implements ZdSeismicSet.

virtual const char* hds::db::ZdSeismic::coordMeaning ( ) const

virtual

Physical meaning of custom coordinate value. "Coord" by

default.

Reimplemented from ZdSeismicSet.

virtual int hds::db::ZdSeismic::coordToTraceId ( double  fCoord, int  iEnsIndex = 0  )

virtual

Try to find coordinate in the seismic set and return id of the

trace found. Ensemble index is taken into account too.

Implements ZdSeismicSet.

virtual void hds::db::ZdSeismic::coordToTraceIds ( double  fCoord, TraceIdsV &  viTraceIds  )

virtual

Return all trace ids which match given coordinate with known

precision.

Implements ZdSeismicSet.

virtual ZqbType hds::db::ZdSeismic::coordTypeFromId ( int  coordId ) const

virtual

Get type of the coordinate from provided coordinate id.

Reimplemented from ZdCoordObjStream.

virtual const char* hds::db::ZdSeismic::coordUnit ( ) const

virtual

Unit of measure for custom coordinate. "" by default.

Reimplemented from ZdSeismicSet.

virtual void* hds::db::ZdSeismic::custom ( int  ens_index, ZqbType *  pRetType  )

virtual

Return current custom coord  of the current trace of the stream with given

index inside the ensemble.

Reimplemented from ZdCoordObjStream.

virtual int hds::db::ZdSeismic::ensembleLength ( )

virtual

Get number of records found for this primary coordinate (always

>=1).

Implements ZdCoordObjStream.

virtual void hds::db::ZdSeismic::getAllTraceIds ( TraceIdsV &  viTraceIds ) const

virtual

Returns all trace ids.

Implements ZdSeismicSet.

virtual bool hds::db::ZdSeismic::getCoordRange ( double  c[2] )

virtual

Get range of primary coordinates respecting order of the stream

or return false in case of empty range.

Implements ZdCoordObjStream.

virtual void hds::db::ZdSeismic::getCoords ( CoordsV &  vfCoords )

virtual

Return all different coordinates.

Implements ZdSeismicSet.

virtual const CoordSelectionVec& hds::db::ZdSeismic::getCoordsSelection ( ) const

inlinevirtual

Get current coordinates selection.

Reimplemented from ZdCoordObjStream.

virtual int hds::db::ZdSeismic::getCustomCoord ( ) const

virtual

Get current custom coord id.

Reimplemented from ZdCoordObjStream.

virtual int hds::db::ZdSeismic::getFieldsCount ( ) const

virtual

Get number of fields in trace header.

Implements ZdSeismicFile.

virtual bool hds::db::ZdSeismic::getFirstOrder ( int &  iCoordId, ZqbOrder &  eOrder  ) const

virtual

Get first coordinate and it's order. Return false if not defined.

Reimplemented from ZdCoordObjStream.

virtual bool hds::db::ZdSeismic::getSecondaryOrder ( int &  iCoordId, ZqbOrder &  eOrder  ) const

virtual

Get secondary coordinate and it's order. Return false if not defined.

Reimplemented from ZdCoordObjStream.

virtual bool hds::db::ZdSeismic::getTertiaryOrder ( int &  iCoordId, ZqbOrder &  eOrder  ) const

virtual

Get tertiary coordinate and it's order. Return false if not defined.

Reimplemented from ZdCoordObjStream.

virtual bool hds::db::ZdSeismic::goFirstCoord ( )

virtual

Reset iterator.  Returns \b true on success and \b false on

failure (empty stream).

Implements ZdCoordObjStream.

virtual bool hds::db::ZdSeismic::goNextCoord ( )

virtual

Go to next iteration.  Returns \b true on success and \b false

on failure (end of stream).

Implements ZdCoordObjStream.

virtual const ZqbHeader& hds::db::ZdSeismic::header ( int  ens_index = 0 )

virtual

Return header of the current trace of the stream with given

index inside the ensemble.

Reimplemented from ZdSeismicFile.

virtual const ZqbHeader* hds::db::ZdSeismic::headerById ( int  id )

virtual

Returns pointer to the header of the trace with given id.

Returns NULL if there is no such id in seismic set now.

Implements ZdSeismicSet.

virtual const ZqbHdrField* hds::db::ZdSeismic::headerWordInfo ( int  hwId ) const

virtual

Return full description of given header word.

Reimplemented from ZdSeismicFile.

hds::db::ErrCode hds::db::ZdSeismic::init

(

db::Seismic *

pseis_db

)

Initialize document with provided database seismic. 

Just copy a database seismic object pointer.

Parameters

pseis_db

Pointer to database seismic object. May be NULL, document will be uninitialized.

Returns

EC_NO_ERROR if all ok.

virtual int hds::db::ZdSeismic::maxEnsembleLength ( )

virtual

Get maximum length of ensemble. 0 means unknown.

Implements ZdCoordObjStream.

virtual void hds::db::ZdSeismic::resetOrder ( )

virtual

Reset seismic coordinates order and selection.

Reimplemented from ZdSeismicSet.

virtual const float* hds::db::ZdSeismic::samplesById ( int  id )

virtual

Returns pointer to the samples of the trace with given id.

Returns NULL if there is no such id in seismic set now.

Implements ZdSeismicSet.

virtual void hds::db::ZdSeismic::setCoordsSelection ( const CoordSelectionVec &  selCoords )

inlinevirtual

Set selection of the coordinates.

Reimplemented from ZdCoordObjStream.

virtual void hds::db::ZdSeismic::setCustomCoord ( int  iCoordId )

virtual

Set custom coordinate. The values returned by custom() method.

Reimplemented from ZdCoordObjStream.

virtual void hds::db::ZdSeismic::setFirstOrder ( int  iCoordHW, ZqbOrder  eOrder = Z_O_ASCENT  )

virtual

Set custom primary seismic coordinate.

Reimplemented from ZdCoordObjStream.

virtual bool hds::db::ZdSeismic::setHeader ( int  id, const ZqbHeader &  hdr  )

virtual

Set the header of trace with given id to the hdr contents and

return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implements ZdSeismicSet.

virtual bool hds::db::ZdSeismic::setSamples ( int  id, const float *  pSamples  )

virtual

Set the trace samples with given id to the pSamples contents and

return true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implements ZdSeismicSet.

virtual void hds::db::ZdSeismic::setSecondaryOrder ( int  iSecondaryHW, ZqbOrder  eOrder = Z_O_ASCENT  )

virtual

Set custom secondary seismic coordinate.

Reimplemented from ZdCoordObjStream.

virtual void hds::db::ZdSeismic::setTertiaryOrder ( int  iTertiaryHW, ZqbOrder  eOrder = Z_O_ASCENT  )

virtual

Set custom tertiary seismic coordinate.

Reimplemented from ZdCoordObjStream.

virtual bool hds::db::ZdSeismic::setTrace ( int  id, const ZqbRealTrace &  rtr  )

virtual

Set the trace with given id to the rtr contents and return \b

true if succeeded and false otherwise. Failure may be if id is not found and if seismic set is not modifiable just now.

Implements ZdSeismicSet.

virtual const ZqbRealTrace& hds::db::ZdSeismic::trace ( int  ens_index = 0 )

virtual

Return current trace of the stream with given index inside the

ensemble.

Implements ZdSeismicFile.

virtual const ZqbRealTrace* hds::db::ZdSeismic::traceById ( int  id )

virtual

Returns pointer to the trace with given id.  Returns NULL if

there is no such id in seismic set now.

Implements ZdSeismicSet.

virtual int hds::db::ZdSeismic::traceCount ( ) const

virtual

Returns number of traces.

Implements ZdSeismicSet.

virtual int hds::db::ZdSeismic::traceId ( int  ens_index = 0 )

virtual

Get unique trace index which can be associated with underlying

trace db or trace file. It's guaranteed the the index is unique among traces of the same seismic stream.

Implements ZdSeismicFile.

virtual double hds::db::ZdSeismic::traceIdToCoord ( int  iTraceId, int *  piEnsIndex = NULL  )

virtual

Return coordinate of given trace and optionally returns its

ensemble index.

Implements ZdSeismicSet.

virtual const ZqbAbstrTrace& hds::db::ZdSeismic::tracePar ( ) const

virtual

Get common trace parameters.

Implements ZdSeismicFile.

Member Data Documentation

hds::db::Seismic* hds::db::ZdSeismic::mp_seis_db

protected

< Seismic data base object pointer.

---

The documentation for this class was generated from the following file:

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/hds_db_bridge/hds_db_zd_seismic.hpp