Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

dbObjectHandle Class Template Reference

Db objects: dbObjectHandle. More...

#include <DbHandle.h>

Inheritance diagram for dbObjectHandle:

dbHandleBase DbObjectAccessor dbHandle dbHandle< DbObject > List of all members.

Public Methods

virtual ~dbObjectHandle ()
 Standard destructor. More...

 dbObjectHandle ()
 Constructor with storage type. More...

 dbObjectHandle (unsigned short typ)
 Constructor with storage type. More...

template<classT>  dbObjectHandle<T> (const dbObjectHandle<T>& copy)
 Copy constructor. More...

 dbObjectHandle (const dbObjectHandle<UserClass>& copy)
 Copy constructor. More...

template<classT> dbObjectHandle<UserClass>& operator=<T> (const dbObjectHandle<T>& copy)
 Generic assignment operator. More...

dbObjectHandle<UserClass>& operator= (const dbObjectHandle<UserClass>& copy)
 Generic assignment operator. More...

bool operator== (const dbObjectHandle<DbObject>& copy) const
 Equality operator. More...

long addRef ()
 Add reference count to object. More...

long release ()
 Release object. More...

dbHandle<DbContainer>& containedIn () const
 Retrieve hosting container. More...

DbResult validateAssoc (const dbHandle<DbLink>& lnk,std::string& fname,std::string& cname,std::string& oname)
 Validate an object association. More...

DbResult open (dbHandle<DbContainer>& cntH,const dbHandle<DbLink>& linkH,DbAccessMode mode = DbOOMs::READ)
 Open handle. More...


Protected Methods

void setType (unsigned char type) const
 Set handle type. More...

void setObject (const DbObject* obj)
 Attach object to handle. More...


Private Attributes

friend DbContainer
friend dbHandle<DbObject>
friend dbHandle<DbContainer>

Detailed Description

template<class UserClass> template class dbObjectHandle

Db objects: dbObjectHandle.

Description: Base class for object handles.

Dependencies:

History : 

  +---------+----------------------------------------------+--------+
  |  Date   |       Comment                                | Who    |
  +---------+----------------------------------------------+--------+
  | 21/09/99| Initial version.                             | MF     |
  +---------+----------------------------------------------+--------+
Author: M.Frank Version: 1.0

Definition at line 92 of file DbHandle.h.

Constructor & Destructor Documentation

template<classUserClass>
dbObjectHandle<UserClass>::~dbObjectHandle<UserClass> ( ) [inline, virtual]
 

Standard destructor.

Definition at line 116 of file DbHandle.h.

template<classUserClass>
dbObjectHandle<UserClass>::dbObjectHandle<UserClass> ( ) [inline]
 

Constructor with storage type.

Definition at line 120 of file DbHandle.h.

template<classUserClass>
dbObjectHandle<UserClass>::dbObjectHandle<UserClass> ( unsigned short typ ) [inline]
 

Constructor with storage type.

Definition at line 123 of file DbHandle.h.

template<classUserClass>
template<classT>
dbObjectHandle<UserClass>::dbObjectHandle<UserClass> ( const dbObjectHandle< T >& copy ) [inline]
 

Copy constructor.

Definition at line 127 of file DbHandle.h.

template<classUserClass>
dbObjectHandle<UserClass>::dbObjectHandle<UserClass> ( const dbObjectHandle< UserClass >& copy ) [inline]
 

Copy constructor.

Definition at line 134 of file DbHandle.h.

Member Function Documentation

template<classUserClass>
long dbObjectHandle<UserClass>::addRef ( ) [inline]
 

Add reference count to object.

Definition at line 158 of file DbHandle.h.

Referenced by DbContainer::DbContainer(), and DbDataBase::DbDataBase().

template<classUserClass>
dbHandle< DbContainer >& dbObjectHandle<UserClass>::containedIn ( ) const [inline]
 

Retrieve hosting container.

Definition at line 172 of file DbHandle.h.

Referenced by DbAddress::DbAddress(), DbObject::addAssocEntry(), and DbObjectAccessor::validateAssoc().

template<classUserClass>
DbResult dbObjectHandle<UserClass>::open ( dbHandle< DbContainer >& cntH,
const dbHandle< DbLink >& linkH,
DbAccessMode mode = DbOOMs::READ ) [inline]
 

Open handle.

Definition at line 180 of file DbHandle.h.

Referenced by DbCnvSvc::connectOutput(), DbCnvSvc::createIterator(), DbBaseConverter::createRep(), DbCnvSvc::initialize(), DbCnvSvc::instantiate(), dbHandle< DbDataBase >::open(), DbDirectoryCnv::updateObjRefs(), DbBaseConverter::updateObjRefs(), and DbBaseConverter::updateRep().

template<classUserClass>
dbObjectHandle< UserClass >& dbObjectHandle<UserClass>::operator= ( const dbObjectHandle< UserClass >& copy ) [inline]
 

Generic assignment operator.

Reimplemented in dbHandle.

Definition at line 148 of file DbHandle.h.

template<classUserClass>
template<classT>
dbObjectHandle< UserClass >& dbObjectHandle<UserClass>::operator= ( const dbObjectHandle< T >& copy ) [inline]
 

Generic assignment operator.

Reimplemented in dbHandle, and dbHandle< DbObject >.

Definition at line 141 of file DbHandle.h.

template<classUserClass>
bool dbObjectHandle<UserClass>::operator== ( const dbObjectHandle< DbObject >& copy ) const [inline]
 

Equality operator.

Definition at line 154 of file DbHandle.h.

template<classUserClass>
long dbObjectHandle<UserClass>::release ( ) [inline]
 

Release object.

Definition at line 165 of file DbHandle.h.

Referenced by DbContainer::~DbContainer(), and DbDataBase::~DbDataBase().

template<classUserClass>
void dbObjectHandle<UserClass>::setObject ( const DbObject * obj ) [inline, protected]
 

Attach object to handle.

Definition at line 105 of file DbHandle.h.

Referenced by dbHandle< DbObject >::dbHandle(), dbHandle::dbHandle(), dbObjectHandle(), open(), dbHandle::operator const dbObjectHandle(), dbHandle::operator dbObjectHandle(), dbHandle< DbObject >::operator=(), dbHandle::operator=(), operator=(), dbHandle< DbObject >::~dbHandle(), and ~dbObjectHandle().

template<classUserClass>
void dbObjectHandle<UserClass>::setType ( unsigned char type ) const [inline, protected]
 

Set handle type.

Reimplemented from dbHandleBase.

Definition at line 101 of file DbHandle.h.

Referenced by DbContainer::addEntry(), DbContainer::find(), dbHandle::operator const dbObjectHandle(), dbHandle::operator dbObjectHandle(), dbHandle< DbSession >::operator=(), and DbContainer::updateEntry().

template<classUserClass>
DbResult dbObjectHandle<UserClass>::validateAssoc ( const dbHandle< DbLink >& lnk,
std::string & fname,
std::string & cname,
std::string & oname ) [inline]
 

Validate an object association.

Definition at line 176 of file DbHandle.h.

Member Data Documentation

template<classUserClass>
DbContainer [private]
 

Reimplemented in dbHandle, and dbHandle< DbObject >.

Definition at line 96 of file DbHandle.h.

template<classUserClass>
friend dbObjectHandle<UserClass>::dbHandle<DbContainer> [private]
 

Reimplemented in dbHandle.

Definition at line 98 of file DbHandle.h.

template<classUserClass>
friend dbObjectHandle<UserClass>::dbHandle<DbObject> [private]
 

Reimplemented in dbHandle.

Definition at line 97 of file DbHandle.h.

The documentation for this class was generated from the following file:
Generated at Wed Nov 21 12:22:23 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000