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

#include <zqb_view.hpp>

Inheritance diagram for ZqbView:
ZqbAutoName ZqbAutoName ZqbName ZqbName ZqbName ZqbName ZqView ZqView ZqCoordMarker ZqCoordMarker ZqCurve ZqCurve ZqLithColumn ZqLithColumn ZqScale ZqSeismicTrace ZqSeismicTrace ZqSeismicView ZqSeismicView ZqSurface ZqSurface ZqCoordMarker ZqCoordMarker ZqCurve ZqCurve ZqLithColumn ZqLithColumn ZqScale ZqSeismicTrace ZqSeismicTrace ZqSeismicView ZqSeismicView ZqSurface ZqSurface

Public Member Functions

 ZqbView (const char *szName=NULL)
 
virtual ~ZqbView ()
 
virtual bool compatibleDoc (const ZdDocument *pDoc) const =0
 
virtual void attachDoc (ZdDocument *pData)
 
virtual void detachDoc ()
 
virtual ZdDocument * doc ()
 
virtual void updateView ()
 
virtual void updateDoc ()
 
 ZqbView (const char *szName=NULL)
 
virtual ~ZqbView ()
 
virtual bool compatibleDoc (const ZdDocument *pDoc) const =0
 
virtual void attachDoc (ZdDocument *pData)
 
virtual void detachDoc ()
 
virtual ZdDocument * doc ()
 
virtual void updateView ()
 
virtual void updateDoc ()
 
- 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
 

Static Public Member Functions

static bool findTypeAmong (const ZdDocument *pDoc, const char *szExpectedType1,...)
 
static bool findTypeAmong (const ZdDocument *pDoc, const char *szExpectedType1,...)
 

Additional Inherited Members

- Protected Attributes inherited from ZqbName
char * m_szName
 
char * m_szRoot
 

Detailed Description

Basic class for Document/View framework.

Arbitrary kind of view may be derived from this class.

Constructor & Destructor Documentation

ZqbView::ZqbView ( const char *  szName = NULL)

Create view object. NULL means to generate automatic name.

virtual ZqbView::~ZqbView ( )
virtual

Detach document and destroy the view object.

ZqbView::ZqbView ( const char *  szName = NULL)

Create view object. NULL means to generate automatic name.

virtual ZqbView::~ZqbView ( )
virtual

Detach document and destroy the view object.

Member Function Documentation

virtual void ZqbView::attachDoc ( ZdDocument *  pData)
virtual

Attach document with encapsulated data. NULL pointer passed means to detach document. It's recommended to check document for compatibility with expected type by calling compatibleDoc(). If attached data is not compatible then the view should stay in detached state.

Reimplemented in ZqView, and ZqView.

virtual void ZqbView::attachDoc ( ZdDocument *  pData)
virtual

Attach document with encapsulated data. NULL pointer passed means to detach document. It's recommended to check document for compatibility with expected type by calling compatibleDoc(). If attached data is not compatible then the view should stay in detached state.

Reimplemented in ZqView, and ZqView.

virtual bool ZqbView::compatibleDoc ( const ZdDocument *  pDoc) const
pure virtual

Return true if passed object is in list of compatible documents for this view. Usual implemention is handy to implement using findTypeAmong():

bool Class::compatibleDoc (const ZdDocument* pDoc) const
{
return findTypeAmong(pDoc, "type1", "type2", "type3", NULL);
}

Implemented in ZqScale, ZqLithColumn, ZqLithColumn, ZqSeismicTrace, ZqSeismicTrace, ZqCoordMarker, ZqCoordMarker, ZqSeismicView, ZqSeismicView, ZqSurface, ZqSurface, ZqCurve, ZqCurve, and ZqCustomScale.

virtual bool ZqbView::compatibleDoc ( const ZdDocument *  pDoc) const
pure virtual

Return true if passed object is in list of compatible documents for this view. Usual implemention is handy to implement using findTypeAmong():

bool Class::compatibleDoc (const ZdDocument* pDoc) const
{
return findTypeAmong(pDoc, "type1", "type2", "type3", NULL);
}

Implemented in ZqScale, ZqLithColumn, ZqLithColumn, ZqSeismicTrace, ZqSeismicTrace, ZqCoordMarker, ZqCoordMarker, ZqSeismicView, ZqSeismicView, ZqSurface, ZqSurface, ZqCurve, ZqCurve, and ZqCustomScale.

virtual void ZqbView::detachDoc ( )
virtual

Detach document.

Reimplemented in ZqSeismicTrace, ZqSeismicTrace, ZqLithColumn, ZqLithColumn, ZqCoordMarker, ZqCoordMarker, ZqSeismicView, ZqSeismicView, ZqSurface, ZqSurface, ZqCurve, ZqCurve, ZqCustomScale, ZqView, and ZqView.

virtual void ZqbView::detachDoc ( )
virtual

Detach document.

Reimplemented in ZqSeismicTrace, ZqSeismicTrace, ZqLithColumn, ZqLithColumn, ZqCoordMarker, ZqCoordMarker, ZqSeismicView, ZqSeismicView, ZqSurface, ZqSurface, ZqCurve, ZqCurve, ZqCustomScale, ZqView, and ZqView.

virtual ZdDocument* ZqbView::doc ( )
virtual

Return pointer to attached document or NULL if no document is attached. To provide type-safe casting and avoid ambiguity it's recommended to implement in descendant class a method data():

ZdDataClass* Class::data (const ZqbView* pView) const
{
return (ZqDataClass*)doc();
}
virtual ZdDocument* ZqbView::doc ( )
virtual

Return pointer to attached document or NULL if no document is attached. To provide type-safe casting and avoid ambiguity it's recommended to implement in descendant class a method data():

ZdDataClass* Class::data (const ZqbView* pView) const
{
return (ZqDataClass*)doc();
}
static bool ZqbView::findTypeAmong ( const ZdDocument *  pDoc,
const char *  szExpectedType1,
  ... 
)
static

Special method to compare type of given document object with list of expected (compatible) types. List of expected types should be terminated by NULL. Returns true on success and false otherwise.

static bool ZqbView::findTypeAmong ( const ZdDocument *  pDoc,
const char *  szExpectedType1,
  ... 
)
static

Special method to compare type of given document object with list of expected (compatible) types. List of expected types should be terminated by NULL. Returns true on success and false otherwise.

virtual void ZqbView::updateDoc ( )
virtual

The method to force data change in attached document(s) caused by interactive actions made by user.

virtual void ZqbView::updateDoc ( )
virtual

The method to force data change in attached document(s) caused by interactive actions made by user.

virtual void ZqbView::updateView ( )
virtual

The method to refresh GUI when it seems some data were changed.

Reimplemented in ZqSeismicView, ZqView, and ZqView.

virtual void ZqbView::updateView ( )
virtual

The method to refresh GUI when it seems some data were changed.

Reimplemented in ZqSeismicView, ZqView, and ZqView.

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