UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | Friends | List of all members
ZdDocument Class Reference

#include <zd_document.hpp>

Inheritance diagram for ZdDocument:
ZqbAutoName ZqbAutoName ZqbName ZqbName ZqbName ZqbName ZdCoordObjStream ZdCoordObjStream ZdFunction ZdFunction ZdFunction3D ZdFunction3D ZdCoordObj< T > ZdCoordObj< T > ZdLithData ZdLithData ZdSeismicFile ZdSeismicFile ZqCustomScale::DefCoordObjStream ZdCoordObj< T > ZdCoordObj< T > ZdLithData ZdLithData ZdSeismicFile ZdSeismicFile ZqCustomScale::DefCoordObjStream ZdFVector< T > ZdFVector< T > ZdRealFunc ZdRealFunc ZdTrace ZdTrace ZdFVector< T > ZdFVector< T > ZdRealFunc ZdRealFunc ZdTrace ZdTrace ZdF3DMatrix< T > ZdF3DMatrix< T > ZdF3DSeismic ZdF3DSeismic ZdF3DMatrix< T > ZdF3DMatrix< T > ZdF3DSeismic ZdF3DSeismic

Public Member Functions

 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 ()
 
ZqbNameoperator= (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 ()
 
ZqbNameoperator= (const ZqbName &name)
 
virtual const char * getName () const
 
virtual const char * getType () const
 
bool hasName (const char *szString) const
 

Protected Attributes

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

Friends

class ZqbView
 

Detailed Description

Basic class for Document/View framework.

Arbitrary data containers may be derived from this class.

Constructor & Destructor Documentation

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

Create document object. NULL means to generate automatic name.

virtual ZdDocument::~ZdDocument ( )
virtual

Destroy document object. Calls for ZqbView::detachDoc() for each view.

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

Create document object. NULL means to generate automatic name.

virtual ZdDocument::~ZdDocument ( )
virtual

Destroy document object. Calls for ZqbView::detachDoc() for each view.

Member Function Documentation

virtual bool ZdDocument::compatibleType ( const char *  szType) const
virtual

Return true if given type is compatible with this document, so a programmer can be sure that this document provides interface of given type. Compatibility means that the type is equal to this document type or the type is compatible with superclass of this one. Every subclass of ZdDocument is compatible with "ZdDocument", of course.

Typical implementation for this method in subclass should be:

char* ZdSomeDoc::s_szOwnType = "ZdSomeDoc";
bool ZdSomeDoc::compatibleType (const char* szType) const
{
if(NULL == szType)
return false;
if(!strcmp(szType, s_szOwnType))
return true;
return ZdParentClass::compatibleType(szType);
}

Reimplemented in ZdCoordObj< T >, ZdCoordObj< T >, ZdSeismicSet, ZdSeismicSet, ZdSeismicFile, ZdSeismicFile, ZdLithData, ZdLithData, ZdLithVector, ZdLithVector, ZdF3DSeismic, ZdF3DSeismic, ZdFunction3D, ZdRealFunc, ZdFunction3D, ZdRealFunc, ZdFunction, ZdTrace, ZdFunction, and ZdTrace.

virtual bool ZdDocument::compatibleType ( const char *  szType) const
virtual

Return true if given type is compatible with this document, so a programmer can be sure that this document provides interface of given type. Compatibility means that the type is equal to this document type or the type is compatible with superclass of this one. Every subclass of ZdDocument is compatible with "ZdDocument", of course.

Typical implementation for this method in subclass should be:

char* ZdSomeDoc::s_szOwnType = "ZdSomeDoc";
bool ZdSomeDoc::compatibleType (const char* szType) const
{
if(NULL == szType)
return false;
if(!strcmp(szType, s_szOwnType))
return true;
return ZdParentClass::compatibleType(szType);
}

Reimplemented in ZdCoordObj< T >, ZdCoordObj< T >, ZdSeismicSet, ZdSeismicSet, ZdSeismicFile, ZdSeismicFile, ZdLithData, ZdLithData, ZdLithVector, ZdLithVector, ZdF3DSeismic, ZdF3DSeismic, ZdFunction3D, ZdRealFunc, ZdFunction3D, ZdRealFunc, ZdFunction, ZdTrace, ZdFunction, and ZdTrace.

virtual bool ZdDocument::isChanged ( )
virtual

Return true if the document was changed (comparing its view) and false otherwise.

virtual bool ZdDocument::isChanged ( )
virtual

Return true if the document was changed (comparing its view) and false otherwise.

virtual void ZdDocument::resetChanges ( )
virtual

Set flag of changes to false. It's done automatically after redraw() in objects derived from class ZqView.

virtual void ZdDocument::resetChanges ( )
virtual

Set flag of changes to false. It's done automatically after redraw() in objects derived from class ZqView.

virtual void ZdDocument::setChanges ( )
virtual

Set flag of changes to true. This means that view object (derived from class ZqView) should be redrawn to be synchronous with data stored in this document.

virtual void ZdDocument::setChanges ( )
virtual

Set flag of changes to true. This means that view object (derived from class ZqView) should be redrawn to be synchronous with data stored in this document.

virtual void ZdDocument::updateViews ( )
virtual

The method to refresh GUI of all views to which the document is attached. Usually called when the document is changed. Reset flag of changes at the end.

virtual void ZdDocument::updateViews ( )
virtual

The method to refresh GUI of all views to which the document is attached. Usually called when the document is changed. Reset flag of changes at the end.

Member Data Documentation

ZqbViewVector ZdDocument::m_Views
protected

List of views to which this document is attached.


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