UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Classes | Public Types | Public Member Functions | List of all members
ZdCoordObjStream Class Referenceabstract

#include <zd_coord_obj_stream.hpp>

Inheritance diagram for ZdCoordObjStream:
ZdDocument ZdDocument ZqbAutoName ZqbAutoName ZqbAutoName ZqbAutoName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZqbName ZdCoordObj< T > ZdCoordObj< T > ZdLithData ZdLithData ZdSeismicFile ZdSeismicFile ZqCustomScale::DefCoordObjStream ZdLithVector ZdLithVector ZdLithVector ZdLithVector ZdSeismicSet ZdSeismicSet ZdSeismicSet ZdSeismicSet

Classes

union  CoordArgVal
 
struct  CoordSelection
 

Public Types

typedef std::vector
< CoordSelection > 		CoordSelectionVec
 

Public Member Functions

 ZdCoordObjStream (const char *szDocName=NULL)
 
virtual void setCustomCoord (int iCoordId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual void setSecondaryOrder (int iSecondaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual void setTertiaryOrder (int iTertiaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getCoordRange (double c[2])=0
 
virtual double averageCoordStep ()=0
 
virtual int maxEnsembleLength ()=0
 
virtual bool goFirstCoord ()=0
 
virtual bool goNextCoord ()=0
 
virtual double coord ()=0
 
virtual int ensembleLength ()=0
 
virtual void * custom (int ens_index=0, ZqbType *pRetType=NULL)
 
 ZdCoordObjStream (const char *szDocName=NULL)
 
virtual void setCustomCoord (int iCoordId)
 
virtual int getCustomCoord () const
 
virtual void setFirstOrder (int iCoordId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getFirstOrder (int &iCoordId, ZqbOrder &eOrder) const
 
virtual void setSecondaryOrder (int iSecondaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getSecondaryOrder (int &iCoordId, ZqbOrder &eOrder) const
 
virtual void setTertiaryOrder (int iTertiaryId, ZqbOrder eOrder=Z_O_ASCENT)
 
virtual bool getTertiaryOrder (int &iCoordId, ZqbOrder &eOrder) const
 
virtual void setCoordsSelection (const CoordSelectionVec &selCoords)
 
virtual const CoordSelectionVec & getCoordsSelection () const
 
virtual void setInvisibleCoordinates (const CoordSelectionVec &unvisibleCoords)
 
virtual const CoordSelectionVec & getInvisibleCoordinates () const
 
virtual bool getCoordRange (double c[2])=0
 
virtual double averageCoordStep ()=0
 
virtual int maxEnsembleLength ()=0
 
virtual bool goFirstCoord ()=0
 
virtual bool goNextCoord ()=0
 
virtual double coord ()=0
 
virtual bool visibleCoord ()
 
virtual int ensembleLength ()=0
 
virtual void * custom (int ens_index=0, ZqbType *pRetType=NULL)
 
virtual ZqbType coordTypeFromId (int coordId) const
 
- Public Member Functions inherited from ZdDocument
 ZdDocument (const char *szName=NULL)
 
virtual ~ZdDocument ()
 
virtual bool compatibleType (const char *szType) const
 
virtual void updateViews ()
 
virtual bool isChanged ()
 
virtual void setChanges ()
 
virtual void resetChanges ()
 
 ZdDocument (const char *szName=NULL)
 
virtual ~ZdDocument ()
 
virtual bool compatibleType (const char *szType) const
 
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
 

Additional Inherited Members

- Protected Attributes inherited from ZdDocument
ZqbViewVector m_Views
 
- Protected Attributes inherited from ZqbName
char * m_szName
 
char * m_szRoot
 

Detailed Description

Abstract class for stream of items ordered by some coordinate. Several items may have the same coordinate (so called 'ensemble').

Member Typedef Documentation

typedef std::vector<CoordSelection> ZdCoordObjStream::CoordSelectionVec

Vector of the selected coordinates with it's arguments.

Constructor & Destructor Documentation

ZdCoordObjStream::ZdCoordObjStream ( const char *  szDocName = NULL)

Just for producing automatic name and RTTI.

ZdCoordObjStream::ZdCoordObjStream ( const char *  szDocName = NULL)

Just for producing automatic name and RTTI.

Member Function Documentation

virtual double ZdCoordObjStream::averageCoordStep ( )
pure virtual

Get average primary coordinate step between objects.

Implemented in ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, ZqCustomScale::DefCoordObjStream, hds::db::ZdSeismic, ZdUSeismic, and hds::ZdLdbSeismic.

virtual double ZdCoordObjStream::averageCoordStep ( )
pure virtual

Get average primary coordinate step between objects.

Implemented in ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, ZqCustomScale::DefCoordObjStream, hds::db::ZdSeismic, ZdUSeismic, and hds::ZdLdbSeismic.

virtual double ZdCoordObjStream::coord ( )
pure virtual

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

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual double ZdCoordObjStream::coord ( )
pure virtual

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

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual ZqbType ZdCoordObjStream::coordTypeFromId ( int  coordId) const
virtual

Get type of the coordinate from provided coordinate id. Undefined type by default.

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual void* ZdCoordObjStream::custom ( int  ens_index = 0,
ZqbType *  pRetType = NULL 
)
inlinevirtual

Get the pointer to some custom value for the current coordinate or return NULL if no such value is defined. A type is returned in optional pRetType. Until the next call pointee contents rest the same.

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual void* ZdCoordObjStream::custom ( int  ens_index = 0,
ZqbType *  pRetType = NULL 
)
virtual

Get the pointer to some custom value for the current coordinate or return NULL if no such value is defined. A type is returned in optional pRetType. Until the next call pointee contents rest the same.

Reimplemented in hds::ZdLdbSeismic, ZdUSeismic, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual int ZdCoordObjStream::ensembleLength ( )
pure virtual

Get number of records found for this primary coordinate (always >=1).

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, hds::db::ZdSeismic, ZqCustomScale::DefCoordObjStream, ZdLithData, and ZdLithData.

virtual int ZdCoordObjStream::ensembleLength ( )
pure virtual

Get number of records found for this primary coordinate (always >=1).

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, hds::db::ZdSeismic, ZqCustomScale::DefCoordObjStream, ZdLithData, and ZdLithData.

virtual bool ZdCoordObjStream::getCoordRange ( double  c[2])
pure virtual

Get range of primary coordinates respecting order of the stream or return false in case of empty range.

Implemented in ZdLithVector, ZdLithVector, ZdCoordObj< T >, ZdCoordObj< T >, ZqCustomScale::DefCoordObjStream, hds::db::ZdSeismic, ZdUSeismic, and hds::ZdLdbSeismic.

virtual bool ZdCoordObjStream::getCoordRange ( double  c[2])
pure virtual

Get range of primary coordinates respecting order of the stream or return false in case of empty range.

Implemented in ZdLithVector, ZdLithVector, ZdCoordObj< T >, ZdCoordObj< T >, ZqCustomScale::DefCoordObjStream, hds::db::ZdSeismic, ZdUSeismic, and hds::ZdLdbSeismic.

virtual const CoordSelectionVec& ZdCoordObjStream::getCoordsSelection ( ) const
virtual

Get current coordinates selection. Empty vector of the coordinates returned by default.

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual int ZdCoordObjStream::getCustomCoord ( ) const
inlinevirtual

Get current custom coord id. Should be reimplemented.

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdCoordObjStream::getFirstOrder ( int &  iCoordId,
ZqbOrder &  eOrder 
) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual const CoordSelectionVec& ZdCoordObjStream::getInvisibleCoordinates ( ) const
virtual

Coordinates to be unvisible.

Reimplemented in hds::ZdLdbSeismic.

virtual bool ZdCoordObjStream::getSecondaryOrder ( int &  iCoordId,
ZqbOrder &  eOrder 
) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdCoordObjStream::getTertiaryOrder ( int &  iCoordId,
ZqbOrder &  eOrder 
) const
virtual

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

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual bool ZdCoordObjStream::goFirstCoord ( )
pure virtual

Reset iterator. Returns true on success and false on failure (empty stream).

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual bool ZdCoordObjStream::goFirstCoord ( )
pure virtual

Reset iterator. Returns true on success and false on failure (empty stream).

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual bool ZdCoordObjStream::goNextCoord ( )
pure virtual

Go to next iteration. Returns true on success and false on failure (end of stream).

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual bool ZdCoordObjStream::goNextCoord ( )
pure virtual

Go to next iteration. Returns true on success and false on failure (end of stream).

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, ZdLithVector, ZdLithVector, hds::db::ZdSeismic, and ZqCustomScale::DefCoordObjStream.

virtual int ZdCoordObjStream::maxEnsembleLength ( )
pure virtual

Get maximum length of ensemble. 0 means unknown.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, hds::db::ZdSeismic, ZqCustomScale::DefCoordObjStream, ZdLithData, and ZdLithData.

virtual int ZdCoordObjStream::maxEnsembleLength ( )
pure virtual

Get maximum length of ensemble. 0 means unknown.

Implemented in hds::ZdLdbSeismic, ZdUSeismic, ZdCoordObj< T >, ZdCoordObj< T >, hds::db::ZdSeismic, ZqCustomScale::DefCoordObjStream, ZdLithData, and ZdLithData.

virtual void ZdCoordObjStream::setCoordsSelection ( const CoordSelectionVec &  selCoords)
virtual

Set selection of the coordinates.

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual void ZdCoordObjStream::setCustomCoord ( int  iCoordId,
ZqbOrder  eOrder = Z_O_ASCENT 
)
virtual

Set custom primary coordinate and items order. May be not available in derivations. May be implemented partially - only id or only order is interpreted.

Reimplemented in ZdUSeismic.

virtual void ZdCoordObjStream::setCustomCoord ( int  iCoordId)
virtual

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

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual void ZdCoordObjStream::setFirstOrder ( int  iCoordId,
ZqbOrder  eOrder = Z_O_ASCENT 
)
virtual

Set primary coordinate items order. May be not available in derivations. May be implemented partially - only id or only order is interpreted.

Reimplemented in hds::ZdLdbSeismic, and hds::db::ZdSeismic.

virtual void ZdCoordObjStream::setInvisibleCoordinates ( const CoordSelectionVec &  unvisibleCoords)
virtual

Set coordinates to be unvisible.

Reimplemented in hds::ZdLdbSeismic.

virtual void ZdCoordObjStream::setSecondaryOrder ( int  iSecondaryId,
ZqbOrder  eOrder = Z_O_ASCENT 
)
virtual

Set custom secondary coordinate and items order. Does not affect iterator methods and and getCoordRange() but changes order of items with the same primary coordinate. May be not available in derivations. May be implemented partially - only id or only order is interpreted.

Reimplemented in hds::ZdLdbSeismic, hds::db::ZdSeismic, and ZdUSeismic.

virtual void ZdCoordObjStream::setSecondaryOrder ( int  iSecondaryId,
ZqbOrder  eOrder = Z_O_ASCENT 
)
virtual

Set custom secondary coordinate and items order. Does not affect iterator methods and and getCoordRange() but changes order of items with the same primary coordinate. May be not available in derivations. May be implemented partially - only id or only order is interpreted.

Reimplemented in hds::ZdLdbSeismic, hds::db::ZdSeismic, and ZdUSeismic.

virtual void ZdCoordObjStream::setTertiaryOrder ( int  iTertiaryId,
ZqbOrder  eOrder = Z_O_ASCENT 
)
virtual

Set custom tertiary coordinate and items order. Does not affect iterator methods and and getCoordRange() but changes order of items with the same primary and secondary coordinates. May be not available in derivations. May be implemented partially - only id or only order is interpreted.

Reimplemented in hds::ZdLdbSeismic, hds::db::ZdSeismic, and ZdUSeismic.

virtual void ZdCoordObjStream::setTertiaryOrder ( int  iTertiaryId,
ZqbOrder  eOrder = Z_O_ASCENT 
)
virtual

Set custom tertiary coordinate and items order. Does not affect iterator methods and and getCoordRange() but changes order of items with the same primary and secondary coordinates. May be not available in derivations. May be implemented partially - only id or only order is interpreted.

Reimplemented in hds::ZdLdbSeismic, hds::db::ZdSeismic, and ZdUSeismic.

virtual bool ZdCoordObjStream::visibleCoord ( )
inlinevirtual

Does current coord visible. True by default.

Reimplemented in hds::ZdLdbSeismic.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5